PHP-FFMpeg API
Index
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A

AspectRatioClass in namespace FFMpeg\Coordinate
AbstractDataClass in namespace FFMpeg\FFProbe\DataMapping
AbstractData::all() — Method in class AbstractData
Returns all properties and their values.
StreamCollection::add() — Method in class StreamCollection
Adds a stream to the collection.
StreamCollection::audios() — Method in class StreamCollection
Returns a new StreamCollection with only audio streams.
StreamCollection::all() — Method in class StreamCollection
Returns the array of contained streams.
AudioFilterInterfaceClass in namespace FFMpeg\Filters\Audio
AudioFilterInterface::apply() — Method in class AudioFilterInterface
Applies the filter on the the Audio media given an format.
AudioFiltersClass in namespace FFMpeg\Filters\Audio
AudioResamplableFilterClass in namespace FFMpeg\Filters\Audio
AudioResamplableFilter::apply() — Method in class AudioResamplableFilter
Applies the filter on the the Audio media given an format.
SimpleFilter::apply() — Method in class SimpleFilter
Applies the filter on the the Audio media given an format.
FiltersCollection::add() — Method in class FiltersCollection
DisplayRatioFixerFilter::apply() — Method in class DisplayRatioFixerFilter
FrameFilterInterface::apply() — Method in class FrameFilterInterface
ClipFilter::apply() — Method in class ClipFilter
Applies the filter on the the Video media given an format.
CustomFilter::apply() — Method in class CustomFilter
Applies the filter on the the Video media given an format.
FrameRateFilter::apply() — Method in class FrameRateFilter
Applies the filter on the the Video media given an format.
ResizeFilter::areStandardsForced() — Method in class ResizeFilter
ResizeFilter::apply() — Method in class ResizeFilter
Applies the filter on the the Video media given an format.
RotateFilter::apply() — Method in class RotateFilter
Applies the filter on the the Video media given an format.
SynchronizeFilter::apply() — Method in class SynchronizeFilter
Applies the filter on the the Video media given an format.
VideoFilterInterface::apply() — Method in class VideoFilterInterface
Applies the filter on the the Video media given an format.
VideoFilters::audioResample() — Method in class VideoFilters
Resamples the audio file.
WatermarkFilter::apply() — Method in class WatermarkFilter
Applies the filter on the the Video media given an format.
AudioInterfaceClass in namespace FFMpeg\Format
AacClass in namespace FFMpeg\Format\Audio
The AAC audio format
AbstractProgressListenerClass in namespace FFMpeg\Format\ProgressListener
AudioProgressListenerClass in namespace FFMpeg\Format\ProgressListener
Parses ffmpeg stderr progress information.
AbstractMediaTypeClass in namespace FFMpeg\Media
AbstractStreamableMediaClass in namespace FFMpeg\Media
AudioClass in namespace FFMpeg\Media
Audio::addFilter() — Method in class Audio
{@inheritdoc}
Frame::addFilter() — Method in class Frame
{@inheritdoc}
Video::addFilter() — Method in class Video
{@inheritdoc}

B

FFMpegServiceProvider::boot() — Method in class FFMpegServiceProvider

C

AspectRatio::calculateWidth() — Method in class AspectRatio
Computes the best width for given height and modulus.
AspectRatio::calculateHeight() — Method in class AspectRatio
Computes the best height for given width and modulus.
AspectRatio::create() — Method in class AspectRatio
Creates a ratio based on Dimension.
FFMpegDriver::create() — Method in class FFMpegDriver
Creates an FFMpegDriver.
FFProbeDriver::create() — Method in class FFProbeDriver
Creates an FFProbeDriver.
FFMpeg::create() — Method in class FFMpeg
Creates a new FFMpeg instance.
FFProbe::create() — Method in class FFProbe
AbstractData::count() — Method in class AbstractData
{@inheritdoc}
StreamCollection::count() — Method in class StreamCollection
{@inheritdoc}
FiltersCollection::count() — Method in class FiltersCollection
{@inheritdoc}
ClipFilterClass in namespace FFMpeg\Filters\Video
CustomFilterClass in namespace FFMpeg\Filters\Video
VideoFilters::clip() — Method in class VideoFilters
Clips (cuts) the video.
DefaultAudio::createProgressListener() — Method in class DefaultAudio
Creates the progress listener.
ProgressableInterface::createProgressListener() — Method in class ProgressableInterface
Creates the progress listener.
DefaultVideo::createProgressListener() — Method in class DefaultVideo
Creates the progress listener.

