diff --git a/src/PHPVideoToolkit/AnimatedGif.php b/src/PHPVideoToolkit/AnimatedGif.php index 0a7060b..c12be57 100644 --- a/src/PHPVideoToolkit/AnimatedGif.php +++ b/src/PHPVideoToolkit/AnimatedGif.php @@ -52,7 +52,7 @@ class AnimatedGif * @access public * @author Oliver Lillie * @param mixed $gif_path If a gif is given then the string path, otherwise if a gif is to be generated, null. - * @param PHPVideoToolkit\Config $config The PHPVideoToolkit\Config object + * @param Config $config The PHPVideoToolkit\Config object * @throws \RuntimeException If the gif path is set but doesn't exist. * @throws \RuntimeException If the gif is not readable. * @throws \InvalidArgumentException If the image supplied is not an image. @@ -171,8 +171,8 @@ public function __call($name, $arguments) * @param array $image_object_array An array of PHPVideoToolkit\Image objects to use to create the animated gif. * @param mixed $frame_delay An integer or float value to determine the delay between gif frames. * @param integer $loop_count The number of times the animated gif should loop. Specify -1 for an endless loop. - * @param PHPVideoToolkit\Config $config The PHPVideoToolkit\Config object. - * @return PHPVideoToolkit\AnimatedGif Returns a PHPVideoToolkit\AnimatedGif object. + * @param Config $config The PHPVideoToolkit\Config object. + * @return AnimatedGif Returns a PHPVideoToolkit\AnimatedGif object. * @throws \InvalidArgumentException If the $image_object_array is empty. * @throws \InvalidArgumentException If the $frame_delay is less than 0 or not an integer or float. * @throws \InvalidArgumentException If any of the values within $image_object_array is not an instance of PHPVideoToolkit\Image. diff --git a/src/PHPVideoToolkit/AnimatedGifTranscoderConvert.php b/src/PHPVideoToolkit/AnimatedGifTranscoderConvert.php index 28adc68..a191cb4 100644 --- a/src/PHPVideoToolkit/AnimatedGifTranscoderConvert.php +++ b/src/PHPVideoToolkit/AnimatedGifTranscoderConvert.php @@ -27,8 +27,8 @@ class AnimatedGifTranscoderConvert extends AnimatedGifTranscoderAbstract * @access public * @author Oliver Lillie * @param string $save_path The path to save the animated gif to. - * @return PHPVideoToolkit\Image Returns a new instance of PHPVideoToolkit\Image with the new animated gif as the src. - * @throws PHPVideoToolkit\AnimatedGifException If the convert process encounters an error. + * @return Image Returns a new instance of PHPVideoToolkit\Image with the new animated gif as the src. + * @throws AnimatedGifException If the convert process encounters an error. */ public function save($save_path) { @@ -85,7 +85,7 @@ public function save($save_path) * @access public * @static * @author Oliver Lillie - * @param PHPVideoToolkit\Config $config The configuration object. + * @param Config $config The configuration object. * @return boolean Returns true if this engine can be used, otherwise false. */ public static function available(Config $config) diff --git a/src/PHPVideoToolkit/AnimatedGifTranscoderGifsicle.php b/src/PHPVideoToolkit/AnimatedGifTranscoderGifsicle.php index 7370c31..fa37b62 100644 --- a/src/PHPVideoToolkit/AnimatedGifTranscoderGifsicle.php +++ b/src/PHPVideoToolkit/AnimatedGifTranscoderGifsicle.php @@ -32,7 +32,7 @@ class AnimatedGifTranscoderGifsicle extends AnimatedGifTranscoderAbstract * * @access public * @author Oliver Lillie - * @param PHPVideoToolkit\Config $config The PHPVideoToolit\Config object. + * @param Config $config The PHPVideoToolit\Config object. */ public function __construct(Config $config=null) { @@ -65,8 +65,8 @@ public function __destruct() * * @access public * @author Oliver Lillie - * @param PHPVideoToolkit\Image $image The image source that you wish to add as a frame to the gif. - * @return PHPVideoToolkit\AnimatedGifTranscoderGifsicle Returns the current object. + * @param Image $image The image source that you wish to add as a frame to the gif. + * @return AnimatedGifTranscoderGifsicle Returns the current object. */ public function addFrame(Image $image) { @@ -87,13 +87,13 @@ public function addFrame(Image $image) * @author Oliver Lillie * @param string $frame_path The file paht of the image to convert. * @return string Returns the new file path if the image was converted, otherwise returns the old file path. - * @throws PHPVideoToolkit\AnimatedGifException If imagemagick convert is user but encounters an error. + * @throws AnimatedGifException If imagemagick convert is user but encounters an error. * @throws \RuntimeException If PHP GD is used and imagegif is not available on the current system. - * @throws PHPVideoToolkit\AnimatedGifException If the image given to convert is not supported by PHP GD. - * @throws PHPVideoToolkit\AnimatedGifException If the image fails to convert to a gif using PHP GD. - * @throws PHPVideoToolkit\AnimatedGifException If the image fails to convert. - * @throws PHPVideoToolkit\AnimatedGifException If the image fails to convert but a path was generated. - * @throws PHPVideoToolkit\AnimatedGifException If the image fails to convert but a file was generated by 0 bytes in size. + * @throws AnimatedGifException If the image given to convert is not supported by PHP GD. + * @throws AnimatedGifException If the image fails to convert to a gif using PHP GD. + * @throws AnimatedGifException If the image fails to convert. + * @throws AnimatedGifException If the image fails to convert but a path was generated. + * @throws AnimatedGifException If the image fails to convert but a file was generated by 0 bytes in size. */ protected function _convertFrameToGif($frame_path) { @@ -195,8 +195,8 @@ protected function _convertFrameToGif($frame_path) * @access public * @author Oliver Lillie * @param string $save_path The path to save the animated gif to. - * @return PHPVideoToolkit\Image Returns a new instance of PHPVideoToolkit\Image with the new animated gif as the src. - * @throws PHPVideoToolkit\AnimatedGifException If the convert process encounters an error. + * @return Image Returns a new instance of PHPVideoToolkit\Image with the new animated gif as the src. + * @throws AnimatedGifException If the convert process encounters an error. */ public function save($save_path) { @@ -250,7 +250,7 @@ public function save($save_path) * @access public * @static * @author Oliver Lillie - * @param PHPVideoToolkit\Config $config The configuration object. + * @param Config $config The configuration object. * @return boolean Returns true if this engine can be used, otherwise false. */ public static function available(Config $config) diff --git a/src/PHPVideoToolkit/AudioFormat/Wav.php b/src/PHPVideoToolkit/AudioFormat/Wav.php index 8e975a6..af67386 100644 --- a/src/PHPVideoToolkit/AudioFormat/Wav.php +++ b/src/PHPVideoToolkit/AudioFormat/Wav.php @@ -27,7 +27,7 @@ class AudioFormat_Wav extends AudioFormat * @author Oliver Lillie * @param constant $input_output_type Determines the input/output type of the Format. Either PHPVideoToolkit\Format::INPUT * or PHPVideoToolkit\Format::OUTPUT - * @param PHPVideoToolkit\Config $config The config object. + * @param Config $config The config object. */ public function __construct($input_output_type=Format::OUTPUT, Config $config=null) { diff --git a/src/PHPVideoToolkit/Binary.php b/src/PHPVideoToolkit/Binary.php index b517e61..6f11ebf 100644 --- a/src/PHPVideoToolkit/Binary.php +++ b/src/PHPVideoToolkit/Binary.php @@ -33,7 +33,7 @@ class Binary * @author Stig Bakken * @author Oliver Lillie * @throws \RuntimeException If it's not possible to guess the enviroment paths. - * @throws PHPVideoToolkit\BinaryLocateException If it is not possible to locate the specific programme. + * @throws BinaryLocateException If it is not possible to locate the specific programme. */ public static function locate($program, $fallback=null) { diff --git a/src/PHPVideoToolkit/ExecBuffer.php b/src/PHPVideoToolkit/ExecBuffer.php index 9746e45..de1389e 100644 --- a/src/PHPVideoToolkit/ExecBuffer.php +++ b/src/PHPVideoToolkit/ExecBuffer.php @@ -237,7 +237,7 @@ public function __construct($exec_command_string, $temp_directory=null, $php_exe * @access public * @author Oliver Lillie * @param string $temp_directory The file path to the temp directory to use. - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. * @throws \InvalidArgumentException If the temp directory path is not a directory. * @throws \InvalidArgumentException If the temp directory path is not readable. * @throws \InvalidArgumentException If the temp directory path is not writable. @@ -272,7 +272,7 @@ public function setTempDirectory($temp_directory=null) * @access public * @author Oliver Lillie * @param boolean $gc True determines that the temp files are garbage collected. False means they are not. - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. * @throws \InvalidArgumentException If the $gc value is not a boolean. */ public function setGarbageCollection($gc) @@ -314,7 +314,7 @@ public function __destruct() * @author Oliver Lillie * @param mixed $callback A function if provided is called when the exec() call is completed. Otherwise null. * It should be noted that if a callback is supplied the resulting call to exec() is made blocking. - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. * @throws \InvalidArgumentException If a callback is supplied but not callable. */ public function execute($callback=null) @@ -412,7 +412,7 @@ protected function _callCompletionCallbacks() * @access public * @author Oliver Lillie * @param mixed $callback A callable callback function. - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. * @throws \InvalidArgumentException If a callback is supplied but not callable. */ public function registerCompletionCallback($callback) @@ -501,7 +501,7 @@ protected function _run($callback) * * @access public * @author Oliver Lillie - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. */ public function wait($seconds=1) { @@ -514,7 +514,7 @@ public function wait($seconds=1) * * @access public * @author Oliver Lillie - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. */ public function stop() { @@ -826,7 +826,7 @@ public function getCommand() * @access public * @author Oliver Lillie * @param boolean $enable_failure_tracking True means that failure tracking is enabled, false turns it off. - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. */ public function setFailureTracking($enable_failure_tracking) { @@ -857,7 +857,7 @@ public function getFailureTracking() * @access public * @author Oliver Lillie * @param integer $callback_period_interval - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. * @throws \InvalidArgumentException If the callback period interval is not an integer. */ public function setCallbackWaitInterval($callback_period_interval) @@ -889,7 +889,7 @@ public function getCallbackWaitInterval() * @access public * @author Oliver Lillie * @param boolean $enable_blocking If true the exec() call is made blocking, false means it is non-blocking. - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. * @throws \InvalidArgumentException If the blocking value is not a boolean. */ public function setBlocking($enable_blocking) @@ -934,7 +934,7 @@ public function getBoundary() * @author Oliver Lillie * @param mixed $buffer_output Can be one of the following constants. ExecBuffer::DEV_NULL, ExecBuffer::TEMP, * a string will be interpretted as a file or null will output everything to sdout. - * @return PHPVideoToolkit\ExecBuffer Returns the current object. + * @return ExecBuffer Returns the current object. * @throws \InvalidArgumentException If the buffer output value is not null, ExecBuffer::DEV_NULL or ExecBuffer::TEMP * and the directory path supplied is not a directory. * @throws \InvalidArgumentException If the buffer output value is not null, ExecBuffer::DEV_NULL or ExecBuffer::TEMP diff --git a/src/PHPVideoToolkit/FfmpegParser.php b/src/PHPVideoToolkit/FfmpegParser.php index 8dcd6ba..a8f8bd8 100644 --- a/src/PHPVideoToolkit/FfmpegParser.php +++ b/src/PHPVideoToolkit/FfmpegParser.php @@ -29,7 +29,7 @@ class FfmpegParser * * @access public * @author: Oliver Lillie - * @param PHPVideoToolkit\Config $config The config object. + * @param Config $config The config object. */ public function __construct(Config $config=null) { diff --git a/src/PHPVideoToolkit/FfmpegParserGeneric.php b/src/PHPVideoToolkit/FfmpegParserGeneric.php index 1f6652b..bc6282d 100644 --- a/src/PHPVideoToolkit/FfmpegParserGeneric.php +++ b/src/PHPVideoToolkit/FfmpegParserGeneric.php @@ -61,7 +61,7 @@ public function getRawCodecData($read_from_cache=true) * @param boolean $read_from_cache If true and the data exists within a cache then that data is used. If false * then the data is re-read from ffmpeg. * @return string Returns the raw buffer data from ffmpeg. - * @throws PHPVideoToolkit\FfmpegProcessException If the call to ffmpeg encounters an error. + * @throws FfmpegProcessException If the call to ffmpeg encounters an error. */ public function getRawFiltersData($read_from_cache=true) { @@ -94,7 +94,7 @@ public function getRawFiltersData($read_from_cache=true) * @param boolean $read_from_cache If true and the data exists within a cache then that data is used. If false * then the data is re-read from ffmpeg. * @return string Returns the raw buffer data from ffmpeg. - * @throws PHPVideoToolkit\FfmpegProcessException If the call to ffmpeg encounters an error. + * @throws FfmpegProcessException If the call to ffmpeg encounters an error. */ public function getRawBitstreamFiltersData($read_from_cache=true) { @@ -127,7 +127,7 @@ public function getRawBitstreamFiltersData($read_from_cache=true) * @param boolean $read_from_cache If true and the data exists within a cache then that data is used. If false * then the data is re-read from ffmpeg. * @return string Returns the raw buffer data from ffmpeg. - * @throws PHPVideoToolkit\FfmpegProcessException If the call to ffmpeg encounters an error. + * @throws FfmpegProcessException If the call to ffmpeg encounters an error. */ public function getRawProtocolsData($read_from_cache=true) { diff --git a/src/PHPVideoToolkit/FfmpegProcess.php b/src/PHPVideoToolkit/FfmpegProcess.php index 2027e47..38eb2cc 100644 --- a/src/PHPVideoToolkit/FfmpegProcess.php +++ b/src/PHPVideoToolkit/FfmpegProcess.php @@ -23,7 +23,7 @@ class FfmpegProcess extends ProcessBuilder /** * Variable placeholder for containing the ExecBuffer object. * @access protected - * @var PHPVideoToolkit\ExecBuffer + * @var ExecBuffer */ protected $_exec; @@ -72,7 +72,7 @@ class FfmpegProcess extends ProcessBuilder /** * Variable placeholder for the progress handler, if any, that is attached to the process. * @access protected - * @var PHPVideoToolkit\ProgressHandlerAbstract + * @var ProgressHandlerAbstract */ protected $_progress_handler; @@ -91,7 +91,7 @@ class FfmpegProcess extends ProcessBuilder * @author Oliver Lillie * @param string $program The programme to call. Note this is not the path. If you wish to call ffmpeg/aconv you should jsut * supply 'ffmpeg' and then set the aconv path as the ffmpeg configuration option in Config. - * @param PHPVideoToolkit\Config $config The config object. + * @param Config $config The config object. */ public function __construct($program, Config $config=null) { @@ -114,7 +114,7 @@ public function __construct($program, Config $config=null) * @access public * @author Oliver Lillie * @param integer $index The index integer to set the output index to. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. * @throws \InvalidArgumentException If the $index is not an integer. */ public function setOutputIndex($index) @@ -138,7 +138,7 @@ public function setOutputIndex($index) * @param integer $index The index to which the input is being added. If null then the input is just appended to the * list of input media. If a positive index then it is set at the given index, it will overwrite anything already in that * position. If -1 then the input is shifted onto the beinging of the input array. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. * @throws \InvalidArgumentException If the input path does not exist. * @throws \InvalidArgumentException If the $index is not an integer. */ @@ -224,7 +224,7 @@ public function getAllOutput() * @access public * @author Oliver Lillie * @param string $output The path to where the output media is to be saved to from ffmpeg. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. */ public function setOutputPath($output) { @@ -292,7 +292,7 @@ public function getOutputPath($index=null) * @param mixed $argument Any optional arguments to add. If none, false should be given. * @param boolean $allow_command_repetition If this command can only be added once then set this to true to prevent * it from being added again. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. */ public function addPreInputCommand($command, $argument=false, $allow_command_repetition=false) { @@ -311,7 +311,7 @@ public function addPreInputCommand($command, $argument=false, $allow_command_rep * @param mixed $argument Any optional arguments to add. If none, false should be given. * @param boolean $allow_command_repetition If this command can only be added once then set this to true to prevent * it from being added again. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. */ public function addCommand($command, $argument=false, $allow_command_repetition=false) { @@ -334,7 +334,7 @@ public function addCommand($command, $argument=false, $allow_command_repetition= * @param mixed $argument Any optional arguments to add. If none, false should be given. * @param boolean $allow_command_repetition If this command can only be added once then set this to true to prevent * it from being added again. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. */ public function addPostOutputCommand($command, $argument=false, $allow_command_repetition=false) { @@ -349,7 +349,7 @@ public function addPostOutputCommand($command, $argument=false, $allow_command_r * @author: Oliver Lillie * @param string $command The command to add. * @param mixed $argument Any optional arguments to add. If none, false should be given. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. */ public function removePreInputCommand($command, $argument=false) { @@ -364,7 +364,7 @@ public function removePreInputCommand($command, $argument=false) * @author: Oliver Lillie * @param string $command The command to add. * @param mixed $argument Any optional arguments to add. If none, false should be given. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. */ public function removeCommand($command, $argument=false) { @@ -379,7 +379,7 @@ public function removeCommand($command, $argument=false) * @author: Oliver Lillie * @param string $command The command to add. * @param mixed $argument Any optional arguments to add. If none, false should be given. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. */ public function removePostOutputCommand($command, $argument=false) { diff --git a/src/PHPVideoToolkit/FfmpegProcessProgressable.php b/src/PHPVideoToolkit/FfmpegProcessProgressable.php index cbb629e..f219a46 100644 --- a/src/PHPVideoToolkit/FfmpegProcessProgressable.php +++ b/src/PHPVideoToolkit/FfmpegProcessProgressable.php @@ -49,7 +49,7 @@ class FfmpegProcessProgressable extends FfmpegProcess * @author: Oliver Lillie * @param string $program The programme to call. Note this is not the path. If you wish to call ffmpeg/aconv you should jsut * supply 'ffmpeg' and then set the aconv path as the ffmpeg configuration option in Config. - * @param PHPVideoToolkit\Config $config The config object. + * @param Config $config The config object. */ public function __construct($programme, Config $config=null) { @@ -66,8 +66,8 @@ public function __construct($programme, Config $config=null) * @access public * @author Oliver Lillie * @param integer $timelimit_in_seconds The timelimit to impose in seconds. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. - * @throws PHPVideoToolkit\FfmpegProcessCommandUnavailableException If the timelimit command is not available on the configured ffmpeg. + * @return FfmpegProcess Returns the current object. + * @throws FfmpegProcessCommandUnavailableException If the timelimit command is not available on the configured ffmpeg. * @throws \InvalidArgumentException If the timelimit is not an integer. * @throws \InvalidArgumentException If the timelimit is less than or equal to 0. */ @@ -102,7 +102,7 @@ public function setProcessTimelimit($timelimit_in_seconds) * @access public * @author Oliver Lillie * @param mixed $callback Can be a callable callback, or an object that extends PHPVideoToolkit\ProgressHandlerAbstract - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. * @throws \InvalidArgumentException If the callback is an object and is not a subclass of PHPVideoToolkit\ProgressHandlerAbstract * @throws \InvalidArgumentException If the callback is not callable if not an object. */ @@ -158,7 +158,7 @@ public function _executionCallbackRunner() * @access public * @author Oliver Lillie * @param mixed $callback If given it must be a valid function that is callable. - * @return PHPVideoToolkit\FfmpegProcess Returns the current object. + * @return FfmpegProcess Returns the current object. * @throws \InvalidArgumentException If the callback is not callable. */ public function execute($callback=null) diff --git a/src/PHPVideoToolkit/Format.php b/src/PHPVideoToolkit/Format.php index 4d23157..3632e6a 100644 --- a/src/PHPVideoToolkit/Format.php +++ b/src/PHPVideoToolkit/Format.php @@ -95,7 +95,7 @@ class Format extends FfmpegParser * @author: Oliver Lillie * @param constant $input_output_type Either Format::INPUT or Format::OUTPUT. Defaults to OUTPUT. It determines the format * mode used to set various commands in the final ffmpeg exec call. - * @param PHPVideoToolkit\Config $config The config object. + * @param Config $config The config object. * @throws \InvalidArgumentException If the $input_output_type is not valid. */ public function __construct($input_output_type=Format::OUTPUT, Config $config=null) @@ -161,7 +161,7 @@ public function __construct($input_output_type=Format::OUTPUT, Config $config=nu } } - + /** * Gets a default format for the related path. * If a default format is not found then the fallback_format_class is used. @@ -169,16 +169,17 @@ public function __construct($input_output_type=Format::OUTPUT, Config $config=nu * @access public * @static * @author Oliver Lillie - * @param string $path The file path to get the format for. - * @param PHPVideoToolkit\Config $config The config object. - * @param string $fallback_format_class The fallback class to use of the format for the given path cannot be automatically determined. + * @param string $path The file path to get the format for. + * @param Config $config The config object. + * @param string $fallback_format_class The fallback class to use of the format for the given path cannot be automatically determined. * If null is given then a RuntimeException is thrown. - * @param constant $input_output_type Either Format::INPUT or Format::OUTPUT. Defaults to OUTPUT. It determines the format + * @param string $type + * @return Format Returns an object extended from the PHPVideToolkit\Format class. + * @throws \LogicException + * @throws \RuntimeException + * @throws \InvalidArgumentException + * @internal param constant $input_output_type Either Format::INPUT or Format::OUTPUT. Defaults to OUTPUT. It determines the format * mode used to set various commands in the final ffmpeg exec call. - * @return PHPVideToolkit\Format Returns an object extended from the PHPVideToolkit\Format class. - * @throws \InvalidArgumentException If the $input_output_type is not valid. - * @throws \InvalidArgumentException If the specified fallback class is attempted to be used but is not found. - * @throws \LogicException If the generated class does not extend from PHPVideToolkit\Format. */ public static function getFormatFor($path, $config, $fallback_format_class='Format', $type=Format::OUTPUT) { @@ -261,8 +262,8 @@ public function getFormatOptions() * * @access public * @author Oliver Lillie - * @param PHPVideoToolkit\Media $media - * @return PHPVideoToolkit\Format Returns the current object. + * @param Media $media + * @return Format Returns the current object. */ public function setMedia(Media $media) { @@ -296,7 +297,7 @@ protected function _blockSetOnInputFormat($setting_name) * * @access public * @author Oliver Lillie - * @return PHPVideoToolkit\Format Returns the current object. + * @return Format Returns the current object. * @throws \LogicException If the media object has not yet been set into the current format object. */ public function updateFormatOptions(&$save_path, $overwrite) @@ -536,7 +537,7 @@ public function addCommand($option, $arg) * @author Oliver Lillie * @param constant $type Either Format::INPUT or Format::OUTPUT. Defaults to OUTPUT. It determines the format * mode used to set various commands in the final ffmpeg exec call. - * @return PHPVideoToolkit\Format Returns the current object. + * @return Format Returns the current object. * @throws \InvalidArgumentException If the type is not a valid type. */ public function setType($type) @@ -560,7 +561,7 @@ public function setType($type) * @author Oliver Lillie * @link http://ffmpeg.org/ffmpeg.html#toc-Preset-files * @param string $preset_file_path - * @return PHPVideoToolkit\Format Returns the current object. + * @return Format Returns the current object. * @throws \InvalidArgumentException of the file does not exist. * @throws \InvalidArgumentException of the file is not readable. */ @@ -595,7 +596,7 @@ public function setPresetOptionsFile($preset_file_path) * @author Oliver Lillie * @param constant $strictness One of the following values. Format::STRICTNESS_VERY, Format::STRICTNESS_STRICT, * Format::STRICTNESS_NORMAL, Format::STRICTNESS_UNOFFICIAL, Format::STRICTNESS_EXPERIMENTAL - * @return PHPVideoToolkit\Format Returns the current object. + * @return Format Returns the current object. * @throws \InvalidArgumentException If an unrecognised strictness value is returned. */ public function setStrictness($strictness) @@ -621,7 +622,7 @@ public function setStrictness($strictness) * @access public * @author Oliver Lillie * @param string $format One of the values returned from FfmpegParser::getFormats. - * @return PHPVideoToolkit\Format Returns the current object. + * @return Format Returns the current object. * @throws \InvalidArgumentException If the format requested is "segment". This is a special ffmpeg format to split a file, however PHPVideoToolkit * has a special function to segment files. * @throws \InvalidArgumentException If an unregognised format is given. @@ -662,7 +663,7 @@ public function setFormat($format) * @param integer $stream_index Between 0-48. If specified then the threads option is given a stream specifier to * specify a particular audiovideo stream, i.e. -threads:1 4. If a previous setThreads has been called without specifiying * a stream_index, then the - * @return PHPVideoToolkit\Format Returns the current object. + * @return Format Returns the current object. * @throws \InvalidArgumentException If the threads value is not an integer. * @throws \InvalidArgumentException If the threads value is not between 1-64. */ @@ -716,7 +717,7 @@ public function setThreads($threads, $stream_index=null) * @author Oliver Lillie * @see http://www.kilobitspersecond.com/2007/05/24/ffmpeg-quality-comparison/ * @param integer $qscale Between 1-31 - * @return PHPVideoToolkit\Format Returns the current object. + * @return Format Returns the current object. * @throws \InvalidArgumentException If the qscale value is not an integer. * @throws \InvalidArgumentException If the qscale value is not between 1-64. */