Eef Plugins

Reclocker

Class: Adapter
Type: Reclocker
Implementation: eef
Version:
Doc: The reclocker transforms the input sample time limits in order to produce a contiguous sequence. That is, their duration are kept as this, but their start time is modified in order for a sample to always start when the previous one ends.
Input:
Name Type Default value Description
InitialTime eef_MediaTimeCode None Reclocks all the samples at this given time

Throttler

Class: Adapter
Type: Throttler
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
ClockRate eef_EditRate None Expected tick rate (per second). If undefined, throttler is in pass-through mode.

TimeAdapter

Class: Adapter
Type: TimeAdapter
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
InputTimePointId eef_UTF8String None Input TimePoint Id
OutputTimePointId eef_UTF8String None Output TimePoint Id

dummy

Class: Adapter
Type: dummy
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

Aligned

Class: Allocator
Type: Aligned
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

NotOwner

Class: Allocator
Type: NotOwner
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
BufferAddress eef_Uint64 0 None
BufferSize eef_Uint64 0 None

Recycler

Class: Allocator
Type: Recycler
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
test eef_Bool False None

audio.aac

Class: AudioAnalyser
Type: audio.aac
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

audio.alaw

Class: AudioAnalyser
Type: audio.alaw
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

audio.pcm

Class: AudioAnalyser
Type: audio.pcm
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

AudioCutter

Class: AudioConverter
Type: AudioCutter
Implementation: eef
Version:
Doc: Concatenate or split input audio samples to match configured audio pattern
Input:
Name Type Default value Description
MaxBufferSize eef_Uint64 150 None
pattern eef_UTF8String Audio cutting pattern (i.e.: '1602;1602;1601;1602;1601') None

FloatToPCMConverter

Class: AudioConverter
Type: FloatToPCMConverter
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
Endianness eef_EndiannessType little_endian None
BitDepth eef_Uint32 24 None
NumChannels eef_Uint32 1 None
SampleSize eef_Uint32 3 None

audio.pcm

Class: AudioConverter
Type: audio.pcm
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

audio.aac

Class: AudioDecoder
Type: audio.aac
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

audio.alaw

Class: AudioDecoder
Type: audio.alaw
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

AudioMatrixFilter

Class: AudioEffect
Type: AudioMatrixFilter
Implementation: eef
Version:
Doc: This filter will reorder/mute audio channels. Limitations: - AudioPCM only - 1ch audiobuffer only (mono) - Input and Output single audio track only
Input:
Name Type Default value Description
Allocator eef_UTF8String None None
ChannelsOut eef_UTF8String None Defines Output Channels Matricing. [-1 -> Mute channel / x -> Input Channel x]. ex: -1 -1 0 1 -> Channels 0/1 will output on channels 2/3.

audio.aac

Class: AudioEncoder
Type: audio.aac
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
BitRate eef_Uint64 96000 None
BitsPerSample eef_Uint64 24 None
NumberOfChannelsPerPacket eef_Uint64 2 None

AudioOscillator

Class: AudioGenerator
Type: AudioOscillator
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
NumberOfChannels eef_Uint64 1 Number of output audio channels
SamplingFrequency eef_Uint64 48000 None
DurationSeconds eef_Double 10.000000 None
Frequency eef_Double 1000.000000 None
Gain eef_Double 0.900000 None
PhaseRadian eef_Double 0.000000 None
Allocator eef_UTF8String None None
NumSamplesInBuffer eef_UTF8String 2048 None
type eef_UTF8String sine None
Allowed: ['sine', 'square', 'triangle', 'sawtooth']

LocalEngine

Class: Engine
Type: LocalEngine
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
Multithread eef_Bool True None

OpenCVVideoViewer

Class: LiveVideoSink
Type: OpenCVVideoViewer
Implementation: eef
Version:
Doc: Simple sink for image visualization based on opencv.
Input:
Name Type Default value Description
DisplayMode eef_UTF8String Normal None
Allowed: ['FullScreen', 'AutoScale', 'Normal']
PlayoutMode eef_UTF8String NoDelay None
Allowed: ['NoDelay', 'RealTime', 'Paused']

logger

Class: Logger
Type: logger
Implementation: eef.BasicLogger
Version:
Doc: None
Input:
Name Type Default value Description
path eef_UTF8String eefWorkflow.log None

VideoComparator

Class: Monitor
Type: VideoComparator
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
OutputEndpointRef eef_UTF8String None None
callBackBufferAllocatorRef eef_UTF8String None None

Preload

Class: Preload
Type: Preload
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
FillAtStartUp eef_Bool True If set to true, preload buffer will be filled before workflow starts.
RelativeCuePointWindowSecondsAfter eef_Double 0.000000 Define the right side preload window around cue point
RelativeCuePointWindowSecondsBefore eef_Double 0.000000 Define the left side preload window around cue point
RelativeCurrentWindowSecondsAfter eef_Double 1.500000 Define the right side preload window around current position
RelativeCurrentWindowSecondsBefore eef_Double 0.000000 Define the left side preload window around current position
MaxHistory eef_Uint32 500 Remember the list of N last requests
MaxMemSizeMB eef_Uint32 500 Max total memory consumption in preload buffers
RunQueueSize eef_Uint32 5 prediction of N=RunQueueSize next requests

Class: Sink
Type:
Implementation: eef.BlackHoleSink
Version:
Doc: This sink will send your beloved samples on the Road To Nowhere, without consuming any computing power (I hope you are impressed). Upon release, a log message will be issued, containing the number of sample containers received during the black hole lifetime. Optionally, the timestamp of the PushSample call will be written to the current log file, for debugging purposes.
Input:
Name Type Default value Description
LogPushSampleTimestamp eef_Bool False Whether to emit a log entry when a sample is pushed. This is meant for debugging and analysis.

RAW

Class: Sink
Type: RAW
Implementation: eef.RawSampleWriter
Version:
Doc: None
Input:
Name Type Default value Description
DumpSamplePrettyPrint eef_Bool False None
RemoveStreamIdSuffix eef_Bool False None
FileNamePrefix eef_UTF16String None None

EVSMXF

Class: Sink
Type: EVSMXF
Implementation: eef.SinkWriter
Version:
Doc: None
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
AudioBits eef_Uint64 24 None
BlockSize eef_Uint64 8 None
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
ClipMode eef_UTF8String Default None
Allowed: ['Default', 'QuadQuadrants', 'DualPlay']
Type eef_UTF8String eef:EvsMuxerConfig None
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat EVSMXF None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

EVSXT

Class: Sink
Type: EVSXT
Implementation: eef.SinkWriter
Version:
Doc: None
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
AudioBits eef_Uint64 24 None
BlockSize eef_Uint64 8 None
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
ClipMode eef_UTF8String Default None
Allowed: ['Default', 'QuadQuadrants', 'DualPlay']
Type eef_UTF8String eef:EvsMuxerConfig None
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat EVSXT None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

MP4

Class: Sink
Type: MP4
Implementation: eef.SinkWriter
Version:
Doc: None
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
AudioBits eef_Uint64 24 None
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat MP4 None
AudioEndianness eef_EndiannessType little_endian None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

MPEGDASH

Class: Sink
Type: MPEGDASH
Implementation: eef.SinkWriter
Version:
Doc: None
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
AdditionalVideoSegmentsTargetDuration eef_Double None If set, overwrite the segments target duration of additional video tracks (all tracks except the main one)
AudioSegmentsTargetDuration eef_Double None If set, overwrite the segments target duration of audio tracks
SegmentsTargetDuration eef_Double 2.000000 The target segments' duration (seconds) according to ISO BMFF fragments specification, the real duration may differ depending with IDR frames
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat MPEGDASH None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

MXFOP1a

Class: Sink
Type: MXFOP1a
Implementation: eef.SinkWriter
Version:
Doc: The element is able to mux data in an MXF file
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat MXFOP1a None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

MXFOP1a_AFN100

Class: Sink
Type: MXFOP1a_AFN100
Implementation: eef.SinkWriter
Version:
Doc: The element is able to mux data in an MXF file
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat MXFOP1a_AFN100 None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

MXFOP1a_ARDZDFHDF

Class: Sink
Type: MXFOP1a_ARDZDFHDF
Implementation: eef.SinkWriter
Version:
Doc: The element is able to mux data in an MXF file
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat MXFOP1a_ARDZDFHDF None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

MXFOP1a_AS11UKDPP

Class: Sink
Type: MXFOP1a_AS11UKDPP
Implementation: eef.SinkWriter
Version:
Doc: The element is able to mux data in an MXF file
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat MXFOP1a_AS11UKDPP None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

MXFOP1a_SonyXAVC

Class: Sink
Type: MXFOP1a_SonyXAVC
Implementation: eef.SinkWriter
Version:
Doc: The element is able to mux data in an MXF file
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat MXFOP1a_SonyXAVC None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

MXFOP1a_SonyXDCAM

Class: Sink
Type: MXFOP1a_SonyXDCAM
Implementation: eef.SinkWriter
Version:
Doc: The element is able to mux data in an MXF file
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat MXFOP1a_SonyXDCAM None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

MXFOP1a_SonyXDCAMSxS

Class: Sink
Type: MXFOP1a_SonyXDCAMSxS
Implementation: eef.SinkWriter
Version:
Doc: The element is able to mux data in an MXF file
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat MXFOP1a_SonyXDCAMSxS None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

QuickTime

Class: Sink
Type: QuickTime
Implementation: eef.SinkWriter
Version:
Doc: None
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
AudioBits eef_Uint64 24 None
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
Type eef_UTF8String eef:QtMuxerConfig None
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat QuickTime None
AudioEndianness eef_EndiannessType little_endian None
AudioTrackLayout eef_TrackLayout AudioTrackMono None
QtFileLayout eef_QtFileLayout regular_single_file None

QuickTimeRef

Class: Sink
Type: QuickTimeRef
Implementation: eef.SinkWriter
Version:
Doc: None
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
AudioBits eef_Uint64 24 None
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
Type eef_UTF8String eef:QtMuxerConfig None
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat QuickTimeRef None
AudioEndianness eef_EndiannessType little_endian None
AudioTrackLayout eef_TrackLayout AudioTrackMono None
QtFileLayout eef_QtFileLayout regular_single_file None

WAVE

Class: Sink
Type: WAVE
Implementation: eef.SinkWriter
Version:
Doc: None
Input:
Name Type Default value Description
HandleSmpte334m eef_Bool False Whether the SMPTE334M ancillary data should be written in the destination file, if possible.
MaxAudiosOut eef_Uint64 None Allow some codecs to extend the default number of output audio
WriterConfig eef_UTF8String None Additional configuration options for legacy usage
FilePath eef_UTF16String None Path of the resource where the samples will be written. If left empty, an Open command must be made before the sink can receive samples.
ExpectedBoundaries eef_TimeLimits None Informs of the known expected boundaries at opening time. This is optional.
MediaTimeCodeIn eef_MediaTimeCode None Specifies the timecode in of the output media
WrapperFormat eef_WrapperFormat WAVE None
AudioTrackLayout eef_TrackLayout AudioTrackMono None

UmfWriter

Class: Sink
Type: UmfWriter
Implementation: eef
Version:
Doc: This sink will store the received samples to a file (or a set of files) that can be played back later.
Input:
Name Type Default value Description
FilePath eef_UTF16String None The path of the file that will be written. Please include an .umf extension to this path for better tooling support. The writer may create additional files from this base name (eg: filename.umf.info.xml, filename.umf.stream.audio.0.0-1.bin,...) : you need to consider them as a whole and handle them together (when copying, moving, renaming the base part of the name...).

RAW

Class: SinkBridge
Type: RAW
Implementation: eef.FreeImageReaderTestSink
Version:
Doc: This sink performs a set of tests for the eefReadersEx FreeImageReader media source (R&D tests only).Please have a look at eefReadersExBuilder.cpp in case you want to do the same for your own tests. Call 1-800-EEFSDK for more info (toll free).
Input:
Name Type Default value Description
TestName eef_UTF8String None The exact validation test to perform
Allowed: Test01

RAW

Class: Source
Type: RAW
Implementation: eef.FreeImageReader
Version:
Doc: This source will read a set of image files from a filesystem folder by using the FreeImage library.The images must all bear the same width and height and must all be convertible to 24-bit RGB using FreeImage.The supported image formats are (from http://freeimage.sourceforge.net/features.html as of FreeImage 3.10): - BMP files - Dr. Halo CUT files (grayscale only) - DDS files - EXR files - Raw Fax G3 files - GIF files - HDR files - ICO files - IFF files - JNG files - JPEG/JIF files - JPEG-2000 File Format - JPEG-2000 codestream - JPEG-XR files - KOALA files - Kodak PhotoCD files - MNG files - PCX files - PBM/PGM/PPM files - PFM files - PNG files - Macintosh PICT files - Photoshop PSD files (restrictions apply) - RAW camera files - Sun RAS files - SGI files - TARGA (TGA) files - TIFF files - WBMP files - WebP files - XBM files - XPM files
Input:
Name Type Default value Description
ShouldLoop eef_Bool False Whether the source will loop the images in order to reach MaxNumSuppliedImages, or whether it will stop once every image has been supplied once
MaxNumImagesToSupply eef_Uint64 18446744073709551615 The maximum number of images that the source will supply, regardless of the looping mode. By default, the source will loop forever OR finish when
FileNameRegex eef_UTF8String .* The regular expression that allows selecting the images to read (NOT a bash or cmd-style wildcard!). For instance, this string (in literal C format) is ".*\\."
ImageFolder eef_UTF8String . The folder containing the images. Windows note: this is NOT an ANSI string! Please convert first.
EditRate eef_EditRate 50*1|1 Set this to the EditRate that will be reported by the source.
MaxNumPreloadedImages eef_Uint32 0 The maximum number of images that will be preloaded at configuration time. If set to 0, no images will be preloaded.
ScanMode eef_ScanMode progressive Whether the source will return a progressive or interlaced video formats. In the latter case, the images are treated as individual fields.

MXFOP1a

Class: Source
Type: MXFOP1a
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
KEEPSMPTE334 eef_Bool False None
SUPERMOTION eef_Bool False None
FilePath eef_UTF16String None None

MXFOP1a_AFN100

Class: Source
Type: MXFOP1a_AFN100
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
KEEPSMPTE334 eef_Bool False None
SUPERMOTION eef_Bool False None
FilePath eef_UTF16String None None

MXFOP1a_ARDZDFHDF

Class: Source
Type: MXFOP1a_ARDZDFHDF
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
KEEPSMPTE334 eef_Bool False None
SUPERMOTION eef_Bool False None
FilePath eef_UTF16String None None

MXFOP1a_AS11UKDPP

Class: Source
Type: MXFOP1a_AS11UKDPP
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
KEEPSMPTE334 eef_Bool False None
SUPERMOTION eef_Bool False None
FilePath eef_UTF16String None None

MXFOP1a_SonyXAVC

Class: Source
Type: MXFOP1a_SonyXAVC
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
KEEPSMPTE334 eef_Bool False None
SUPERMOTION eef_Bool False None
FilePath eef_UTF16String None None

MXFOP1a_SonyXDCAM

Class: Source
Type: MXFOP1a_SonyXDCAM
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
KEEPSMPTE334 eef_Bool False None
SUPERMOTION eef_Bool False None
FilePath eef_UTF16String None None

MXFOP1a_SonyXDCAMSxS

Class: Source
Type: MXFOP1a_SonyXDCAMSxS
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
KEEPSMPTE334 eef_Bool False None
SUPERMOTION eef_Bool False None
FilePath eef_UTF16String None None

UmfReader

Class: Source
Type: UmfReader
Implementation: eef
Version:
Doc: This source will read the files that have been created with the UmfWriter sink and will supply the samples stored therein. Supply it with the file path to the .umf main file of the archive.
Input:
Name Type Default value Description
LoopCount eef_Int64 1 The number of times to repeat the whole sample container sequence. If set to -1, the source will loop indefinitely (until Interrupt() is called). When the reader loops back to the first sample container, the mediatimes are reset to their starting value. If you need a continuous stream of ever-increasing media times, you need to connect a reclocker to the output of this source.
FilePath eef_UTF16String None Path to the UMF file that you wish to read

Unknown

Class: Source
Type: Unknown
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
KEEPSMPTE334 eef_Bool False None
SUPERMOTION eef_Bool False None
FilePath eef_UTF16String None None

Class: SourceConnector
Type:
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
Allocator eef_UTF8String None None
DefinedOutput eef_UTF8String caca None

SpeedGear

Class: SpeedGear
Type: SpeedGear
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

video.mjpeg

Class: VideoAnalyser
Type: video.mjpeg
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description

FieldsExtractorFilter

Class: VideoConverter
Type: FieldsExtractorFilter
Implementation: eef
Version:
Doc: This filter extracts the top & bottom fields from a Interlaced RAW Frame. A single buffer containing the 2 merged fields will be split to 2 buffers containing each one a field. If the 2 fields should be processed separately, the following standardized selections could be used: "video.0.0" for top field andvideo.0.1 for bottom field. Supported Input FourCC: YV16, I422, YY2F and V210. Supported Input Chroma: 422 and 444.
Input:
Name Type Default value Description
AllocatorLowerField eef_UTF8String None For advanced user: manage how the memory is allocated. If undefined the classical recycling model is used. If set then the memory is fully managed by the user/caller.
AllocatorUpperField eef_UTF8String None For advanced user: manage how the memory is allocated. If undefined the classical recycling model is used. If set then the memory is fully managed by the user/caller.

FieldsMergerFilter

Class: VideoConverter
Type: FieldsMergerFilter
Implementation: eef
Version:
Doc: This filter merges a top and bottom RAW fields into a single sample. Two buffers containing each one a field will be merged to 1 buffer containing a whole interlaced frame. If the 2 fields come from 2 different elements, one input should be used with the following pin: "Top" and the other one with "Bottom".Supported Input FourCC: YV16 and I422. Supported Input Chroma: 422 and 444.
Input:
Name Type Default value Description

ImageConverter

Class: VideoConverter
Type: ImageConverter
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
InputROIHeight eef_Uint64 None Define the height in pixels of the Region of Interest (ROI) if you only want to use part of the image
InputROILeft eef_Uint64 None Define the left position in pixels of the Region of Interest (ROI) if you only want to use part of the image
InputROITop eef_Uint64 None Define the top position in pixels of the Region of Interest (ROI) if you only want to use part of the image
InputROIWidth eef_Uint64 None Define the width in pixels of the Region of Interest (ROI) if you only want to use part of the image
NumThreads eef_Uint64 None Sets the number of threads which the converter should use. If not set, the available number of processors on the system will be used.
OutputHeight eef_Uint64 None Specifies the height in pixels of the output picture. If not set, it will be the same as the input picture.
OutputROIHeight eef_Uint64 None Define the height in pixels of the Region of Interest (ROI) if you only want to use part of the image
OutputROILeft eef_Uint64 None Define the left position in pixels of the Region of Interest (ROI) if you only want to use part of the image
OutputROITop eef_Uint64 None Define the top position in pixels of the Region of Interest (ROI) if you only want to use part of the image
OutputROIWidth eef_Uint64 None Define the width in pixels of the Region of Interest (ROI) if you only want to use part of the image
OutputWidth eef_Uint64 None Specifies the width in pixels of the output picture. If not set, it will be the same as the input picture.
Allocator eef_UTF8String None For advanced user: manage how the memory is allocated. If undefined the classical recycling model is used. If set then the memory is fully managed by the user/caller.
DeinterlacingMethod eef_UTF8String interpolate Type of method used for deinterlacing. None = no deinterlacing is done, blend = deinterlacing is done by blending or averaging consecutive fields, interpolate = deinterlacing is done by replacement of samples of bottom field with samples of top field.
Allowed: ['none', 'blend', 'interpolate']
OutputResolution eef_UTF8String None Specifies the resolution of the output picture. It can not be used in conjunction with the "OutputWidth" or "OutputHeight" parameters.
Allowed: ['SIF', 'SD', 'HD720', 'HD1080', 'UHD1']
ResamplingMethod eef_UTF8String lanczos2 Type of interpolation method used for rescaling
Allowed: ['catmullrom', 'lanczos2', 'mitchel', 'notch', 'gaussian1', 'gaussian2']
OutputFourCC eef_FourCC None Output fourCC. If not set, it will be same as input.
Allowed: ['Y800', 'YUYV', 'YU2F', 'YVYU', 'UYVY', 'V210', 'YV12', 'YV16', 'I420', 'I422', 'YY2F', 'BGR3', 'BGRA', 'RGB3', 'RGBA']
OutputColorSpace eef_ColorSpace None Output color space. If not set, it will be same as input.
OutputAspectRatio eef_VideoAspectRatio None Specifies the picture aspect ratio of the output picture. If not set, it will be the same as the input picture.
OutputScanMode eef_ScanMode None Specifies the scan mode of the output picture. If not set, it will be the same as the input picture.

VideoFrameRateConverter

Class: VideoConverter
Type: VideoFrameRateConverter
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
ConversionMode eef_UTF8String nearest Specifies the conversion mode used: nearest = input video frames will be either repeated or skipped to match the output frame rate. keepAllFrames = All input video frames will be used with the new output frame rate (only FrameRate modification). NB: media duration will be changed
Allowed: ['nearest', 'keepAllFrames']
OutputFrameRatePreset eef_UTF8String None Specifies the frame rate preset of the output video. It can not be used in conjunction with the "OutputFrameRate" or "OuputFrameRateFactor" parameters: sd_framerate_equivalent = output frame rate will be 29.97 fps for all multiple input frame rate, 25 fps otherwise. sd_or_hd_framerate_equivalent = output frame rate will be 25 fps, 29.97 fps, 50 fps or 59.94 for all multiple input frame rate.
Allowed: ['sd_framerate_equivalent', 'sd_or_hd_framerate_equivalent']
OutputFrameRate eef_EditRate None Specifies the frame rate of the output video. It can not be used in conjunction with the "OutputFrameRateFactor" or "OutputFrameRatePreset" parameters.
OutputFrameRateFactor eef_Rational None Specifies the frame rate factor of the output video (output frame rate = input frame rate * factor). It can not be used in conjunction with the "OutputFrameRate" or "OutputFrameRatePreset" parameters.

video.264

Class: VideoDecoder
Type: video.264
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
NumThreads eef_Uint64 None Sets the number of threads which the decoder should use. If not set, the available number of processors on the system will be used. This parameter is used only if SMP mode equal to 'BySlices' or 'ByPictures'.
Allocator eef_UTF8String None For advanced user: manage how the memory is allocated. If undefined the classical recycling model is used. If set to ExtBufferAllocator then the memory is fully managed by the user/caller.
SMPMode eef_UTF8String ByPictures Sets symmetric multiprocessing (SMP) mode of decoding: None : SMP is turned off, single threaded version is used. ByPictures : SMP is turned on, pictures are decoded on logical CPUs in parallel. BySlices : SMP is turned on, slices of same picture are decoded on logical CPUs in parallel.
Allowed: ['None', 'ByPictures', 'BySlices']
OutputFourCC eef_FourCC None Sets the fourCC format of the output picture. If not set, value will be I420 for 4:2:0 bitstream, YUYV for 4:2:2 8bit bitstream and V210 for 4:2:2 10bit bitstream.
Allowed: ['YUYV', 'YVYU', 'UYVY', 'V210', 'YV12', 'YV16', 'I420', 'I422', 'BGR3', 'BGRA']

video.mjpeg

Class: VideoDecoder
Type: video.mjpeg
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
Allocator eef_UTF8String None For advanced user: manage how the memory is allocated. If undefined the classical recycling model is used. If set then the memory is fully managed by the user/caller.
OutputFourCC eef_FourCC None Must be the same as fourCC used for encoding
Allowed: ['YV12', 'YV16', 'I420', 'I422', 'BGRA', 'BGR3', 'RGBA', 'RGB3']

video.prores

Class: VideoDecoder
Type: video.prores
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
SkipField eef_Bool False Performance parameter for decoding only one field out of two
Allocator eef_UTF8String None For advanced user: manage how the memory is allocated. If undefined the classical recycling model is used. If set to ExtBufferAllocator then the memory is fully managed by the user/caller.
OutputFourCC eef_FourCC None Sets the fourCC format of the output picture. If not set, value will be V210 (packed YUV4:2:2 10 bits per component) for ProRes 422.
Allowed: ['UYVY', 'V210']

video.264

Class: VideoEncoder
Type: video.264
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
DetachThread eef_Bool None Runs the encoder in a new thread or not. 0 means NO, 1 means YES
LowDelay eef_Bool False Minimize the encoder latency. This may decrease quality or overall processing performance.
UseDeblockingFilter eef_Bool None Indicates whether to use deblocking for smoothing video frames. 0 means NO, 1 means YES
WriteSettingsInfo eef_Bool None Write encoder settings on first IDR. 0 means NO, 1 means YES
BitRate eef_Uint64 None Specifies the average bit rate in bits/sec. If not set, the value will depend on the selected preset.
BitRateMax eef_Uint64 None Specifies the maximum bit rate in bits/sec. If not set, the value will depend on the selected preset.
InputFifoSize eef_Uint64 None Sets the size in bytes of the encoder input fifo. If not set, it will be automatically calculated.
KeyFrameInterval eef_Uint64 None Specifies the GOP length in number of frames. If not set, the value will depend on the selected preset.
KeyFrameTimedInterval eef_Uint64 None Specifies the GOP length in milliseconds. If not set, the value will depend on the selected preset.
MaxReferenceFramesDistance eef_Uint64 None Maximum distance between two P frames
NumParallelPics eef_Uint64 None Sets the number of pictures for parallel encoding. If not set, the available number of processors on the system will be used.
NumThreads eef_Uint64 None Sets the number of threads which the encoder should use. If not set, the available number of processors on the system will be used.
NumberOfSlices eef_Uint64 None Number of slices per picture
OutputBitDepth eef_Uint64 None Specifies the video bit depth in output of the encoder. If not set, the value will depend on the selected preset.
Allowed: ['8', '10']
PercentageOfQualityLevel eef_Uint64 None Adjust encoding quality versus encoding performance. 0% is for maximum performance, minimum quality. 100% is for minimum performance, maximum quality. If not set, average quality level will be used.
Range: [0,100]
BitRateMode eef_UTF8String None Specifies the bitrate control mode. If not set, the value will depend on the selected preset.
Allowed: ['CBR', 'VBR']
CPUOptimization eef_UTF8String None Specifies the cpu optimization to be used during encoding. If not set, best possible mode will be used.
Allowed: ['C', 'MMX', 'MMX_EXT', 'SSE', 'SSE2', 'SSE3', 'SSE4', 'AVX']
H264Level eef_UTF8String None Specify the H264 level used to encode. If not set, the value will depend on the selected preset. If set to 'auto', the encoder will select the level automatically according to the frame size and bit rate.
Allowed: ['1', '1b', '1.1', '1.2', '1.3', '2', '2.1', '2.2', '3', '3.1', '3.2', '4', '4.1', '4.2', '5', '5.1', '5.2', 'auto']
H264Profile eef_UTF8String None Specify the H264 profile used to encode. If not set, the value will depend on the selected preset.
Allowed: ['BASELINE', 'MAIN', 'EXTENDED', 'HIGH', 'HIGH_10', 'HIGH_422']
Preset eef_UTF8String H264_BASELINE Encoder preset.
Allowed: ['H264_1SEG', 'H264_AFN100', 'H264_AVCHD', 'H264_AVID_PROXY', 'H264_BASELINE', 'H264_BD', 'H264_BD_HDMV', 'H264_CIF', 'H264_D1', 'H264_DVD', 'H264_FLASH_HIGHRES', 'H264_FLASH_LOWRES', 'H264_HDTV_1080i', 'H264_HDTV_720p', 'H264_HD_DVD', 'H264_HD_DVD_BD_MV', 'H264_HIGH', 'H264_IIS_SMOOTHSTREAMING', 'H264_INTRA_CLASS_100', 'H264_INTRA_CLASS_50', 'H264_MAIN', 'H264_PSP', 'H264_PSP_480x270', 'H264_PSP_640x480', 'H264_SVCD', 'H264_XAVC_INTRA_4K_CLASS_300', 'H264_XAVC_INTRA_4K_CLASS_480', 'H264_XAVC_INTRA_CLASS_100', 'H264_XAVC_INTRA_CLASS_50', 'H264_XAVC_LongGOP', 'H264_iPOD', 'H264_iPOD_640x480', 'MCPROFILE_PIFF']
SceneChangeDetection eef_UTF8String None Specifies the scene change detection. If not set, scene detection is active or not depending on the other encoding presets. If active, the encoder will set IDR on scene change. This mode allows gop's size variation. If inactive, fixed gops' size are expected.
Allowed: ['active', 'inactive']
VideoLevelsRange eef_UTF8String None Specify whether to keep video levels outside of allowed range. If not set, the value will depend on the selected preset.
Allowed: ['short', 'full']
OutputChroma eef_VideoChroma None Specifies the video chroma in output of the encoder. If not set, the value will depend on the selected preset.
OutputAspectRatio eef_VideoAspectRatio None Specifies the video aspect ratio in output of the encoder. If not set, the value will be same as input aspect ratio.

video.mjpeg

Class: VideoEncoder
Type: video.mjpeg
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
JpegQuality eef_Uint64 100 The image quality of the generated JPEG image (1 = worst, 100 = best)
Range: [1,100]
Allocator eef_UTF8String None For advanced user: manage how the memory is allocated. If undefined the classical recycling model is used. If set to ExtBufferAllocator then the memory is fully managed by the user/caller.

video.prores

Class: VideoEncoder
Type: video.prores
Implementation: eef
Version:
Doc: None
Input:
Name Type Default value Description
NumThreads eef_Uint64 0 The number of simultaneous processing threads to spawn. Set this to 0 to have the encoder determine this automatically based on the number of processors in the system.
ProResCodecVariant eef_ProResCodecVariant 422 Performance parameter for the encoding quality

VideoGenerator

Class: VideoGenerator
Type: VideoGenerator
Implementation: eef
Version:
Doc: The Video Generator is a sample video source generator. Various patterns and video formats are available. According to TrackLayout and PictureEncodingStructure, several buffers can be generated. Ex: top and bottom fields in Interlaced/separated_fields.In this case, the background's color will be different for each sample. If the samples should be processed separately, the following standardized selections could be used: In Interlaced/separated_fields: "video.0.0" for top field and "video.0.1" for bottom field. In 3D: "video.0.0" for 1st frame and "video.0.1" for 2nd one. In 3DInterlace/merged_fields : "video.0.0-1" for 1st frame and "video.0.2-3" for 2nd frame. In 3DInterlace/separated_fields : "video.0.0" for 1st frame/Top Field, "video.0.1" for 1st frame/Bottom Field, "video.0.2" for 2nd frame/Top Field, "video.0.3" for 2nd frame/Bottom Field.
Input:
Name Type Default value Description
LogGetSampleTimestamp eef_Bool False Whether to emit a log entry when a sample is requested. This is meant for debugging.
Height eef_Uint64 1080 None
InitialTC eef_Uint64 0 None
NumberOfImages eef_Uint64 30 None
RandomSquares eef_Uint64 0 Number of random squares to generate
Width eef_Uint64 1920 None
Allocator eef_UTF8String None None
BackgroundColor eef_UTF8String white None
Allowed: ['white', 'red', 'green', 'blue', 'lightred', 'lightgreen', 'lightblue']
PictureEncodingStructure eef_UTF8String merged_fields Use merged_fields to generate interlace sample in 1 buffer. Separated_fields for 2 buffers. This only works with an interlace TrackLayout.
Allowed: ['merged_fields', 'separated_fields']
VideoPattern eef_UTF8String TimecodeMarkers None
Allowed: ['TimecodeMarkers', 'RandomSquares', 'BlankImage', 'RandomPixels']
FrameRate eef_EditRate 25*1|1 None
FourCC eef_FourCC UYVY None
Allowed: ['YUYV', 'UYVY', 'V210', 'YV12', 'YV16', 'I420', 'I422', 'Y800', 'BGRA', 'BGR3']
ColorSpace eef_ColorSpace BT601 NB: the generated picture is simply mark as corresponding to this colorSpace.
TrackLayout eef_TrackLayout VideoTrack None
Allowed: ['VideoTrack', 'VideoTrack3D', 'VideoTrackInterlace', 'VideoTrack3DInterlace']
AspectRatio eef_VideoAspectRatio 16_9 None
SleepMsOnGetSample eef_Uint32 0 The number of milliseconds to wait at each GetSample before starting the sample computation and supplying it. This is meant for debugging and analysis purposes.

TGASource

Class: VideoSource
Type: TGASource
Implementation: eef
Version:
Doc: This source can be used to open and decode tga files. Supported Input: Uncompressed, True-Color and Compressed, True-Color. Output FourCC: BGRA
Input:
Name Type Default value Description

Buffering

Name Type Default value Description
background eef_Bool True None
buffer_max_size eef_Uint32 5 max size in number of frames

TimeLimits

Name Type Default value Description
in_ms eef_MediaTimeCode None time in (milli seconds)
out_ms eef_MediaTimeCode None time out (milli seconds)
tc_in eef_MediaTimeCode None time code in
tc_out eef_MediaTimeCode None time code out

TrackActivation

Name Type Default value Description

Parallelization

Name Type Default value Description
AsynchronousContigousPacketSize eef_Uint32 1 None
AsynchronousMaxFifoSize eef_Uint32 5 Maximum size of the parallelizer input FIFO
AsynchronousMaxOutputFifoSize eef_Uint32 5 (Advanced) Maximum size of the parallelizer output FIFO
AsynchronousNumInstances eef_Uint32 1 Number of instances that run concurrently

EditUnit

Name Type Default value Description
FloatOutput eef_Bool True None
MaxBufferSize eef_Uint64 150 None
OutputAudioBitDepth eef_Uint64 24 None
BehaviourAtFlush eef_UTF8String AllowPartialEditUnit AllowPartialEditUnit or CompleteEditUnitOnly
Allowed: ['CompleteEditUnitOnly', 'AllowPartialEditUnit']

VideoSource

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetDirection( )
ArgName Type Default value Description
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
GetTimeLimits( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String source None
Doc: None
GotoTimeOffset( TimeRef, TimeOffset, )
ArgName Type Default value Description
TimeRef eef_UTF8String source None
TimeOffset eef_MediaTime None None
Doc: None
IsGrowing( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
IsMediaOpen( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
Open( path, )
ArgName Type Default value Description
path eef_UTF16String None None
Return: undefined
Doc: None
SetDirection( direction, )
ArgName Type Default value Description
direction eef_MediaSourceDirection None None
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

AudioSource

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetDirection( )
ArgName Type Default value Description
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
GetTimeLimits( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String source None
Doc: None
GotoTimeOffset( TimeRef, TimeOffset, )
ArgName Type Default value Description
TimeRef eef_UTF8String source None
TimeOffset eef_MediaTime None None
Doc: None
IsGrowing( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
IsMediaOpen( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
Open( path, )
ArgName Type Default value Description
path eef_UTF16String None None
Return: undefined
Doc: None
SetDirection( direction, )
ArgName Type Default value Description
direction eef_MediaSourceDirection None None
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

LiveVideoSource

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
IsRunning( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
Pause( )
ArgName Type Default value Description
Return: undefined
Doc: None
Ping( timeOutMs, )
ArgName Type Default value Description
timeOutMs eef_Uint64 18446744073709551615 None
Return: eef_Bool
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

LiveAudioSource

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
IsRunning( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
Pause( )
ArgName Type Default value Description
Return: undefined
Doc: None
Ping( timeOutMs, )
ArgName Type Default value Description
timeOutMs eef_Uint64 18446744073709551615 None
Return: eef_Bool
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

AudioGenerator

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
Stop( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

VideoGenerator

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
Stop( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

LiveAudioGenerator

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
Stop( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

LiveVideoGenerator

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
Stop( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

Source

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetDirection( )
ArgName Type Default value Description
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
GetTimeLimits( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String source None
Doc: None
GotoTimeOffset( TimeRef, TimeOffset, )
ArgName Type Default value Description
TimeRef eef_UTF8String source None
TimeOffset eef_MediaTime None None
Doc: None
IsGrowing( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
IsMediaOpen( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
Open( path, )
ArgName Type Default value Description
path eef_UTF16String None None
Return: undefined
Doc: None
SetDirection( direction, )
ArgName Type Default value Description
direction eef_MediaSourceDirection None None
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

AudioDecoder

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

VideoDecoder

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

AudioEffect

Activate( )
ArgName Type Default value Description
Return: undefined
Doc: None
Deactivate( )
ArgName Type Default value Description
Return: undefined
Doc: None
GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

VideoEffect

Activate( )
ArgName Type Default value Description
Return: undefined
Doc: None
Deactivate( )
ArgName Type Default value Description
Return: undefined
Doc: None
GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

AudioEncoder

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

VideoEncoder

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

Sink

Close( force, )
ArgName Type Default value Description
force eef_Bool False None
Return: undefined
Doc: None
GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
Open( path, )
ArgName Type Default value Description
path eef_UTF16String None None
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

VideoSink

Close( force, )
ArgName Type Default value Description
force eef_Bool False None
Return: undefined
Doc: None
GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
Open( path, )
ArgName Type Default value Description
path eef_UTF16String None None
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

AudioSink

Close( force, )
ArgName Type Default value Description
force eef_Bool False None
Return: undefined
Doc: None
GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
Open( path, )
ArgName Type Default value Description
path eef_UTF16String None None
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

LiveVideoSink

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
IsRunning( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
Pause( )
ArgName Type Default value Description
Return: undefined
Doc: None
Ping( timeOutMs, )
ArgName Type Default value Description
timeOutMs eef_Uint64 18446744073709551615 None
Return: eef_Bool
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

LiveAudioSink

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
IsRunning( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
Pause( )
ArgName Type Default value Description
Return: undefined
Doc: None
Ping( timeOutMs, )
ArgName Type Default value Description
timeOutMs eef_Uint64 18446744073709551615 None
Return: eef_Bool
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

SourceConnector

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

SinkConnector

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

LiveSource

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
IsRunning( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
Pause( )
ArgName Type Default value Description
Return: undefined
Doc: None
Ping( timeOutMs, )
ArgName Type Default value Description
timeOutMs eef_Uint64 18446744073709551615 None
Return: eef_Bool
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

LiveSink

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
IsRunning( )
ArgName Type Default value Description
Return: eef_Bool
Doc: None
Pause( )
ArgName Type Default value Description
Return: undefined
Doc: None
Ping( timeOutMs, )
ArgName Type Default value Description
timeOutMs eef_Uint64 18446744073709551615 None
Return: eef_Bool
Doc: None
Start( )
ArgName Type Default value Description
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

SourceBridge

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

SinkBridge

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

Adapter

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

AudioConverter

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

VideoConverter

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

Monitor

GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

Preload

AddCuePoint( cuePoint, )
ArgName Type Default value Description
cuePoint eef_MediaTime None None
Return: undefined
Doc: None
ClearPreloadBuffers( )
ArgName Type Default value Description
Return: undefined
Doc: None
FillPreloadBuffers( )
ArgName Type Default value Description
Return: undefined
Doc: None
GetCurrentPosition( )
ArgName Type Default value Description
Doc: None
GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetDirection( )
ArgName Type Default value Description
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetSpeed( )
ArgName Type Default value Description
Return: eef_Double
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
RemoveCuePoint( cuePoint, )
ArgName Type Default value Description
cuePoint eef_MediaTime None None
Return: undefined
Doc: None
SetCurrentPosition( currentPosition, )
ArgName Type Default value Description
currentPosition eef_MediaTime None None
Return: undefined
Doc: None
SetDirection( direction, )
ArgName Type Default value Description
direction eef_MediaSourceDirection Forward None
Return: undefined
Doc: None
SetSpeed( speed, )
ArgName Type Default value Description
speed eef_Double 1.000000 None
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None

SpeedGear

DecrementPosition( decrement, )
ArgName Type Default value Description
decrement eef_Uint32 1 None
Return: undefined
Doc: None
GetCurrentPosition( )
ArgName Type Default value Description
Doc: None
GetCurrentTimeInfo( TimeRef, )
ArgName Type Default value Description
TimeRef eef_UTF8String None None
Doc: None
GetEditRate( )
ArgName Type Default value Description
Return: eef_EditRate
Doc: None
GetLastErrorMessage( )
ArgName Type Default value Description
Doc: None
GetSpeed( )
ArgName Type Default value Description
Return: eef_Double
Doc: None
GetStatus( )
ArgName Type Default value Description
Return: eef_Status
Doc: None
GetTimeLimits( )
ArgName Type Default value Description
Doc: None
Goto( position, )
ArgName Type Default value Description
position eef_MediaTime None None
Doc: None
GotoEnd( )
ArgName Type Default value Description
Doc: None
GotoStart( )
ArgName Type Default value Description
Doc: None
IncrementPosition( position, )
ArgName Type Default value Description
position eef_MediaTime None None
Return: undefined
Doc: None
SetCurrentPosition( currentPosition, )
ArgName Type Default value Description
currentPosition eef_MediaTime None None
Return: undefined
Doc: None
SetSpeed( speed, )
ArgName Type Default value Description
speed eef_Double 1.000000 None
Return: undefined
Doc: None
UpdateConfig( config, )
ArgName Type Default value Description
config eef_UTF8String None None
Return: undefined
Doc: None