Fix doc blocks
This commit is contained in:
Romain Neutron
parent
c4edbe56ff
commit
0887d9088c
25 changed files with 58 additions and 52 deletions
|
|
@ -74,7 +74,7 @@ class AspectRatio
|
|||
}
|
||||
|
||||
/**
|
||||
* Compute the best width for given height and modulus.
|
||||
* Computes the best width for given height and modulus.
|
||||
*
|
||||
* @param Integer $height
|
||||
* @param Integer $modulus
|
||||
|
|
@ -93,7 +93,7 @@ class AspectRatio
|
|||
}
|
||||
|
||||
/**
|
||||
* Compute the best height for given width and modulus.
|
||||
* Computes the best height for given width and modulus.
|
||||
*
|
||||
* @param Integer $width
|
||||
* @param Integer $modulus
|
||||
|
|
|
|||
|
|
@ -22,10 +22,9 @@ class Dimension
|
|||
private $height;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param integer $width
|
||||
* @param integer $height
|
||||
*
|
||||
* @throws InvalidArgumentException when one of the parameteres is invalid
|
||||
*/
|
||||
public function __construct($width, $height)
|
||||
|
|
@ -39,7 +38,7 @@ class Dimension
|
|||
}
|
||||
|
||||
/**
|
||||
* Return width
|
||||
* Returns width.
|
||||
*
|
||||
* @return width
|
||||
*/
|
||||
|
|
@ -49,7 +48,7 @@ class Dimension
|
|||
}
|
||||
|
||||
/**
|
||||
* Return height
|
||||
* Returns height.
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
|
|
@ -59,7 +58,7 @@ class Dimension
|
|||
}
|
||||
|
||||
/**
|
||||
* Get the ratio
|
||||
* Returns the ratio.
|
||||
*
|
||||
* @param type $forceStandards Whether or not force the use of standards ratios;
|
||||
*
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ namespace FFMpeg\Coordinate;
|
|||
class Point
|
||||
{
|
||||
private $x;
|
||||
private $Y;
|
||||
private $y;
|
||||
|
||||
public function __construct($x, $y)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ class TimeCode
|
|||
}
|
||||
|
||||
/**
|
||||
* Creates timecode from string
|
||||
* Creates timecode from string.
|
||||
*
|
||||
* @param string $timecode
|
||||
*
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ class FFProbeDriver extends AbstractBinary
|
|||
}
|
||||
|
||||
/**
|
||||
* Creates an FFProbeDriver
|
||||
* Creates an FFProbeDriver.
|
||||
*
|
||||
* @param array|ConfigurationInterface $configuration
|
||||
* @param LoggerInterface $logger
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ class FFMpeg
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets ffprobe
|
||||
* Sets FFProbe.
|
||||
*
|
||||
* @param FFProbe
|
||||
*
|
||||
|
|
@ -47,7 +47,7 @@ class FFMpeg
|
|||
}
|
||||
|
||||
/**
|
||||
* Gets FFProbe
|
||||
* Gets FFProbe.
|
||||
*
|
||||
* @return FFProbe
|
||||
*/
|
||||
|
|
@ -57,7 +57,7 @@ class FFMpeg
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets ffmpeg driver
|
||||
* Sets the ffmpeg driver.
|
||||
*
|
||||
* @return FFMpeg
|
||||
*/
|
||||
|
|
@ -69,7 +69,7 @@ class FFMpeg
|
|||
}
|
||||
|
||||
/**
|
||||
* Gets the ffmpeg driver
|
||||
* Gets the ffmpeg driver.
|
||||
*
|
||||
* @return FFMpegDriver
|
||||
*/
|
||||
|
|
@ -79,7 +79,7 @@ class FFMpeg
|
|||
}
|
||||
|
||||
/**
|
||||
* Opens a file in order to be processed
|
||||
* Opens a file in order to be processed.
|
||||
*
|
||||
* @param string $pathfile A pathfile
|
||||
*
|
||||
|
|
@ -105,7 +105,7 @@ class FFMpeg
|
|||
}
|
||||
|
||||
/**
|
||||
* Creates a new FFMpeg instance
|
||||
* Creates a new FFMpeg instance.
|
||||
*
|
||||
* @param array|ConfigurationInterface $configuration
|
||||
* @param LoggerInterface $logger
|
||||
|
|
|
|||
|
|
@ -154,7 +154,7 @@ class FFProbe
|
|||
/**
|
||||
* @api
|
||||
*
|
||||
* Probe the format of a given file
|
||||
* Probes the format of a given file.
|
||||
*
|
||||
* @param string $pathfile
|
||||
*
|
||||
|
|
@ -171,7 +171,7 @@ class FFProbe
|
|||
/**
|
||||
* @api
|
||||
*
|
||||
* Probe the streams contained in a given file
|
||||
* Probes the streams contained in a given file.
|
||||
*
|
||||
* @param string $pathfile
|
||||
*
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ abstract class AbstractData implements \Countable
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns true if data has property
|
||||
* Returns true if data has property.
|
||||
*
|
||||
* @param string $property
|
||||
* @return Boolean
|
||||
|
|
@ -34,7 +34,7 @@ abstract class AbstractData implements \Countable
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the property value given its name
|
||||
* Returns the property value given its name.
|
||||
*
|
||||
* @param string $property
|
||||
* @return mixed
|
||||
|
|
@ -51,7 +51,7 @@ abstract class AbstractData implements \Countable
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns all property names
|
||||
* Returns all property names.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
|
|
@ -61,7 +61,7 @@ abstract class AbstractData implements \Countable
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns all properties and their values
|
||||
* Returns all properties and their values.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ namespace FFMpeg\FFProbe\DataMapping;
|
|||
class Stream extends AbstractData
|
||||
{
|
||||
/**
|
||||
* Returns true if the stream is an audio stream
|
||||
* Returns true if the stream is an audio stream.
|
||||
*
|
||||
* @return Boolean
|
||||
*/
|
||||
|
|
@ -24,7 +24,7 @@ class Stream extends AbstractData
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns true if the stream is a video stream
|
||||
* Returns true if the stream is a video stream.
|
||||
*
|
||||
* @return Boolean
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ class StreamCollection implements \Countable, \IteratorAggregate
|
|||
}
|
||||
|
||||
/**
|
||||
* Adds a stream to the collection
|
||||
* Adds a stream to the collection.
|
||||
*
|
||||
* @param Stream $stream
|
||||
*
|
||||
|
|
@ -48,7 +48,7 @@ class StreamCollection implements \Countable, \IteratorAggregate
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns a new StreamCollection with only video streams
|
||||
* Returns a new StreamCollection with only video streams.
|
||||
*
|
||||
* @return StreamCollection
|
||||
*/
|
||||
|
|
@ -60,7 +60,7 @@ class StreamCollection implements \Countable, \IteratorAggregate
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns a new StreamCollection with only audio streams
|
||||
* Returns a new StreamCollection with only audio streams.
|
||||
*
|
||||
* @return StreamCollection
|
||||
*/
|
||||
|
|
@ -80,7 +80,7 @@ class StreamCollection implements \Countable, \IteratorAggregate
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the array of contained streams
|
||||
* Returns the array of contained streams.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ namespace FFMpeg\FFProbe;
|
|||
interface MapperInterface
|
||||
{
|
||||
/**
|
||||
* Maps data given its type
|
||||
* Maps data given its type.
|
||||
*
|
||||
* @param string $type One of FFProbe::TYPE_* constant
|
||||
* @param string $data The data
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ namespace FFMpeg\FFProbe;
|
|||
interface OptionsTesterInterface
|
||||
{
|
||||
/**
|
||||
* Tells if the given option is supported by ffprobe
|
||||
* Tells if the given option is supported by ffprobe.
|
||||
*
|
||||
* @param string $name
|
||||
*
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ namespace FFMpeg\FFProbe;
|
|||
interface OutputParserInterface
|
||||
{
|
||||
/**
|
||||
* Parses ffprobe raw output
|
||||
* Parses ffprobe raw output.
|
||||
*
|
||||
* @param string $type One of FFProbe::TYPE_* constant
|
||||
* @param string $data The data
|
||||
|
|
|
|||
|
|
@ -14,8 +14,14 @@ namespace FFMpeg\Filters\Video;
|
|||
use FFMpeg\Format\VideoInterface;
|
||||
use FFMpeg\Media\Video;
|
||||
|
||||
/**
|
||||
* Synchronizes audio and video in case of desynchronized movies.
|
||||
*/
|
||||
class SynchronizeFilter implements VideoFilterInterface
|
||||
{
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function apply(Video $video, VideoInterface $format)
|
||||
{
|
||||
$streams = $video->getStreams();
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ class VideoFilters
|
|||
}
|
||||
|
||||
/**
|
||||
* Resizes a video to a given dimension
|
||||
* Resizes a video to a given dimension.
|
||||
*
|
||||
* @param Dimension $dimension
|
||||
* @param string $mode
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ class VideoResampleFilter implements VideoFilterInterface
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the frame rate
|
||||
* Returns the frame rate.
|
||||
*
|
||||
* @return FrameRate
|
||||
*/
|
||||
|
|
@ -37,7 +37,7 @@ class VideoResampleFilter implements VideoFilterInterface
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the GOP size
|
||||
* Returns the GOP size.
|
||||
*
|
||||
* @see https://wikipedia.org/wiki/Group_of_pictures
|
||||
*
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ abstract class DefaultAudio extends EventEmitter implements AudioInterface, Prog
|
|||
|
||||
/**
|
||||
* Sets the audio codec, Should be in the available ones, otherwise an
|
||||
* exception is thrown
|
||||
* exception is thrown.
|
||||
*
|
||||
* @param string $audioCodec
|
||||
*
|
||||
|
|
@ -74,7 +74,7 @@ abstract class DefaultAudio extends EventEmitter implements AudioInterface, Prog
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the kiloBitrate value
|
||||
* Sets the kiloBitrate value.
|
||||
*
|
||||
* @param integer $kiloBitrate
|
||||
* @throws InvalidArgumentException
|
||||
|
|
|
|||
|
|
@ -13,28 +13,28 @@ namespace FFMpeg\Format;
|
|||
interface AudioInterface extends FormatInterface
|
||||
{
|
||||
/**
|
||||
* Get the audio kiloBitrate value
|
||||
* Gets the audio kiloBitrate value.
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getAudioKiloBitrate();
|
||||
|
||||
/**
|
||||
* Return an array of extra parameters to add to ffmpeg commandline
|
||||
* Returns an array of extra parameters to add to ffmpeg commandline.
|
||||
*
|
||||
* @return array()
|
||||
*/
|
||||
public function getExtraParams();
|
||||
|
||||
/**
|
||||
* Returns the audio codec
|
||||
* Returns the audio codec.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getAudioCodec();
|
||||
|
||||
/**
|
||||
* Returns the list of available audio codecs for this format
|
||||
* Returns the list of available audio codecs for this format.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ use FFMpeg\Media\MediaTypeInterface;
|
|||
interface ProgressableInterface extends EventEmitterInterface
|
||||
{
|
||||
/**
|
||||
* Creates the progress listener
|
||||
* Creates the progress listener.
|
||||
*
|
||||
* @param MediaTypeInterface $media
|
||||
* @param FFProbe $ffprobe
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ abstract class DefaultVideo extends DefaultAudio implements VideoInterface
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the kiloBitrate value
|
||||
* Sets the kiloBitrate value.
|
||||
*
|
||||
* @param integer $kiloBitrate
|
||||
* @throws InvalidArgumentException
|
||||
|
|
@ -67,7 +67,7 @@ abstract class DefaultVideo extends DefaultAudio implements VideoInterface
|
|||
|
||||
/**
|
||||
* Sets the video codec, Should be in the available ones, otherwise an
|
||||
* exception is thrown
|
||||
* exception is thrown.
|
||||
*
|
||||
* @param string $videoCodec
|
||||
* @throws InvalidArgumentException
|
||||
|
|
|
|||
|
|
@ -14,14 +14,14 @@ namespace FFMpeg\Format;
|
|||
interface VideoInterface extends AudioInterface
|
||||
{
|
||||
/**
|
||||
* Get the kiloBitrate value
|
||||
* Gets the kiloBitrate value.
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getKiloBitrate();
|
||||
|
||||
/**
|
||||
* Returns the number of passes
|
||||
* Returns the number of passes.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
|
|
@ -40,14 +40,14 @@ interface VideoInterface extends AudioInterface
|
|||
public function getModulus();
|
||||
|
||||
/**
|
||||
* Returns the video codec
|
||||
* Returns the video codec.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getVideoCodec();
|
||||
|
||||
/**
|
||||
* Returns true if the current format supports B-Frames
|
||||
* Returns true if the current format supports B-Frames.
|
||||
*
|
||||
* @see https://wikipedia.org/wiki/Video_compression_picture_types
|
||||
*
|
||||
|
|
@ -56,7 +56,7 @@ interface VideoInterface extends AudioInterface
|
|||
public function supportBFrames();
|
||||
|
||||
/**
|
||||
* Returns the list of available video codecs for this format
|
||||
* Returns the list of available video codecs for this format.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ class Audio extends AbstractStreamableMedia
|
|||
}
|
||||
|
||||
/**
|
||||
* Export the audio in the desired format, applies registered filters
|
||||
* Exports the audio in the desired format, applies registered filters.
|
||||
*
|
||||
* @param FormatInterface $format
|
||||
* @param string $outputPathfile
|
||||
|
|
|
|||
|
|
@ -75,6 +75,7 @@ class Frame extends AbstractMediaType
|
|||
public function saveAs($pathfile, $accurate = false)
|
||||
{
|
||||
/**
|
||||
* might be optimized with http://ffmpeg.org/trac/ffmpeg/wiki/Seeking%20with%20FFmpeg
|
||||
* @see http://ffmpeg.org/ffmpeg.html#Main-options
|
||||
*/
|
||||
if (!$accurate) {
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ namespace FFMpeg\Media;
|
|||
interface MediaTypeInterface
|
||||
{
|
||||
/**
|
||||
* Returns the available filters
|
||||
* Returns the available filters.
|
||||
*/
|
||||
public function filters();
|
||||
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ class Video extends AbstractStreamableMedia
|
|||
}
|
||||
|
||||
/**
|
||||
* Export the video in the desired format, applies registered filters
|
||||
* Exports the video in the desired format, applies registered filters.
|
||||
*
|
||||
* @param FormatInterface $format
|
||||
* @param string $outputPathfile
|
||||
|
|
@ -154,7 +154,7 @@ class Video extends AbstractStreamableMedia
|
|||
}
|
||||
|
||||
/**
|
||||
* Get the frame at timecode
|
||||
* Gets the frame at timecode.
|
||||
*
|
||||
* @param Timecode $at
|
||||
* @return Frame
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue