Container Readers

AAC Audio (ADTS) [aac ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

AAF Format [aaf ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Aggregate Container Format [aggr]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Adaptive Multi-Rate Audio [amr ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

AAF Format [avid]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


MxfStorageFolder

Specifies the folder path for MXF files.

Type: byte[utf-8]


ProcessAvidMXFFilesEnabled

Specifies whether Avid MXF file needs to be processed

Type: Bool


InMADPath

Specifies the path for an optional input MAD file.

Type: byte[utf-8]


OutMADPath

Specifies the path for output MAD file.

Type: byte[utf-8]


DataContainer

Identifies the data essence container.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

AVC [h264]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Adobe Photoshop image format [psd ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Duration

The duration of image sequence.

The duration represents the entire duration for the image sequence. The image sequence will be looped or truncated until the duration is reached.

Type: Int64


FrameDuration

The frame duration of each image in the sequence.

When multiple images are discovered, each will be represented as a single video frame with a duration specified by this property value.

Type: Int64


TimeScale

The time scale.

The time scale gives the units by which time is measured. The frame rate is time scale / frame duration.

Type: Int64


FilePattern

The pattern to match files within the directory.

Specifies a regular expression used to match files within the directory. All files matching this pattern will be included in the image sequence.

Note: Defaults to the default file name. If left unset, will only match the file used to open the reader.

Type: String


Frames

The frames

A count of the required frames. I.e. fill in blanks where pattern generator cannot find the file

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Advanced Systems Format [asf ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Apple HLS Package Format [hls ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Audio Interchange File Format [aiff]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Audio Video Interleaved [avi ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Blackmagic RAW [braw]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Bitmap image format [bmp ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Duration

The duration of image sequence.

The duration represents the entire duration for the image sequence. The image sequence will be looped or truncated until the duration is reached.

Type: Int64


FrameDuration

The frame duration of each image in the sequence.

When multiple images are discovered, each will be represented as a single video frame with a duration specified by this property value.

Type: Int64


TimeScale

The time scale.

The time scale gives the units by which time is measured. The frame rate is time scale / frame duration.

Type: Int64


FilePattern

The pattern to match files within the directory.

Specifies a regular expression used to match files within the directory. All files matching this pattern will be included in the image sequence.

Note: Defaults to the default file name. If left unset, will only match the file used to open the reader.

Type: String


Frames

The frames

A count of the required frames. I.e. fill in blanks where pattern generator cannot find the file

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

C890 Subtitles [c890]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Cheetah Closed Caption [chee]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Digital Cinema Package Subtitle [dcps]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Digital Interface Format (DV) [dif ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Digital Picture Exchange image format [dpx ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

DirectShow Adapter [qrtz]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


AlwaysUseVirtualFlip

Enables or disables the use of a virtual flip process.

Type: Bool


ForceDecoder

Forces the use of the specified decoder.

Type: byte[]


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Dolby Digital [ac3 ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

DolbyVision XML Metadata [dovi]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

EBU Subtitle Exchange Format [stl ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


FrameDuration

The Stl Frame Duration

Type: Int


IgnoreTimecode

Option to ignore the TCP/TCF header time codes

Type: Bool


TimeScale

The Stl Time Scale

Type: Int


DropFrame

The Stl Drop Frame

Type: Bool


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Edit Decision List [edl ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


GroupMedia

Forces EDL container reader to group the media and only play one group at a time.

Type: Bool


DisableChaining

Don’t allow the Edl file to chain to other Edl files.

Type: Bool


SearchPath

The path on which to search for media files.

Type: utf8[]


BlackSynthesis

Signals that hte EDL decoder is using black synthesis.

Type: Bool


SmilManufacturer

Get Manufacturer value from SMIL header.

Type: Bool


UseSOM

Forces EDL container reader to sue SOM timecode from SMIL header.

Type: Bool


DeferredBegin

Forces an internal reader to call begin after previous segment completes

Type: Bool


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Flash Video [flv ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Fragmented MPEG-4 ISO Base Media Format [fmp4]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Album

Album or collection name of which the movie content forms a part.

Type: byte[utf-8]


Comment

User entered comment regarding the movie file content.

Type: byte[utf-8]


Copyright statement for the movie file content.

Type: byte[utf-8]


Author

Name of the author of the movie file content.

Type: byte[utf-8]


Artist

Name of the artist who created the movie file content.

Type: byte[utf-8]


Artwork

A single image that can represent the movie file content.

Type: byte[jpeg|png|bmp]


CreationDate

The date the movie file content was created.

Type: byte[utf-8]


Title

The title of the movie file content. This is typically a single text line.

Type: byte[utf-8]


Description

Description of the movie file content.

Type: byte[utf-8]


Director

Name of the director of the movie content.

Type: byte[utf-8]


Genre

Text describing the genre or genres to which the movie content conforms. There is no prescribed vocabulary for names of genres.

Type: byte[utf-8]


Keywords

Keywords associated with the movie file content.

Type: byte[utf-8]


Information

Information about the movie file content.

Type: byte[utf-8]


Location

Geographic point location by coordinates as defined in ISO 6709:2008.

Type: byte[utf-8]


Make

Camera manufacturer.

Type: byte[utf-8]


Model

Camera model.

Type: byte[utf-8]


Producer

Name of producer of movie file content.

Type: byte[utf-8]


Publisher

Name of publisher of movie file content.

Type: byte[utf-8]


Software

Name of software used to create the movie file content.

Type: byte[utf-8]


Year

Year when the movie file or the original content was created or recorded.

Type: byte[utf-8]


UserCollection

A name indicating a user-defined collection that includes this movie.

Type: byte[utf-8]


UserRating

A number, assigned by the user, that indicates the rating or relative value of the movie. This number can range from 0.0 to 5.0. A value of 0.0 indicates that the user has not rated the movie.

Type: BE Float32


TimeCodeSource

Indicates the time code source

Type: utf8[]


VideoSampleDescriptionIndex

The sample description index to use when determining video properties

Type: UInt32


TimeCodeMode

Indicates the presence and display mode of the time code track:

Type: TimeCodeModeType


UserData

Named property collection of raw user data.

Type: CProperties


CaptionType

Indicates the presence and data type of the caption track.

FourCC Meaning
‘c608’ Indicates a CEA-608 closed caption track.
‘c708’ Indicates a CEA-708 closed caption track.

Type: Four


AncillaryDataType

Indicates the presence and data type of the caption track.

FourCC Meaning
‘anc ' Indicates a telestream proprietary anc track.

Type: Four


FileType

The brand value from the MPEG-4 file type ‘ftyp’ box.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

TimeCodeModeType

TimeCodeMode enumeration

Value Name Description
1 TimeCodeTrackPresent Time code track present.
2 TimeCodeTrackEnabled Time code track enabled, trak/tkhd[flags = Enabled].
4 TimeCodeTrackVisible Time code track visible, trak/mdia/minf/gmhd/tmcd/tmci[flags = ShowTimeCode].

General Exchange Format [gxf ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Graphics Interchange Format [gif ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

HEVC [hevc]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

VVC [vvc ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Telestream Index File [indx]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


ContainerType

Indicates the container type of the index file.

For example, if the original file was an Mpeg2 Transport Stream file set this property to the type of the Mpeg2 Transport Stream Container Reader, ‘m2ts’.

Note: If not set, the container type stored in the index file will be used.

Type: Four


ContainerPath

Indicates the path to the original container file where the media is stored.

Note: If not set, the path stored in the index file will be used.

Type: String


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

JPEG File Interchagne Format [jfif]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Lambda CAP Subtitles [lcap]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


TimeScale

The time scale of the video frame.

Type: Int32


FrameDuration

The frame duration of the video frame.

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Leitch Exchange Format [lxf ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

MPEG Audio [mpga]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

MPEG-1 System Stream [mpg ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


ReferenceMode

Determines the sample used to derived the reference (or origin) time.

Type: ReferenceModeType


VideoSyncWindow

Video sync tolerance window (in samples).

Specifies the maximum difference between the sample time and the accumulated duration of the video media. Correction is applied if the error exceeds this value. Specify 0 to disable sync correction.

Type: Int32


AudioSyncWindow

Audio sync tolerance window (in samples).

Specifies the maximum difference between the sample time and the accumulated duration of the video media. Correction is applied if the error exceeds this value. Specify 0 to disable sync correction.

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

ReferenceModeType

ReferenceMode enumeration

Value Name Description
2 FirstIFrame Reference time is derived from the first I frame.
0 FirstMediaSample Reference time is derived from the first media sample.
1 FirstVideoSample Reference time is derived from the first video sample.

MPEG-1 Video [m1v ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

MPEG-2 Program Stream [m2ps]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


ReferenceMode

Determines the sample used to derived the reference (or origin) time.

Type: ReferenceModeType


VideoSyncWindow

Video sync tolerance window (in samples).

Specifies the maximum difference between the sample time and the accumulated duration of the video media. Correction is applied if the error exceeds this value. Specify 0 to disable sync correction.

Type: Int32


AudioSyncWindow

Audio sync tolerance window (in samples).

Specifies the maximum difference between the sample time and the accumulated duration of the video media. Correction is applied if the error exceeds this value. Specify 0 to disable sync correction.

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

ReferenceModeType

ReferenceMode enumeration

Value Name Description
2 FirstIFrame Reference time is derived from the first I frame.
0 FirstMediaSample Reference time is derived from the first media sample.
1 FirstVideoSample Reference time is derived from the first video sample.

HikVision NVR [imkh]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


ReferenceMode

Determines the sample used to derived the reference (or origin) time.

Type: ReferenceModeType


VideoSyncWindow

Video sync tolerance window (in samples).

Specifies the maximum difference between the sample time and the accumulated duration of the video media. Correction is applied if the error exceeds this value. Specify 0 to disable sync correction.

Type: Int32


AudioSyncWindow

Audio sync tolerance window (in samples).

Specifies the maximum difference between the sample time and the accumulated duration of the video media. Correction is applied if the error exceeds this value. Specify 0 to disable sync correction.

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

ReferenceModeType

ReferenceMode enumeration

Value Name Description
2 FirstIFrame Reference time is derived from the first I frame.
0 FirstMediaSample Reference time is derived from the first media sample.
1 FirstVideoSample Reference time is derived from the first video sample.

MPEG-2 Transport Stream [m2ts]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


ReferenceMode

Determines the sample used to derived the reference (or origin) time.

Type: ReferenceModeType


VideoSyncWindow

Video sync tolerance window (in samples).

Specifies the maximum difference between the sample time and the accumulated duration of the video media. Correction is applied if the error exceeds this value. Specify 0 to disable sync correction.

Type: Int32


AudioSyncWindow

Audio sync tolerance window (in samples).

Specifies the maximum difference between the sample time and the accumulated duration of the video media. Correction is applied if the error exceeds this value. Specify 0 to disable sync correction.

Type: Int32


ProgramNumber

Program number in the Program Map Table (PMT)

Type: UInt16


Id

Transport stream ID in the Program Association Table (PAT).

Type: UInt16


ProgramNumbers

Array of available program_numbers

Type: UInt16[]


PcrPid

Program Clock Reference (PCR) packet identifier (PID).

Type: UInt16


PmtPid

Program Map Table (PMT) packet identifier (PID).

Type: UInt16


AacTransportFormat

Indicates whether the audio format should indicate the AAC transport (ADTS or LOAS).

If true the AAC media format will indicate the transport mechanism (adts or loas) and the media samples will contain ADTS or LOAS frames. If false the media format will be AAC (mp4a) and the media sample will contain AAC frames.

Type: Boolean


EtvContext

ETV metadata context.

This property should contain the fully qualified path to the container.

Type: String


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

ReferenceModeType

ReferenceMode enumeration.

Value Name Description
2 FirstIFrame Reference time is derived from the first I frame.
0 FirstMediaSample Reference time is derived from the first media sample.
1 FirstVideoSample Reference time is derived from the first video sample.

MPEG-2 Video [m2v ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

MPEG-4 File Format [mp4 ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Album

Album or collection name of which the movie content forms a part.

Type: byte[utf-8]


Comment

User entered comment regarding the movie file content.

Type: byte[utf-8]


Copyright statement for the movie file content.

Type: byte[utf-8]


Author

Name of the author of the movie file content.

Type: byte[utf-8]


Artist

Name of the artist who created the movie file content.

Type: byte[utf-8]


Artwork

A single image that can represent the movie file content.

Type: byte[jpeg|png|bmp]


CreationDate

The date the movie file content was created.

Type: byte[utf-8]


Title

The title of the movie file content. This is typically a single text line.

Type: byte[utf-8]


Description

Description of the movie file content.

Type: byte[utf-8]


Director

Name of the director of the movie content.

Type: byte[utf-8]


Genre

Text describing the genre or genres to which the movie content conforms. There is no prescribed vocabulary for names of genres.

Type: byte[utf-8]


Keywords

Keywords associated with the movie file content.

Type: byte[utf-8]


Information

Information about the movie file content.

Type: byte[utf-8]


Location

Geographic point location by coordinates as defined in ISO 6709:2008.

Type: byte[utf-8]


Make

Camera manufacturer.

Type: byte[utf-8]


Model

Camera model.

Type: byte[utf-8]


Producer

Name of producer of movie file content.

Type: byte[utf-8]


Publisher

Name of publisher of movie file content.

Type: byte[utf-8]


Software

Name of software used to create the movie file content.

Type: byte[utf-8]


Year

Year when the movie file or the original content was created or recorded.

Type: byte[utf-8]


UserCollection

A name indicating a user-defined collection that includes this movie.

Type: byte[utf-8]


UserRating

A number, assigned by the user, that indicates the rating or relative value of the movie. This number can range from 0.0 to 5.0. A value of 0.0 indicates that the user has not rated the movie.

Type: BE Float32


TimeCodeSource

Indicates the time code source

Type: utf8[]


VideoSampleDescriptionIndex

The sample description index to use when determining video properties

Type: UInt32


TimeCodeMode

Indicates the presence and display mode of the time code track:

Type: TimeCodeModeType


UserData

Named property collection of raw user data.

Type: CProperties


CaptionType

Indicates the presence and data type of the caption track.

FourCC Meaning
‘c608’ Indicates a CEA-608 closed caption track.
‘c708’ Indicates a CEA-708 closed caption track.

Type: Four


AncillaryDataType

Indicates the presence and data type of the caption track.

FourCC Meaning
‘anc ' Indicates a telestream proprietary anc track.

Type: Four


FileType

The brand value from the MPEG-4 file type ‘ftyp’ box.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

TimeCodeModeType

TimeCodeMode enumeration

Value Name Description
1 TimeCodeTrackPresent Time code track present.
2 TimeCodeTrackEnabled Time code track enabled, trak/tkhd[flags = Enabled].
4 TimeCodeTrackVisible Time code track visible, trak/mdia/minf/gmhd/tmcd/tmci[flags = ShowTimeCode].

MXF (OP-1b External Essence) [oe1b]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

MXF (OP-1b Internal Essence) [oi1b]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


P2XmlClipMetadata

Panasonic P2 Ultra AVC XML metadata string

Note: Defaults to the default file name.

Type: string


P2Thumbnail

Panasonic P2 Ultra AVC BMP thumbnail content

Type: byte []


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

MXF Digital Cinema Package [dcp ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


FallbackFolder

The fallback folder when an asset cannot be found.

Type: String


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

MXF Interoperable Master Package [imf ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


SubtitleSegmentation

Specifies the subtitle read mode.

Reader emits individual subtitle samples similar to the CTtmlContainerReader: TRUE. (for use preview and playback) Reader emits one sample for example as large XML document containing all subtitles: FALSE. (for batch processing and transmuxing)

Type: Bool


ComplexCompositionPlaylist

Specifies if complex CPLs are supported

Type: Bool


FallbackFolder

The fallback folder when an asset cannot be found.

Type: String


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

MXF SMPTE IMF Timed Text [imtt]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

MacCaption MCC VANC data file [mcc ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

EVS Native MXF [evs ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

Material Exchange Format (OP-1a Program) [op1p]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

Material Exchange Format (OP-1a) [op1a]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

Material Exchange Format (OP-Atom) [atom]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

Material Exchange Format (OP-PD Proxy) [oppd]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


IndexedEditUnits

The indexed edit units.

Type: IndexedEditUnitsType


Version

Human readable form of the application version.

Type: utf8[]


ProductName

Name of the application which created or modified the MXF file.

Type: utf8[]


CompanyName

Manufacturer of the equipment or application that created or modified the MXF file.

See Also: SMPTE ST377-1 Section A.3 Identification

Type: utf8[]


Origin

The origin in edit units.

Type: Int64


Platform

Human readable form of the toolkit and operating system.

Type: utf8[]


DataContainer

Identifies the data essence container.

Type: Four


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

IndexedEditUnitsType

IndexedEditUnits enumeration

Value Name Description
1 Always Always
2 WhenNoDuration When no duration

Matroska Multimedia Container [mkv ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

OpenEXR Image Format [oexr]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Duration

The duration of image sequence.

The duration represents the entire duration for the image sequence. The image sequence will be looped or truncated until the duration is reached.

Type: Int64


FrameDuration

The frame duration of each image in the sequence.

When multiple images are discovered, each will be represented as a single video frame with a duration specified by this property value.

Type: Int64


TimeScale

The time scale.

The time scale gives the units by which time is measured. The frame rate is time scale / frame duration.

Type: Int64


FilePattern

The pattern to match files within the directory.

Specifies a regular expression used to match files within the directory. All files matching this pattern will be included in the image sequence.

Note: Defaults to the default file name. If left unset, will only match the file used to open the reader.

Type: String


Frames

The frames

A count of the required frames. I.e. fill in blanks where pattern generator cannot find the file

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

PAC Subtitles [pac ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


TimeScale

The time scale of the video frame.

Type: Int32


FrameDuration

The frame duration of the video frame.

Type: Int32


DropFrame

Flag indicating drop frame timecodes.

Type: Bool


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Raw PCM audio [pcm ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Format

The format to be reflected on the output properties.

See Also: CMediaProperties

Type: Four


Language

The language to be reflected on the output properties.

See Also: CMediaProperties

Type: UInt16 or String


Region

The region to be reflected on the output properties.

See Also: CMediaProperties

Type: UInt16 or String


ChannelContent

The channel content to be reflected on the output properties.

See Also: CAudioProperties

Type: Array


ChannelLabels

The channel labels to be reflected on the output properties.

See Also: CAudioProperties

Type: Array


Channels

The channels to be reflected on the output properties.

See Also: CAudioProperties

Type: Int32


SampleRate

The sample rate to be reflected on the output properties.

See Also: CAudioProperties

Type: Int32


ChannelProgram

The channel program to be reflected on the output properties.

See Also: CAudioProperties

Type: Array


ChannelCoding

The channel coding to be reflected on the output properties.

See Also: CAudioProperties

Type: Array


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Portable Network Graphics [png ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Duration

The duration of image sequence.

The duration represents the entire duration for the image sequence. The image sequence will be looped or truncated until the duration is reached.

Type: Int64


FrameDuration

The frame duration of each image in the sequence.

When multiple images are discovered, each will be represented as a single video frame with a duration specified by this property value.

Type: Int64


TimeScale

The time scale.

The time scale gives the units by which time is measured. The frame rate is time scale / frame duration.

Type: Int64


FilePattern

The pattern to match files within the directory.

Specifies a regular expression used to match files within the directory. All files matching this pattern will be included in the image sequence.

Note: Defaults to the default file name. If left unset, will only match the file used to open the reader.

Type: String


Frames

The frames

A count of the required frames. I.e. fill in blanks where pattern generator cannot find the file

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Scalable Vector Graphics [svg ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Duration

The duration of image sequence.

The duration represents the entire duration for the image sequence. The image sequence will be looped or truncated until the duration is reached.

Type: Int64


FrameDuration

The frame duration of each image in the sequence.

When multiple images are discovered, each will be represented as a single video frame with a duration specified by this property value.

Type: Int64


TimeScale

The time scale.

The time scale gives the units by which time is measured. The frame rate is time scale / frame duration.

Type: Int64


FilePattern

The pattern to match files within the directory.

Specifies a regular expression used to match files within the directory. All files matching this pattern will be included in the image sequence.

Note: Defaults to the default file name. If left unset, will only match the file used to open the reader.

Type: String


Frames

The frames

A count of the required frames. I.e. fill in blanks where pattern generator cannot find the file

Type: Int32


Replacement

The replacement configuration.

regex_replace parameters.

Note: .

Type: Property


Regex

The replacement configuration.

regex_replace parameters.

Note: .

Type: Property


Replace

The replacement configuration.

regex_replace parameters.

Note: .

Type: Property


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Raw YUV [yuv ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Format

The format in which to emit video samples.

Type: Int32


MatrixCoefficients

The matrix coefficients of the output color space.

The matrix coefficients determine the YUV->RGB conversion matrix.

Note: See the values enumerated by MatrixCoefficients.

Type: Int32


TransferCharacteristics

The transfer characteristics of the output color space.

The transfer characteristics determine the non-linear electro-optical response function.

Note: See the values enumerated by TransferCharacteristics.

Type: Int32


Height

The height of the video frame.

Type: Int32


FieldOrder

The field order of the video frame.

Type: Int32


Width

The width of the video frame.

Type: Int32


TimeScale

The time scale of the video frame.

Type: Int32


FrameDuration

The frame duration of the video frame.

Type: Int32


ColorPrimaries

The color primaries of the output color space.

The color primaries determine the RGB->XYZ conversion matrix.

Note: See the values enumerated by ColorPrimaries.

Type: Int32


VideoRange

The video range of the output color space.

Teh video range specifies the range of values in RGB/YUV.

Note: See the values enumerated by VideoProperties.

Type: Int32


ParX

The horizontal pixel-aspect-ratio of the video frame.

Type: Int32


ParY

The vertical pixel-aspect-ratio of the video frame.

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Scenarist Closed Caption [scc ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


FrameDuration

The frame duration of the video frame.

Type: Int32


TimeScale

The time scale of the video frame.

Type: Int32


DropFrame

Flag indicating drop frame timecodes.

Type: Bool


IgnoreDropFrameSeparators

Flag indicating if ‘;’ is interpreted as ‘drop frame’ timecodes.

Type: Bool


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

SeaChange DVL [dvl ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Sony Petasite [peta]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Spruce Subtitle Format [ssf ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


TimeScale

The time scale of the video frame.

Type: Int32


FrameDuration

The frame duration of the video frame.

Type: Int32


DropFrame

Flag indicating drop frame timecodes.

Type: Bool


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

SubRip File Format [srt ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


FrameDuration

The frame duration of the video frame.

Type: Int32


TimeScale

The time scale of the video frame.

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Tag Image File Format [tiff]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Duration

The duration of image sequence.

The duration represents the entire duration for the image sequence. The image sequence will be looped or truncated until the duration is reached.

Type: Int64


FrameDuration

The frame duration of each image in the sequence.

When multiple images are discovered, each will be represented as a single video frame with a duration specified by this property value.

Type: Int64


TimeScale

The time scale.

The time scale gives the units by which time is measured. The frame rate is time scale / frame duration.

Type: Int64


FilePattern

The pattern to match files within the directory.

Specifies a regular expression used to match files within the directory. All files matching this pattern will be included in the image sequence.

Note: Defaults to the default file name. If left unset, will only match the file used to open the reader.

Type: String


Frames

The frames

A count of the required frames. I.e. fill in blanks where pattern generator cannot find the file

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Telestream Intermediate Format [tifo]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


SequentialRead

Specifies if the ContainerReader should read the stream in a strictly sequential fashion

Type: Bool


IngnoreMarkInMarkOut

Enables or disables the ability to read all data from the tifo files regardless of markin and markout values.

Type: Bool


Version

Check to see which Tifo version we have

Type: Uint32


ReceiveTermFrame

Check to see if we have received a termination frame

Type: Bool


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Timed Text Markup Language [ttml]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


SubtitleSegmentation

Specifies the subtitle read mode.

Reader emits individual subtitle samples similar to the CTtmlContainerReader: TRUE. (for use preview and playback) Reader emits one sample for example as large XML document containing all subtitles: FALSE. (for batch processing and transmuxing)

Type: Bool


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Truevision Advanced Raster Graphics Adapter image format [tga ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Duration

The duration of image sequence.

The duration represents the entire duration for the image sequence. The image sequence will be looped or truncated until the duration is reached.

Type: Int64


FrameDuration

The frame duration of each image in the sequence.

When multiple images are discovered, each will be represented as a single video frame with a duration specified by this property value.

Type: Int64


TimeScale

The time scale.

The time scale gives the units by which time is measured. The frame rate is time scale / frame duration.

Type: Int64


FilePattern

The pattern to match files within the directory.

Specifies a regular expression used to match files within the directory. All files matching this pattern will be included in the image sequence.

Note: Defaults to the default file name. If left unset, will only match the file used to open the reader.

Type: String


Frames

The frames

A count of the required frames. I.e. fill in blanks where pattern generator cannot find the file

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Web Video Text Track [vtt ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


FrameDuration

The frame duration of the video frame.

Type: int32


TimeScale

The time scale of the video frame.

Type: int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Windows Audio Format [wav ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


TimeReference

The time reference (in sample rate units).

Type: uint64


CodingHistory

Coding history.

Type: char[]


Description

Description of the sound sequence.

Type: char[]


Originator

Name of the originator.

Type: char[]


OriginatorReference

Reference of the originator.

Type: char[]


OriginationDate

yyyy:mm:dd.

Type: char[]


OriginationTime

hh:mm:ss.

Type: char[]


Umid

SMPTE UMID.

Type: byte[64]


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Windows Audio Format 64 [wv64]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


TimeReference

The time reference (in sample rate units).

Type: uint64


CodingHistory

Coding history.

Type: char[]


Description

Description of the sound sequence.

Type: char[]


Originator

Name of the originator.

Type: char[]


OriginatorReference

Reference of the originator.

Type: char[]


OriginationDate

yyyy:mm:dd.

Type: char[]


OriginationTime

hh:mm:ss.

Type: char[]


Umid

SMPTE UMID.

Type: byte[64]


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

YUV4MPEG [y4m ]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Free Lossless Audio Codec [flac]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

ARRI Raw Image Format [arri]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


Duration

The duration of image sequence.

The duration represents the entire duration for the image sequence. The image sequence will be looped or truncated until the duration is reached.

Type: Int64


FrameDuration

The frame duration of each image in the sequence.

When multiple images are discovered, each will be represented as a single video frame with a duration specified by this property value.

Type: Int64


TimeScale

The time scale.

The time scale gives the units by which time is measured. The frame rate is time scale / frame duration.

Type: Int64


FilePattern

The pattern to match files within the directory.

Specifies a regular expression used to match files within the directory. All files matching this pattern will be included in the image sequence.

Note: Defaults to the default file name. If left unset, will only match the file used to open the reader.

Type: String


Frames

The frames

A count of the required frames. I.e. fill in blanks where pattern generator cannot find the file

Type: Int32


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Apple Core Audio Format [caff]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


EditTimeScale

Specifies the desired timescale of the material. Particularly useful in audio only readers.

Type: Int64


EditFrameDuration

Specifies the desired frame duration of the material. Particularly useful in audio only readers.

Type: Int64


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Composition Container Format [comp]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


TrimMode

Determines the trim mode.

Type: TrimMode


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

TrimModeType

TrimMode enumeration

Value Name Description
4 ReEncodeFrameAccurate Re-encode frame accurate
0 Unknown Unknown trim mode
1 OriginRollOut Frame accurate trim mode using Origin and Roll-Out or Edit List
3 CloseGop Close GOP at Boundary
2 GopBoundary GOP Boundary

Dolby Atmos Master File [damf]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


EditFrameDuration

Specifies the desired frame duration of the material. Particularly useful in audio only readers

Type: Int64


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

Dolby Atmos Storage File [datm]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


EditFrameDuration

Specifies the desired frame duration of the material. Particularly useful in audio only readers

Type: Int64


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

DASH Package [dash]

Properties:

Credentials

Specifies the credentials that might be necessary to access the underlying streams

Type: String


QueueSize

Specifies the size of the media sample queues.

Type: Int32


TimeCode

Starting time code value.

Type: byte[utf-8]


CacheCount

Specifies the number of stream cache buffers.

Type: Int32


CacheSize

Specifies the size (in bytes) of the stream cache buffers.

Type: Int32


Threads

Specifies the number of threads to use in the container

Type: Int32


IndexVideoDuration

Gets the accurate video duration from the index file (if present) or 0 if not. Blocking!

Type: Int64


ReadTimeout

Specifies a value, in milliseconds, that determines determines how long the stream will attempt to read before timing out.

Type: Int32


ForgoEssenceInspection

Instructs the reader not to read and inspect the sample essence during indexing at the expense of the accuracy of certain sample properties (e.g. picture type).

Type: Bool


IsIndexAtEnd

Gets an indication that the index thread has reached the end of an open file

This value is unset until the index thread has to wait for more data to become available at which pont it is set to true

Type: Bool


ReadMargin

Specifies a value, in bytes, that determines determines how far back from the end of stream bytes can be read from

Type: Int32


MetadataFlags

Flags for metadata processing

Type: MetadataFlagType


FixedEventPreroll

The preroll (in seconds) that should be applied to each event.

Note: If not set or set to a negative number then the require preroll is specified by using the presentation time

Type: Double


Enumerations:

MetadataFlagType

MetadataFlagType enumeration

Value Name Description
1 DisableVbiDecode Disable Vbi Decode

R3D Camera Format [red ]

Properties:

DecodeMode

The resolution/quality to decode the video in for R3D decodes.

Type: DecodeModeType


ProcessingMode

The processing mode to be used by the reader (if configurable).

Type: \red ProcessingModeType


BitDepthMode

The bitdepth mode to be used by the reader

Type: BitDepthModeType


Enumerations:

DecodeModeType

DecodeMode enumeration

Value Name Description
1145393735 DECODE_EIGHT_RES_GOOD Eighth resolution good decode.
1145459280 DECODE_FULL_RES_PREMIUM Full resolution premium decode.
1145590352 DECODE_HALF_RES_PREMIUM Half resolution premium decode.
1145590343 DECODE_HALF_RES_GOOD Half resolution good decode.
1146180167 DECODE_QUARTER_RES_GOOD Quarter resolution good decode.
1146241874 DECODE_SIXTEENTH_RES_GOOD Sixteenth resolution good decode.

ProcessingModeType

ProcessingMode enumeration

Value Name Description
0 CPU If configurable, the CPU is used for the decode.
1 GPU If configurable, the GPU is used for the decode.

BitDepthModeType

BitDepthMode enumeration

Value Name Description
0 Auto Auto
1 EightBit Eight bit

Signal Generator [sigg]