D

DimensionClass in namespace FFMpeg\Coordinate
Dimension object, used for manipulating width and height couples
DisplayRatioFixerFilterClass in namespace FFMpeg\Filters\Frame
DefaultAudioClass in namespace FFMpeg\Format\Audio
DefaultVideoClass in namespace FFMpeg\Format\Video
The abstract default Video format

E

ExceptionInterfaceClass in namespace FFMpeg\Exception
ExecutableNotFoundExceptionClass in namespace FFMpeg\Exception

F

FrameRateClass in namespace FFMpeg\Coordinate
TimeCode::fromString() — Method in class TimeCode
Creates timecode from string.
TimeCode::fromSeconds() — Method in class TimeCode
Creates timecode from number of seconds.
FFMpegDriverClass in namespace FFMpeg\Driver
FFProbeDriverClass in namespace FFMpeg\Driver
FFMpegClass in namespace FFMpeg
FFMpegServiceProviderClass in namespace FFMpeg
FFProbeClass in namespace FFMpeg
FFProbe::format() — Method in class FFProbe
FormatClass in namespace FFMpeg\FFProbe\DataMapping
StreamCollection::first() — Method in class StreamCollection
Returns the first stream of the collection, null if the collection is empty.
FilterInterfaceClass in namespace FFMpeg\Filters
FiltersCollectionClass in namespace FFMpeg\Filters
FrameFilterInterfaceClass in namespace FFMpeg\Filters\Frame
FrameFiltersClass in namespace FFMpeg\Filters\Frame
FrameFilters::fixDisplayRatio() — Method in class FrameFilters
Fixes the display ratio of the output frame.
FrameRateFilterClass in namespace FFMpeg\Filters\Video
VideoFilters::framerate() — Method in class VideoFilters
Changes the video framerate.
FlacClass in namespace FFMpeg\Format\Audio
The Flac audio format
FormatInterfaceClass in namespace FFMpeg\Format
FrameInterfaceClass in namespace FFMpeg\Format
AbstractProgressListener::forwardedEvents() — Method in class AbstractProgressListener
{@inheritdoc}
Audio::filters() — Method in class Audio
Returns the available filters.
FrameClass in namespace FFMpeg\Media
Frame::filters() — Method in class Frame
Returns the available filters.
MediaTypeInterface::filters() — Method in class MediaTypeInterface
Returns the available filters.
Video::filters() — Method in class Video
Returns the available filters.
Video::frame() — Method in class Video
Gets the frame at timecode.

G

AspectRatio::getValue() — Method in class AspectRatio
Returns the value of the ratio.
Dimension::getWidth() — Method in class Dimension
Returns width.
Dimension::getHeight() — Method in class Dimension
Returns height.
Dimension::getRatio() — Method in class Dimension
Returns the ratio.
FrameRate::getValue() — Method in class FrameRate
Point::getX() — Method in class Point
Point::getY() — Method in class Point
FFMpegDriver::getName() — Method in class FFMpegDriver
{@inheritdoc}
FFProbeDriver::getName() — Method in class FFProbeDriver
{@inheritdoc}
FFMpeg::getFFProbe() — Method in class FFMpeg
Gets FFProbe.
FFMpeg::getFFMpegDriver() — Method in class FFMpeg
Gets the ffmpeg driver.
FFProbe::getParser() — Method in class FFProbe
FFProbe::getFFProbeDriver() — Method in class FFProbe
FFProbe::getOptionsTester() — Method in class FFProbe
FFProbe::getCache() — Method in class FFProbe
FFProbe::getMapper() — Method in class FFProbe
AbstractData::get() — Method in class AbstractData
Returns the property value given its name.
Stream::getDimensions() — Method in class Stream
Returns the dimension of the video stream.
StreamCollection::getIterator() — Method in class StreamCollection
{@inheritdoc}
AudioResamplableFilter::getPriority() — Method in class AudioResamplableFilter
Returns the priority of the filter.
AudioResamplableFilter::getRate() — Method in class AudioResamplableFilter
SimpleFilter::getPriority() — Method in class SimpleFilter
Returns the priority of the filter.
FilterInterface::getPriority() — Method in class FilterInterface
Returns the priority of the filter.
FiltersCollection::getIterator() — Method in class FiltersCollection
{@inheritdoc}
DisplayRatioFixerFilter::getPriority() — Method in class DisplayRatioFixerFilter
Returns the priority of the filter.
ClipFilter::getPriority() — Method in class ClipFilter
Returns the priority of the filter.
ClipFilter::getStart() — Method in class ClipFilter
ClipFilter::getDuration() — Method in class ClipFilter
CustomFilter::getPriority() — Method in class CustomFilter
Returns the priority of the filter.
FrameRateFilter::getPriority() — Method in class FrameRateFilter
Returns the priority of the filter.
FrameRateFilter::getFrameRate() — Method in class FrameRateFilter
Returns the frame rate.
FrameRateFilter::getGOP() — Method in class FrameRateFilter
Returns the GOP size.
ResizeFilter::getPriority() — Method in class ResizeFilter
Returns the priority of the filter.
ResizeFilter::getDimension() — Method in class ResizeFilter
ResizeFilter::getMode() — Method in class ResizeFilter
RotateFilter::getPriority() — Method in class RotateFilter
Returns the priority of the filter.
RotateFilter::getAngle() — Method in class RotateFilter
SynchronizeFilter::getPriority() — Method in class SynchronizeFilter
Returns the priority of the filter.
WatermarkFilter::getPriority() — Method in class WatermarkFilter
Returns the priority of the filter.
AudioInterface::getAudioKiloBitrate() — Method in class AudioInterface
Gets the audio kiloBitrate value.
AudioInterface::getAudioChannels() — Method in class AudioInterface
Gets the audio channels value.
AudioInterface::getAudioCodec() — Method in class AudioInterface
Returns the audio codec.
AudioInterface::getAvailableAudioCodecs() — Method in class AudioInterface
Returns the list of available audio codecs for this format.
Aac::getAvailableAudioCodecs() — Method in class Aac
Returns the list of available audio codecs for this format.
DefaultAudio::getExtraParams() — Method in class DefaultAudio
Returns an array of extra parameters to add to ffmpeg commandline.
DefaultAudio::getAudioCodec() — Method in class DefaultAudio
Returns the audio codec.
DefaultAudio::getAudioKiloBitrate() — Method in class DefaultAudio
Gets the audio kiloBitrate value.
DefaultAudio::getAudioChannels() — Method in class DefaultAudio
Gets the audio channels value.
DefaultAudio::getPasses() — Method in class DefaultAudio
Returns the number of passes.
Flac::getAvailableAudioCodecs() — Method in class Flac
Returns the list of available audio codecs for this format.
Mp3::getAvailableAudioCodecs() — Method in class Mp3
Returns the list of available audio codecs for this format.
Vorbis::getExtraParams() — Method in class Vorbis
Returns an array of extra parameters to add to ffmpeg commandline.
Vorbis::getAvailableAudioCodecs() — Method in class Vorbis
Returns the list of available audio codecs for this format.
Wav::getAvailableAudioCodecs() — Method in class Wav
Returns the list of available audio codecs for this format.
FormatInterface::getPasses() — Method in class FormatInterface
Returns the number of passes.
FormatInterface::getExtraParams() — Method in class FormatInterface
Returns an array of extra parameters to add to ffmpeg commandline.
AbstractProgressListener::getFFProbe() — Method in class AbstractProgressListener
AbstractProgressListener::getPathfile() — Method in class AbstractProgressListener
AbstractProgressListener::getCurrentPass() — Method in class AbstractProgressListener
AbstractProgressListener::getTotalPass() — Method in class AbstractProgressListener
AudioProgressListener::getPattern() — Method in class AudioProgressListener
VideoProgressListener::getPattern() — Method in class VideoProgressListener
VideoInterface::getKiloBitrate() — Method in class VideoInterface
Gets the kiloBitrate value.
VideoInterface::getModulus() — Method in class VideoInterface
Returns the modulus used by the Resizable video.
VideoInterface::getVideoCodec() — Method in class VideoInterface
Returns the video codec.
VideoInterface::getAvailableVideoCodecs() — Method in class VideoInterface
Returns the list of available video codecs for this format.
DefaultVideo::getKiloBitrate() — Method in class DefaultVideo
Gets the kiloBitrate value.
DefaultVideo::getVideoCodec() — Method in class DefaultVideo
Returns the video codec.
DefaultVideo::getModulus() — Method in class DefaultVideo
Ogg::getAvailableAudioCodecs() — Method in class Ogg
Returns the list of available audio codecs for this format.
Ogg::getAvailableVideoCodecs() — Method in class Ogg
Returns the list of available video codecs for this format.
WMV::getAvailableAudioCodecs() — Method in class WMV
Returns the list of available audio codecs for this format.
WMV::getAvailableVideoCodecs() — Method in class WMV
Returns the list of available video codecs for this format.
WMV3::getAvailableAudioCodecs() — Method in class WMV3
Returns the list of available audio codecs for this format.
WMV3::getAvailableVideoCodecs() — Method in class WMV3
Returns the list of available video codecs for this format.
WebM::getExtraParams() — Method in class WebM
Returns an array of extra parameters to add to ffmpeg commandline.
WebM::getAvailableAudioCodecs() — Method in class WebM
Returns the list of available audio codecs for this format.
WebM::getAvailableVideoCodecs() — Method in class WebM
Returns the list of available video codecs for this format.
X264::getAvailableAudioCodecs() — Method in class X264
Returns the list of available audio codecs for this format.
X264::getAvailableVideoCodecs() — Method in class X264
Returns the list of available video codecs for this format.
X264::getPasses() — Method in class X264
Returns the number of passes.
X264::getModulus() — Method in class X264
AbstractMediaType::getFFMpegDriver() — Method in class AbstractMediaType
AbstractMediaType::getFFProbe() — Method in class AbstractMediaType
AbstractMediaType::getPathfile() — Method in class AbstractMediaType
AbstractMediaType::getFiltersCollection() — Method in class AbstractMediaType
AbstractStreamableMedia::getStreams() — Method in class AbstractStreamableMedia
AbstractStreamableMedia::getFormat() — Method in class AbstractStreamableMedia
Frame::getVideo() — Method in class Frame
Returns the video related to the frame.
Frame::getTimeCode() — Method in class Frame
MediaTypeInterface::getPathfile() — Method in class MediaTypeInterface

H

AbstractData::has() — Method in class AbstractData
Returns true if data has property.
OptionsTester::has() — Method in class OptionsTester
Tells if the given option is supported by ffprobe.
OptionsTesterInterface::has() — Method in class OptionsTesterInterface
Tells if the given option is supported by ffprobe.
AbstractProgressListener::handle() — Method in class AbstractProgressListener
{@inheritdoc}

I

InvalidArgumentExceptionClass in namespace FFMpeg\Exception
Stream::isAudio() — Method in class Stream
Returns true if the stream is an audio stream.
Stream::isVideo() — Method in class Stream
Returns true if the stream is a video stream.

K

AbstractData::keys() — Method in class AbstractData
Returns all property names.

L

LogicExceptionClass in namespace FFMpeg\Exception

M

MapperClass in namespace FFMpeg\FFProbe
Mapper::map() — Method in class Mapper
Maps data given its type.
MapperInterfaceClass in namespace FFMpeg\FFProbe
MapperInterface::map() — Method in class MapperInterface
Maps data given its type.
Mp3Class in namespace FFMpeg\Format\Audio
The MP3 audio format
MediaTypeInterfaceClass in namespace FFMpeg\Media

O

FFMpeg::open() — Method in class FFMpeg
Opens a file in order to be processed.
OptionsTesterClass in namespace FFMpeg\FFProbe
OptionsTesterInterfaceClass in namespace FFMpeg\FFProbe
OutputParserClass in namespace FFMpeg\FFProbe
OutputParserInterfaceClass in namespace FFMpeg\FFProbe
OggClass in namespace FFMpeg\Format\Video
The Ogg video format

P

PointClass in namespace FFMpeg\Coordinate
OutputParser::parse() — Method in class OutputParser
Parses ffprobe raw output.
OutputParserInterface::parse() — Method in class OutputParserInterface
Parses ffprobe raw output.
ProgressableInterfaceClass in namespace FFMpeg\Format

R

RuntimeExceptionClass in namespace FFMpeg\Exception
FFMpegServiceProvider::register() — Method in class FFMpegServiceProvider
AudioFilters::resample() — Method in class AudioFilters
Resamples the audio file.
ResizeFilterClass in namespace FFMpeg\Filters\Video
RotateFilterClass in namespace FFMpeg\Filters\Video
VideoFilters::resize() — Method in class VideoFilters
Resizes a video to a given dimension.
VideoFilters::rotate() — Method in class VideoFilters

S

FFMpeg::setFFProbe() — Method in class FFMpeg
Sets FFProbe.
FFMpeg::setFFMpegDriver() — Method in class FFMpeg
Sets the ffmpeg driver.
FFProbe::setParser() — Method in class FFProbe
FFProbe::setFFProbeDriver() — Method in class FFProbe
FFProbe::setOptionsTester() — Method in class FFProbe
FFProbe::setCache() — Method in class FFProbe
FFProbe::setMapper() — Method in class FFProbe
FFProbe::streams() — Method in class FFProbe
AbstractData::set() — Method in class AbstractData
Sets the property value given its name.
StreamClass in namespace FFMpeg\FFProbe\DataMapping
StreamCollectionClass in namespace FFMpeg\FFProbe\DataMapping
SimpleFilterClass in namespace FFMpeg\Filters\Audio
SynchronizeFilterClass in namespace FFMpeg\Filters\Video
Synchronizes audio and video in case of desynchronized movies.
VideoFilters::synchronize() — Method in class VideoFilters
Synchronizes audio and video.
DefaultAudio::setAudioCodec() — Method in class DefaultAudio
Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.
DefaultAudio::setAudioKiloBitrate() — Method in class DefaultAudio
Sets the kiloBitrate value.
DefaultAudio::setAudioChannels() — Method in class DefaultAudio
Sets the channels value.
VideoInterface::supportBFrames() — Method in class VideoInterface
Returns true if the current format supports B-Frames.
DefaultVideo::setKiloBitrate() — Method in class DefaultVideo
Sets the kiloBitrate value.
DefaultVideo::setVideoCodec() — Method in class DefaultVideo
Sets the video codec, Should be in the available ones, otherwise an exception is thrown.
Ogg::supportBFrames() — Method in class Ogg
Returns true if the current format supports B-Frames.
WMV::supportBFrames() — Method in class WMV
Returns true if the current format supports B-Frames.
WMV3::supportBFrames() — Method in class WMV3
Returns true if the current format supports B-Frames.
WebM::supportBFrames() — Method in class WebM
Returns true if the current format supports B-Frames.
X264::supportBFrames() — Method in class X264
Returns true if the current format supports B-Frames.
X264::setBFramesSupport() — Method in class X264
AbstractMediaType::setFFMpegDriver() — Method in class AbstractMediaType
AbstractMediaType::setFFProbe() — Method in class AbstractMediaType
AbstractMediaType::setFiltersCollection() — Method in class AbstractMediaType
Audio::save() — Method in class Audio
Exports the audio in the desired format, applies registered filters.
Frame::save() — Method in class Frame
Saves the frame in the given filename.
Video::save() — Method in class Video
Exports the video in the desired format, applies registered filters.

T

TimeCodeClass in namespace FFMpeg\Coordinate

V

StreamCollection::videos() — Method in class StreamCollection
Returns a new StreamCollection with only video streams.
VideoFilterInterfaceClass in namespace FFMpeg\Filters\Video
VideoFiltersClass in namespace FFMpeg\Filters\Video
VorbisClass in namespace FFMpeg\Format\Audio
The Vorbis audio format
VideoProgressListenerClass in namespace FFMpeg\Format\ProgressListener
Parses ffmpeg stderr progress information for video files.
VideoInterfaceClass in namespace FFMpeg\Format
VideoClass in namespace FFMpeg\Media

W

VideoFilters::watermark() — Method in class VideoFilters
WatermarkFilterClass in namespace FFMpeg\Filters\Video
WavClass in namespace FFMpeg\Format\Audio
The WAV audio format
WMVClass in namespace FFMpeg\Format\Video
The WMV video format
WMV3Class in namespace FFMpeg\Format\Video
The WMV video format
WebMClass in namespace FFMpeg\Format\Video
The WebM video format

X

X264Class in namespace FFMpeg\Format\Video
The X264 video format

_

AspectRatio::__construct() — Method in class AspectRatio
Dimension::__construct() — Method in class Dimension
FrameRate::__construct() — Method in class FrameRate
Point::__construct() — Method in class Point
TimeCode::__construct() — Method in class TimeCode
TimeCode::__toString() — Method in class TimeCode
FFMpeg::__construct() — Method in class FFMpeg
FFProbe::__construct() — Method in class FFProbe
AbstractData::__construct() — Method in class AbstractData
StreamCollection::__construct() — Method in class StreamCollection
OptionsTester::__construct() — Method in class OptionsTester
AudioFilters::__construct() — Method in class AudioFilters
AudioResamplableFilter::__construct() — Method in class AudioResamplableFilter
SimpleFilter::__construct() — Method in class SimpleFilter
DisplayRatioFixerFilter::__construct() — Method in class DisplayRatioFixerFilter
FrameFilters::__construct() — Method in class FrameFilters
ClipFilter::__construct() — Method in class ClipFilter
CustomFilter::__construct() — Method in class CustomFilter
A custom filter, useful if you want to build complex filters
FrameRateFilter::__construct() — Method in class FrameRateFilter
ResizeFilter::__construct() — Method in class ResizeFilter
RotateFilter::__construct() — Method in class RotateFilter
SynchronizeFilter::__construct() — Method in class SynchronizeFilter
VideoFilters::__construct() — Method in class VideoFilters
WatermarkFilter::__construct() — Method in class WatermarkFilter
Aac::__construct() — Method in class Aac
Flac::__construct() — Method in class Flac
Mp3::__construct() — Method in class Mp3
Vorbis::__construct() — Method in class Vorbis
Wav::__construct() — Method in class Wav
AbstractProgressListener::__construct() — Method in class AbstractProgressListener
Ogg::__construct() — Method in class Ogg
WMV::__construct() — Method in class WMV
WMV3::__construct() — Method in class WMV3
WebM::__construct() — Method in class WebM
X264::__construct() — Method in class X264
AbstractMediaType::__construct() — Method in class AbstractMediaType
Frame::__construct() — Method in class Frame