Container Writers

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


MasterMobId

Specifies the master mob id of the asset

Type: 32 bytes


FrameChaseUpdateInterval

Specifies the frame chase update interval x. AAF will be updated every x frames

Type: Int32


AvidProjectName

Specifies the Project Name Avid extension tag value

Type: byte[utf-8]


IsisMxfStorageFolder

Specifies the folder in ISIS storage used for storing indexed MXF files.

Type: byte[utf-8]


TapeName

Specifies the Tape Name.

Type: byte[utf-8]


AncillaryDataType

Indicates the presence and data type of the data track.

FourCC Meaning
‘anc ' Indicates a SMPTE436 anc track.

Type: Four


TapeSourcePackage

Specifies the Tape Source Package Id.

Type: 32 bytes


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


MaterialPackageId

Specifies the Material Package Id.

Type: wchar


ChainManagerStatus

Specifies the Chain Manager Status

Type: ChainManagerStatusType


AddTagName

Specifies the Tag Name to add. A matching AvidTagValue is expected.

Type: byte[utf-8]


PictureStoredHeight

Specifies the Picture track’s Stored Height attribute.

Type: UInt32


ExpectedMaximumDuration

Specifies the Expected Maximum Duration.

Type: Int32


MxfOutputPattern

Specifies the output mxf file name pattern. Deprecated. Does not work with latest AMT SDK. Use Mxf Path Count related properties.

Type: wchar


IsisMxfStorageFolder

Specifies the folder in ISIS storage used for storing indexed MXF files.

Type: byte[utf-8]


AafOutputPath

Specifies the output AAF path.

Type: wchar


AddTagValue

Specifies the Tag Value to add. A matching AvidTagName is expected.

Type: byte[utf-8]


InterplayServerPort

Specifies the Interplay server port

Type: Int32


InterplayFolder

Specifies the Avid Interplay Folder

Type: byte[utf-8]


NotifyHangInterval

Specifies the Notify Hang Interval(ms)

Type: Int64


HeadFrameOffset

Specifies the Head Frame Offset

Type: UInt64


FlushPeriod

Specifies the Flush Period(ms)

Type: UInt64


NotifyProgressInterval

Specifies the Notify Progress Interval(ms)

Type: Int64


VideoTemplate

Specifies the Avid Video Template

Type: byte[utf-8]


AudioEssenceFileSystemIOPageMaxCount

Specifies the Audio Essence FileSystem IO Page Max Count

Type: UInt64


PhysicalMobDescriptionType

Specifies the Physical Mob Description Type

Value Meaning
0 (Default) Tape
1 Import

Type: Int32


AncillaryDataType

Indicates the presence and data type of the data track.

FourCC Meaning
‘anc ' Indicates a SMPTE436 anc track.

Type: Four


TapeName

Specifies the Tape Name.

Type: wchar


FileSystemIOTuningEnabled

Specifies the IO Tuning Enabled flag.

Type: Bool


MxfOutputPathList

Specifies the List of output MXF paths.

Type: wchar


TimecodeOverrideFlag

Specifies the Timecode override flag.

Type: Bool


NonVideoEditRateDropFrameFlag

Specifies the non-Video Asset’s EditRate/DropFrameFlag configuration

Type: UInt8


TimecodeOverride

Specifies the Timecode.

Type: wchar


DropFrameFromSourceTimeCode

Specifies the Timecode Drop Frame flag from the source Timecode

Type: Bool


VideoTrackOutputDisable

Specifies the Video Track to be not output. Default ‘false’

Type: Bool


PictureEssenceEncodingType

Specifies the Avid PictureEssenceEncodingType

Type: byte[utf-8]


OutMADPath

Specifies the Path for writing MAD XML file

Type: byte[utf-8]


PhysicalSourcePackageId

Specifies the Physical Source Package Id.

Type: wchar


FrameChaseUpdateInterval

Specifies the frame chase update interval x. AAF will be updated every x frames

Type: Int32


InterplayUserPassword

Specifies the Avid Interplay User Password

Type: byte[utf-8]


FramePrecharge

Specifies the number of millisecs of precharge duration

Type: UInt64


InterplayServerName

Specifies the Avid Interplay Server Name

Type: byte[utf-8]


InterplayUserName

Specifies the Avid Interplay User Name

Type: byte[utf-8]


InterplayWorkgroup

Specifies the Avid Interplay Workgroup

Type: byte[utf-8]


InMADPath

Specifies the Path for reading MAD XML file

Type: byte[utf-8]


VideoEssenceFileSystemIOPageSize

Specifies the Video Essence FileSystem IO PageSize(MB)

Type: UInt64


AudioEssenceFileSystemIOPageSize

Specifies the Audio Essence FileSystem IO PageSize(MB)

Type: UInt64


DataEssenceFileSystemIOPageSize

Specifies the Data Essence FileSystem IO PageSize(MB)

Type: UInt64


VideoEssenceFileSystemIOPageMaxCount

Specifies the Video Essence FileSystem IO Page Max Count

Type: UInt64


DataEssenceFileSystemIOPageMaxCount

Specifies the Data Essence FileSystem IO Page Max Count

Type: UInt64


PictureFrameLayout

Specifies the Picture track’s Frame Layout attribute.

Type: UInt8


AudioTemplate

Specifies the Avid Audio Template

Type: byte[utf-8]


MaterialName

Specifies the Avid Material Package Name

Type: byte[utf-8]


MaterialPackageTimeCode

Specifies the Avid Material Package Timecode

Type: byte[utf-8]


IsUncompressedSoundCodingAiff

Specifies the Uncompressed Audio samples are from AIFF

Type: Bool


Enumerations:

ChainManagerStatusType

Chain Manager Status enumeration

Value Name Description
0 CHAINMANAGER_STATUS_NOTDEFINED Chain Manager Result Not Defined.
2 CHAINMANAGER_STATUS_ABORTED Chain Manager Aborted.
1 CHAINMANAGER_STATUS_SUCCESS Chain Manager Successfully Completed.
3 CHAINMANAGER_STATUS_NOTDONE Chain Manager has not set a value.

Abekas Clip Format [abks]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


Title

The title stored in the content description object.

Type: byte[utf-8]


Author

Name of the author stored in the content description object.

Type: byte[utf-8]


ExtendedDescription

Extended information stored in the extended content description object.

Lets authors record data describing the file and its contents that is beyond the standard bibliographic information such as title, author, copyright, description, or rating information.

Note: Only booleans, integer types and strings are supported.

Type: CProperties


Rating

Rating stored in the content description object.

Type: byte[utf-8]


Copyright statement stored in the content description object.

Type: byte[utf-8]


Description

Description stored in the content description object.

Type: byte[utf-8]


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


WriteRevision

A boolean value that determines if a revision element should be appended to the RevisionHistory section of the XML document.

Note: Defaults to false

Type: Bool


Comment

A description of the revision.

Type: String


Software

The name of the software tool used to revise the metadata.

Note: Defaults to ‘Telestream Media Foundation’.

Type: String


DateTime

The revision date and time in ISO8601 format.

The date-time value for the Revision element follows the definition in Section 8.2.1.2 of the Adobe XMP Specification, ISO 16684-1:2011(E).

A date-time value is represented using a subset of the formats as defined in Date and Time Formats:

  • YYYY
  • YYYY-MM
  • YYYY-MM-DD
  • YYYY-MM-DDThh:mmTZD
  • YYYY-MM-DDThh:mm:ssTZD
  • YYYY-MM-DDThh:mm:ss.sTZD

In which:

  • YYYY = four-digit year
  • MM = two-digit month (01=January)
  • DD = two-digit day of month (01 to 31)
  • hh = two digits of hour (00 to 23)
  • mm = two digits of minute (00 to 59)
  • ss = two digits of second (00 to 59)
  • s = one or more digits representing a decimal fraction of a second
  • TZD = time zone designator (Z or +hh:mm or -hh:mm)

The time zone designator is an optional field in the string. When not present, the time zone is unknown, and the metadata processor should not assume anything about the missing time zone.

Local time-zone designators +hh:mm or -hh:mm should be used when possible instead of converting to UTC.

Note: If a file was saved at noon on October 23, a timestamp of 2004-10-23T12:00:00-06:00 conveys more information than 2004-10-23T18:00:00Z.

Note: Defaults to the current date and time.

Type: String


Author

The name of the individual or entity that revised the metadata.

Note: Defaults to ‘Telestream, LLC’.

Type: String


SoftwareVersion

The version of the software tool used to revise the metadata.

Note: Defaults to the current version of the Telestream Media Foundation library.

Type: String


Elementary Audio [audi]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


Elementary Video [vide]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


SuppressEditList

Sets a value indicating whether the edit list should be suppressed.

Type: Bool


MdatAlignment

Sets the ‘mdat’ chunk alignment.

Type: long long


UserData

Named property collection of raw user data.

This property can be set on the media properties for each track and on the container writer itself.

Type: CProperties


FreeSize

Sets the size of the ‘free’ box following the ‘moov’ box.

Type: long long


MoovRate

Sets the rate (in seconds) at which the ‘moov’ box is updated.

If this property is non-zero the value determines the rate (in seconds) at which the ‘moov’ is rewritten.

If ‘fast’ start is enabled and there is sufficient free space the ‘moov’ box is updated in place. Otherwise the current ‘mdat’ box is closed, the previous ‘moov’ box is invalidated (overwritten by a ‘skip’ box) and a new ‘moov’ box is written at the current file position.

Type: Int


TrimAudio

Sets a value indicating whether the audio tracks are trimmed to the video track duration.

Type: Bool


MdatExtendedSize

Sets a value indicating whether the ‘mdat’ chunk should have an extended size.

Type: Bool


PrecisionWidth

Sets the video track header width. Does not reflect actual size of video, only display resolution.

Type: UInt32


FastStart

Sets a value indicating whether the ‘moov’ box should precede the ‘mdat’ box.

If this property is true and there is sufficent free space the ‘moov’ box will be written before the ‘mdat’ box. Otherwise the ‘moov’ will be written after the ‘mdat’ box.

Type: Bool


AncillaryDataType

Indicates the presence and data type of the caption track.

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

Type: Four


TimeCodeSource

Indicates the time code source

Type: utf8[]


PrecisionHeight

Sets the video track header height. Does not reflect actual size of video, only display resolution.

Type: UInt32


ReferenceMovieAlias

Selects the type of alias to use for reference movies.

Type: ReferenceMovieAliasType


AllowAnnexB

Sets ability of the writer to allow annex B ‘h264’ style samples

Type: Bool


SuppressBitRate

Prevents the writer from emitting a ‘btrt’ atom

Type: Bool


CompressorName

Sets the description in the sample description table to the compressor name.

Type: String


TimeCodeDropFrame

Indicates the time code drop framiness (timecode track description written before samples)

Type: Bool


TimeCodeMode

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

Type: TimeCodeModeType


ColorParameter

Indicates the color parameter type.

The colr atom typically contains the colorspace triplet (primaries, matrix coefficients, and transfer characteristics). Specifying ExtendedVideoParameterType for this property will also include the video range into the atom. It should be noted that since the extended form of the atom has rarely been seen there are concerns that if an application doesn’t recognize the extended form it won’t recognize any of the colorspace information.

Type: ColorParameterType


FragmentDuration

Fragment duration in seconds.

Note: This property will be removed as we should be using the ATS packager.

Type: Double


DecodeTimeSource

DecodeTimeSource

Note: Value Name Meaning
0000 ZERO time starts a ‘0’
META OFFSET_META_DATA time is taken of sample metadata
SMPL SAMPLE time is taken for sample time

Type: Four


FirstSequenceNumber

FirstSequenceNumber

Type: Int32


Enumerations:

ReferenceMovieAliasType

ReferenceMovieAliasType enumeration

Value Name Description
0 SelfContained None (‘url ' self contained data references)
1 Url Url (‘url ' data references)
2 Apple Apple (‘alis’ data references)
3 Omneon Omneon (‘alis’ data reference)

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].
8 TimeCodeTrackLast Time code should be last track
64 VideoTrackRef Make a reference from the video track.
128 StaticTimeCode Make a static timecode track (i.e. start time code only).

ColorParameterType

ColorParameter enumeration

Value Name Description
1852009571 VideoParameterType ‘nclc’ - Video colorspace triplet.
1852009592 ExtendedVideoParameterType ‘nclx’ - Video colorspace triplet plus video range.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


HDR10+ JSON Metadata [cvt4]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


Tool

Name or description of the software tool used to author the metadata.

Note: Defaults to ‘Telestream Media Foundation’.

Type: String


ToolVersion

Version of the software tool.

Note: Defaults to the current version of the Telestream Media Foundation library.

Type: String


Title

Content title.

Type: String


TitleAlternateVersion

A description of the content version.

Type: String


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


JPEG2000 Codestream Format [jp2k]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


ScrOffset

Offset (in 90kHz units) applied to the System Clock Reference (SCR).

Type: Int64


PtsOffset

Offset (in 90kHz units) applied to the Presentation Time Stamp (PTS). A positive value ensures that presentation times are later than the system clock.

Type: Int64


DtsOffset

Offset (in frame units) applied to the Decoding Time Stamps (PTS).

Note: If specified, the decoding timestamp must be less than or equal to the corresponding presentation timestamp (PTS). The default value (2 fields) ensures that the DTS is equal to the PTS for B pictures. Field encoded sequences or sequences containing reference B pictures will require a different value.

Type: Int32


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


ScrOffset

Offset (in 90kHz units) applied to the System Clock Reference (SCR).

Type: Int64


iTunesCompatible

Enables or disables iTunes compatibility mode.

iTunes will accept an MPEG-2 Program Stream containing MPEG-2 video, MPEG-1 Layer 2 audio and (conditionally) AC-3 audio using DVDF transport.

Type: Bool


PtsOffset

Offset (in 90kHz units) applied to the Presentation Time Stamp (PTS). A positive value ensures that presentation times are later than the system clock.

Type: Int64


DtsOffset

Offset (in field units) applied to the Decoding Time Stamps (PTS).

Note: If specified, the decoding timestamp must be less than or equal to the corresponding presentation timestamp (PTS). The default value (2 fields) ensures that the DTS is equal to the PTS for B pictures. Field encoded sequences or sequences containing reference B pictures will require a different value.

Type: Int32


LpcmTransport

Four character code that identifies the transport mechanism for PCM audio.

The following values are supported:

Value Meaning
BSSD SMPTE 302M-2007
DVDF DVD LPCM

Type: Four


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


ProgramNumber

Program number in the Program Map Table (PMT)

Type: UInt16


Id

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

Type: UInt16


DtsOffset

Offset (in field units) applied to the Decoding Time Stamps (PTS).

Note: If specified, the decoding timestamp must be less than or equal to the corresponding presentation timestamp (PTS). The default value (2 fields) ensures that the DTS is equal to the PTS for B pictures. Field encoded sequences or sequences containing reference B pictures will require a different value.

Type: Int32


PcrPid

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

Type: UInt16


Scte35Pid

SCTE-35 metadata stream packet identifier (PID).

Note: Specify a value of zero to automatically assign the PID and include the metadata stream in the PMT.

Type: UInt16


PmtPid

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

Type: UInt16


Id3Pid

ID3 metadata stream packet identifier (PID).

Note: Specify a value of zero to automatically assign the PID and include the metadata stream in the PMT.

Type: UInt16


DvbVbiPid

DVB VBI metadata stream packet identifier (PID).

Note: Specify a value of zero to automatically assign the PID and include the metadata stream in the PMT.

Type: UInt16


PsiPeriod

Update period (in 90kHz units) of the Program Specific Information (PSI) tables (PAT/PMT).

Default value is 30000 (300 ms).

Type: Int64


PcrOffset

Offset (in 90kHz units) applied to the Program Clock Reference (PCR).

Note: By default (0), the transport stream packet clock reference (PCR) is equal to the decoding timestamp (DTS) of the packet elementary stream (PES) payload.

A positive offset ensures that clock reference is earlier than timestamp.

Type: Int64


PcrPeriod

Update period (in 90kHz units) of the Program Clock Reference (PCR).

@note

Type: Int64


PtsOffset

Offset (in 90kHz units) applied to the Presentation Time Stamps (PTS).

Note: By default (0), the transport stream packet clock reference (PCR) is equal to the decoding timestamp (DTS) of the packet elementary stream (PES) payload.

A positive offset ensures that timestamps are later than the clock reference.

Type: Int64


InsertDvbAu

Enables or disables DVB AU insertion.

Type: Bool


AudioFragmentationDuration

Minimum duration (in 90kHz units) of an audio PES packet.

Type: UInt32


AudioPacketDuration

Minimum audio PES packet duration (in 90kHz units).

Type: UInt32


AudioPacketLength

Minimum audio PES packet length (in bytes).

Type: UInt32


PaceMode

The pace mode to be used by the writer (if configurable).

Type: PaceModeType


Enumerations:

PaceModeType

PaceMode enumeration

Value Name Description
0 None Output stream is not paced.
1 Accurate Output stream is accurately paced.
2 Efficient Output stream is efficiently paced.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


SuppressEditList

Sets a value indicating whether the edit list should be suppressed.

Type: Bool


MdatAlignment

Sets the ‘mdat’ chunk alignment.

Type: long long


UserData

Named property collection of raw user data.

This property can be set on the media properties for each track and on the container writer itself.

Type: CProperties


FreeSize

Sets the size of the ‘free’ box following the ‘moov’ box.

Type: long long


MoovRate

Sets the rate (in seconds) at which the ‘moov’ box is updated.

If this property is non-zero the value determines the rate (in seconds) at which the ‘moov’ is rewritten.

If ‘fast’ start is enabled and there is sufficient free space the ‘moov’ box is updated in place. Otherwise the current ‘mdat’ box is closed, the previous ‘moov’ box is invalidated (overwritten by a ‘skip’ box) and a new ‘moov’ box is written at the current file position.

Type: Int


TrimAudio

Sets a value indicating whether the audio tracks are trimmed to the video track duration.

Type: Bool


MdatExtendedSize

Sets a value indicating whether the ‘mdat’ chunk should have an extended size.

Type: Bool


PrecisionWidth

Sets the video track header width. Does not reflect actual size of video, only display resolution.

Type: UInt32


FastStart

Sets a value indicating whether the ‘moov’ box should precede the ‘mdat’ box.

If this property is true and there is sufficent free space the ‘moov’ box will be written before the ‘mdat’ box. Otherwise the ‘moov’ will be written after the ‘mdat’ box.

Type: Bool


AncillaryDataType

Indicates the presence and data type of the caption track.

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

Type: Four


TimeCodeSource

Indicates the time code source

Type: utf8[]


PrecisionHeight

Sets the video track header height. Does not reflect actual size of video, only display resolution.

Type: UInt32


ReferenceMovieAlias

Selects the type of alias to use for reference movies.

Type: ReferenceMovieAliasType


AllowAnnexB

Sets ability of the writer to allow annex B ‘h264’ style samples

Type: Bool


SuppressBitRate

Prevents the writer from emitting a ‘btrt’ atom

Type: Bool


CompressorName

Sets the description in the sample description table to the compressor name.

Type: String


TimeCodeDropFrame

Indicates the time code drop framiness (timecode track description written before samples)

Type: Bool


TimeCodeMode

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

Type: TimeCodeModeType


ColorParameter

Indicates the color parameter type.

The colr atom typically contains the colorspace triplet (primaries, matrix coefficients, and transfer characteristics). Specifying ExtendedVideoParameterType for this property will also include the video range into the atom. It should be noted that since the extended form of the atom has rarely been seen there are concerns that if an application doesn’t recognize the extended form it won’t recognize any of the colorspace information.

Type: ColorParameterType


Enumerations:

ReferenceMovieAliasType

ReferenceMovieAliasType enumeration

Value Name Description
0 SelfContained None (‘url ' self contained data references)
1 Url Url (‘url ' data references)
2 Apple Apple (‘alis’ data references)
3 Omneon Omneon (‘alis’ data reference)

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].
8 TimeCodeTrackLast Time code should be last track
64 VideoTrackRef Make a reference from the video track.
128 StaticTimeCode Make a static timecode track (i.e. start time code only).

ColorParameterType

ColorParameter enumeration

Value Name Description
1852009571 VideoParameterType ‘nclc’ - Video colorspace triplet.
1852009592 ExtendedVideoParameterType ‘nclx’ - Video colorspace triplet plus video range.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


ContentKind

Specifies the content kind.

Type: String


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


EntryPoint

Entry point.

Specifies the start of the playable region in edit units. By default the entry point is 0. If specified the value must be between 0 and IntrinsicDuration and must be specified in the playlist EditRate.

Type: Int64


Creator

The IMF content creator

Type: char[]


OplRequired

Indicates whether the ‘opl’ file is required.

Type: Bool


CplFileName

Specifies the cpl file name (can be left unspecified and name will be generated)

Type: char[]


VolIndexRequired

Indicates whether the ‘volindex’ file is required.

Type: Bool


MarkerSequence

Array of marker sequences.

Type: Array


AssetMapRequired

Indicates whether the ‘assetmap’ file is required.

Type: Bool


CplRequired

Indicates whether the ‘cpl’ file is required.

Type: Bool


PklRequired

Indicates whether the ‘pkl’ file is required.

Type: Bool


Annotation

The marker annotation.

Type: String


ContentOriginator

The IMF content originator

Type: char[]


ContentTitle

The IMF content kind title

Type: char[]


ContentKind

The IMF content kind according to SMPTE 429-7-2006 Table 2

Type: char[]


ContentVersionList

The IMF content version list according to SMPTE ST 2067-3:2016 6.1.9

Type: Properties (list of Id/LabelText pairs)


SameMediaLength

Forces the IMF media to the exact same length values in the CPL

Type: Bool


Scope

The marker label scope.

Type: String


Marker

Marker

Type: Array of markers.


Label

The marker label.

Type: String


Offset

The marker offset. Must be specified in the playlist EditRate.

Type: UInt64


ComputeHash

Enables or disables the hashing of all assets, including the CLP and OPL.

In order for the Imf package to be valid it must contain hashes of each asset. Unfortuntately, hashing a file can be a costly operation and it may be advantageous for the client to compute the hashes at a later time. This property allows the writer to skip the hashing step. The client is then responsible for calculating the hashes and updating the packing list.

Note: Defaults to true.

Type: Bool


SourceDuration

Source duration.

Specifies the duration of the playable region in edit units. By default the source duration is IntrinsicDuration - EntryPoint. If specified the value must be between 0 and IntrinsicDuration - EntryPoint and must be specified in the playlist EditRate.

Type: Int64


EditRate

Edit rate.

Specifies the edit rate for the playlist. The value is specified as a rational number with the numerator and denominator sepeaated by a space or slash (e.g. ‘24 1’).

Type: String


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


Manzanita MPEG-2 Transport Stream [mzts]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


UseAtscBufferModel

Indicates if the ATSC buffer model should be used for the audio stream.

Type: Bool


PatVersion

Value for the version_number in the Program Association Table.

Type: Int


VariableBitrate

Indicates whether to force the multiplexer to create a variable bitrate transport stream.

Type: Bool


ProgramNumber

Value of the program_number field in the Program Association Table (PAT) and Program Map Table (PMT).

Type: UInt16


TreatUnderflowsAsErrors

Indicates whether to treat buffer underflows/overflows as errors.

Type: Bool


PcrPid

Value of the PCR_PID field in the Program Map Table (PMT).

If set to 0x0000 the PCR_PID value will be set to the first video PID value.

Type: UInt16


Rate

The output rate in bps.

Type: Int


Id

Value of the transport_stream_id field in the Program Association Table (PAT).

Type: UInt16


Headroom

The rate headroom in percent.

Type: Int


RandomAccessIndicator

Specifies if the random_access_indicator is set in every video transport packet.

Type: Bool


ConfigFile

Path to text configuration file.

Type: byte[]


Scte35File

Path to text configuration file.

Type: byte[]


EnablePrivateData

enable private data.

Type: Bool


Scte35Pid

The Scte35 program ID.

Type: Int


PacketTimestampSizeBits

Sets the number of bits in the inserted time stamp.

Type: Int


Scte35DashPassthrough

Indicates whether whether Scte35 Dash / Passthrough is selected..

Type: Bool


AlignAudioPesPackets

Specifies whether every access unit in the audio stream should be aligned to a PES header.

Type: Bool


NullStreamPid

The program ID of the null stream.

Type: Int


AudioPMTOrder

Specifies the order of the audio stream in the PMT.

Type: Int


NullStreamRate

The bitrate of the null stream.

Type: Int


VideoDescriptor4

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this video elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A)..

Type: byte []


ErrorBehavior

The desired error behavior.

Type: Int


TreatSubtitleUnderflowsAsErrors

Indicates whether to treat buffer underflows/overflows as errors.

Type: Bool


AlignVideoPesPackets

Specifies if every access unit in the video stream should be aligned to a PES header.

Type: Bool


ErrorThreshold

The error threshold.

Type: Int


GenerateConfigFile

Indicates whether to generate a config file.

Type: Bool


DvbAc3Descriptor

Use DVB AC3 descriptors

Type: Bool


Enable2Pass

Enables or disables 2 pass muxing.

Type: Bool


PacketTimestampSizeBytes

Sets the size of the inserted time stamp in bytes.

Type: Int


AudioQueueSize

Specifies the size of the audio sample queues.

Type: Int32


InsertDvbAu

Enables or disables DVB AU insertion.

Type: Bool


QuadByteAlignment

Specifies if the data preceding each picture start code is forced to be quad-byte aligned.

Type: Bool


PcrPer

Time in ms between PCRs.

Type: Int


PmtPatOnce

emit the pmt / pat once.

Type: Bool


PatRepetitionRate

Specifies the repetition rate of the Program Association Table in the output transport stream.

Type: Double


PmtPid

Value of the program_map_PID value in the Program Association Table (PAT).

Type: UInt16


InsertPacketTimestamp

Specifies whether to insert a time stamp with every transport packet.

Type: Bool


VideoDescriptor1

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this video elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A)..

Type: byte []


PacketTimestampPrecedesPacket

Specifies whether the inserted time stamp precedes the packet

Type: Bool


AudioDescriptor4

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this audio elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A).

Type: byte []


PacketTimestampLittleEndian

Specifies whether the inserted timestamp will be formated as little-endian.

Type: Bool


AudioDescriptor1

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this audio elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A).

Type: byte []


NoEmptyAdaptationFields

Indicates whether to force the multiplexer to avoid using zero length adaptation fields video packets.

Type: Bool


NotLowDelay

Specifies the video is not a low delay stream.

Type: Int


PmtRepetitionRate

Specifies the repetition rate of the Program Map Table in the output transport stream.

Type: Double


PcrOnEveryPesHeader

Indicates if a PCR should be inserted in each packet with a PES header.

Type: Bool


AacProcessing

Sets the AAC processing method.

Type: AacProcessingType


AudioDescriptor5

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this audio elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A).

Type: byte []


AudioAccessUnitsPerPesPacket

Specifies the frequency of audio access units relative to the frequency of PES headers.

Type: Int


AudioBitrate

Specifies the audio data rate in bits per second.

Type: Int


VideoDescriptor2

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this video elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A)..

Type: byte []


VideoBitrate

Specifies the video data rate in bits per second.

Type: Int


VideoDescriptor3

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this video elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A)..

Type: byte []


VideoDescriptor5

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this video elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A)..

Type: byte []


VideoPMTOrder

Specifies the order of the video stream in the PMT

Type: Int []


CPBSizeFromHRD

Enforce CPBsize as indicated by SPS/VUI/HDR of AVC/HEVC.

Note: Defaults to false.

Type: Bool


AudioDescriptor2

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this audio elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A).

Type: byte []


AudioDescriptor3

Specifies a sequence of hexadecimal data bytes that should be included as descriptor data associated with this audio elementary stream in the PMT. (Ex: 0D 04 4D 41 4E 5A).

Type: byte []


MaxDecodeDelay

Specifies the maximum difference between the video PTS and the PCR (in seconds).

Type: double


Enumerations:

AacProcessingType

AacProcessing enumeration

Value Name Description
1 ConvertToAdts Convert incoming raw AAC frames to the ADTS format.
0 PassThrough Pass-through

Material Exchange Format (AMWA AS-02) [as02]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


ShimName

AMWA AS-02 Shim Name

Type: utf8[]


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

Material Exchange Format (AMWA AS-03) [as03]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


NielsenStreamIdentifier

AMWA AS-03 Nielsen stream identifier.

Type: utf8[]


Identifier

AMWA AS-03 Program identifier.

Type: utf8[]


SlateTitle

AMWA AS-03 Slate title.

Type: utf8[]


Rating

AMWA AS-03 Rating.

Type: utf8[]


SignalStandard

AMWA AS-03 Signal standard.

Type: utf8[]


IdentifierKind

AMWA AS-03 Program identifier kind.

Type: utf8[]


IntendedAfd

AMWA AS-03 Intended AFD.

Type: utf8[]


ShimName

AMWA AS-03 Shim name.

Type: utf8[]


NolaCode

AMWA AS-03 NOLA Code.

Type: utf8[]


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

Material Exchange Format (AMWA AS-10) [as10]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


ShimName

AMWA AS-10 Shim name.

Type: utf8[]


Type

AMWA AS-10 Production type.

Type: utf8[]


MainTitle

AMWA AS-10 Main title.

Type: utf8[]


OrganizationName

AMWA AS-10 Organization name.

Type: utf8[]


TitleDescription

AMWA AS-10 Title description.

Type: utf8[]


SubTitle

AMWA AS-10 Sub title.

Type: utf8[]


PersonName

AMWA AS-10 Person name.

Type: utf8[]


LocationDescription

AMWA AS-10 Location description.

Type: utf8[]


CommonSpanningID

AMWA AS-10 Common spanning identifier.

Type: byte[32]


SpanningNumber

AMWA AS-10 Spanning number.

Type: UInt16


CumulativeDuration

AMWA AS-10 Cumulative duration.

Type: UInt16


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

Material Exchange Format (AMWA AS-11) [as11]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


UkDppProgramme

UK Digital Production Partnership (DPP) XML Programme.

Type: byte[]


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

Material Exchange Format (AMWA AS-12) [as12]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


ShimName

AMWA AS-12 Shim Name.

Type: utf8[]


AdIdAgencyOfficeLocation

AMWA AS-12 Ad-ID AgencyOfficeLocation.

Type: utf8[]


AdIdPrefix

AMWA AS-12 Ad-ID Prefix.

Type: utf8[]


AdIdTitle

AMWA AS-12 Ad-ID Title.

Type: utf8[]


AdIdAdvertiser

AMWA AS-12 Ad-ID Advertiser.

Type: utf8[]


AdIdSdFlag

AMWA AS-12 Ad-ID SD Flag.

Type: utf8[]


AdIdProduct

AMWA AS-12 Ad-ID Product.

Type: utf8[]


AdIdCode

AMWA AS-12 Ad-ID Code.

Type: utf8[]


AdIdMedium

AMWA AS-12 Ad-ID Medium.

Type: utf8[]


AdIdBrand

AMWA AS-12 Ad-ID Brand.

Type: utf8[]


AdIdLength

AMWA AS-12 Ad-ID Length.

Type: utf8[]


AdIdParent

AMWA AS-12 Ad-ID Parent.

Type: utf8[]


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

Material Exchange Format (ARD/ZDF) [ard ]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


IndexingStartPosition

Specifies the Indexing Start Position (Omneon DAL-3 data/TC)

Specifies the position relative to start of essence, in edit units, where indexing starts.

Type: Int32


PartitionStrategy

Specifies the partition strategy.

Type: Int32


PartitionDuration

Specifies the duration, in edit units, of each essence partition.

Type: Double


LeadingIndexDuration

Specifies the duration, in frames, of the leading index duration.

Type: Int32


MultiChannelAudioProperties

Indicates whether to insert multi channel audio properties.

Type: Bool


EssenceDescriptorType

Set the essence descriptor type.

FourCC Meaning
‘cdci’ CDCI Picture Descriptor (ST377) with AVC Sub Descriptor (ST381-3).
‘mpgv’ MPEG Video Descriptor (ST381-2).
‘xavc’ MPEG Video Descriptor (ST381-2) with only CDCI properties.

Type: Four


AudioEditRateType

Set the audio edit rate type.

FourCC Meaning
‘dflt’ Default MXF file version 1.2 video edit rate; for 1.3 audio sample rate
‘audi’ Use the audio sample rate (typically number of samples per second for example 48 kHz; independent from number of samples per edit unit)
‘vidi’ Use the video edit rate (typically frame rate for example 29.97)

Type: Four


UseMpegPictureElement

Indicates whether to use MPEG picture element UL or the VC3 picture element UL.

Type: Bool


FixedSizedDataLength

Specifies the fixed size data elment size

Specifies the fixed size data elment size, in bytes.

Type: Int32


IFrameAtPartitionStart

Indicates partition starts with I-frame

Specifies the fixed size data elment size, in bytes. (Default is True; Partition starts with an I-Frame)

Type: Bool


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

FixedSizedDataDefaults

Default data element sizes

Value Name Description
2560 SONY_LEGACY_DATA_MAXIMUM Maximum for Sony legacy hardware for example Sony PZW-4000
11776 SONY_XAVC_DATA_MAXIMUM XAVC Format, File Format Specifications, Version 1.20 (4.2.4.5.1 ANC Data Packet)
4096 TELESTREAM_DATA_MAXIMUM Default to accomadte larger data elements for example real time GPS and camera datat

EssenceDescriptors

Essense descriptor types.

Value Name Description
1667523433 CDCI ‘cdci’ : CDCI Picture Descriptor (ST377) with AVC Sub Descriptor (ST381-3).
1836083062 MPGV ‘mpgv’ : MPEG Video Descriptor (ST381-2).
2019653219 XAVC ‘xavc’ : MPEG Video Descriptor (ST381-2) with only CDCI properties.

AudioEditRates

Audio edit rate types.

Value Name Description
1684434036 Default ‘dflt’ : Default MXF file version 1.2 video edit rate; for 1.3 audio sample rate
1635083369 Audio ‘audi’ : Use the audio sample rate (typically number of samples per second for example 48 kHz; independent from number of samples per edit unit)
1986618473 Video ‘vidi’ : Use the video edit rate (typically frame rate for example 29.97)

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


GrowingFileType

Indicates the the File as growing. Avid’s Frame Chase flavor.

Type: Bool


AncillaryDataType

Indicates the presence and data type of the data track.

FourCC Meaning
‘anc ' Indicates a SMPTE436 anc track.

Type: Four


TapeName

The MXF tape name.

Type: utf8[]


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

Material Exchange Format (SMPTE RDD25) [rd25]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

Material Exchange Format (SMPTE RDD9 Sony MPEG Long GOP) [rd9 ]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


MaxClusterDuration

Sets max duration for cluster in milliseconds.

Note: Must be in range 0-32767 ms. Default value is 32767 ms.

Type: Int32


MinClusterDuration

Sets min duration for cluster in milliseconds.

Note: Must be in range 0-32767 ms. Default value is 0 ms.

Type: Int32


WebMMode

Enables or disables WebM writing.

Note: Default value is true (WebM).

Type: Bool


SimpleTags

The MKV simple tags.

Type: Property


ReservedCueSpace

Specifies number of bytes to reserve for Cues at the beginning of file.

If there is not enough space, the Cues will be written at the end of the video.

Note: Value must be greater than 9 bytes. Default Value is 0 bytes (Always puts Cues in back of video).

Type: Int32


Open QuickTime Movie [omov]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


SuppressEditList

Sets a value indicating whether the edit list should be suppressed.

Type: Bool


MdatAlignment

Sets the ‘mdat’ chunk alignment.

Type: long long


UserData

Named property collection of raw user data.

This property can be set on the media properties for each track and on the container writer itself.

Type: CProperties


FreeSize

Sets the size of the ‘free’ box following the ‘moov’ box.

Type: long long


MoovRate

Sets the rate (in seconds) at which the ‘moov’ box is updated.

If this property is non-zero the value determines the rate (in seconds) at which the ‘moov’ is rewritten.

If ‘fast’ start is enabled and there is sufficient free space the ‘moov’ box is updated in place. Otherwise the current ‘mdat’ box is closed, the previous ‘moov’ box is invalidated (overwritten by a ‘skip’ box) and a new ‘moov’ box is written at the current file position.

Type: Int


TrimAudio

Sets a value indicating whether the audio tracks are trimmed to the video track duration.

Type: Bool


MdatExtendedSize

Sets a value indicating whether the ‘mdat’ chunk should have an extended size.

Type: Bool


PrecisionWidth

Sets the video track header width. Does not reflect actual size of video, only display resolution.

Type: UInt32


FastStart

Sets a value indicating whether the ‘moov’ box should precede the ‘mdat’ box.

If this property is true and there is sufficent free space the ‘moov’ box will be written before the ‘mdat’ box. Otherwise the ‘moov’ will be written after the ‘mdat’ box.

Type: Bool


AncillaryDataType

Indicates the presence and data type of the caption track.

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

Type: Four


TimeCodeSource

Indicates the time code source

Type: utf8[]


PrecisionHeight

Sets the video track header height. Does not reflect actual size of video, only display resolution.

Type: UInt32


ReferenceMovieAlias

Selects the type of alias to use for reference movies.

Type: ReferenceMovieAliasType


AllowAnnexB

Sets ability of the writer to allow annex B ‘h264’ style samples

Type: Bool


SuppressBitRate

Prevents the writer from emitting a ‘btrt’ atom

Type: Bool


CompressorName

Sets the description in the sample description table to the compressor name.

Type: String


TimeCodeDropFrame

Indicates the time code drop framiness (timecode track description written before samples)

Type: Bool


TimeCodeMode

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

Type: TimeCodeModeType


ColorParameter

Indicates the color parameter type.

The colr atom typically contains the colorspace triplet (primaries, matrix coefficients, and transfer characteristics). Specifying ExtendedVideoParameterType for this property will also include the video range into the atom. It should be noted that since the extended form of the atom has rarely been seen there are concerns that if an application doesn’t recognize the extended form it won’t recognize any of the colorspace information.

Type: ColorParameterType


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


DataCompression

Sets the ‘cmov’ box data compression type.

If this property is non-zero the ‘moov’ box will be compressed into a ‘cmov’ box using the specified data compression format. Currently ‘zlib’ is the only supported data compression.

Type: Four


TimeCodeTimeScale

The timescale used for audio only timecode tracks.

Note: Only used if the TimeCodeMode is TimeCodeTrackEnabled and there are no video tracks.

Type: Int


TimeCodeFrameDuration

The frame duration used for audio only timecode tracks.

Note: Only used if the TimeCodeMode is TimeCodeTrackEnabled and there are no video tracks.

Type: Int


ClapMode

Enables or disables the ‘clap’ atom.

Type: Bool


TaptMode

Sets the ‘apmd’ user data box and enables or disables the ‘tapt’ atom.

If this property is non-zero then a ‘tapt’ box will be added to the track. Also, a user data item ‘apmd’ will be added to the ‘moov’ user data box. The value of this property should be one of: ‘clea’, ‘prod’, ‘clas’, or ‘enco’.

Type: Four


OmneonTimeCode

Sets the ‘Omud’ user data box.

If this property is non-zero then an ‘Omud’ box will be added to the movie. The timecode offset was provided to us by Omneon and we set it to the property value. A value of -1 indicates that the timecode should be the same as the first sample in the timecode track.

Type: UInt32


DelayWriteMovie

Indicates if we should delay writing the movie

Type: Bool


Enumerations:

ReferenceMovieAliasType

ReferenceMovieAliasType enumeration

Value Name Description
0 SelfContained None (‘url ' self contained data references)
1 Url Url (‘url ' data references)
2 Apple Apple (‘alis’ data references)
3 Omneon Omneon (‘alis’ data reference)

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].
8 TimeCodeTrackLast Time code should be last track
64 VideoTrackRef Make a reference from the video track.
128 StaticTimeCode Make a static timecode track (i.e. start time code only).

ColorParameterType

ColorParameter enumeration

Value Name Description
1852009571 VideoParameterType ‘nclc’ - Video colorspace triplet.
1852009592 ExtendedVideoParameterType ‘nclx’ - Video colorspace triplet plus video range.

Panasonic P2 [p2 ]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


DataSource

Identifies P2 data source.

Type: char[]


UserClipName

Identifies P2 user clip name.

Type: char[]


Panasonic P2 Internal [p2in]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


AvcPictureParameterSetFlag

PPS flag

Type: Byte


DataContainer

Identifies the data essence container.

Type: Four


FieldWrappingType

The MXF picture element wrapping type.

Type: FieldWrappingTypes


MinorVersion

Identifies the minor version.

Type: UInt16


AvcSequenceParameterSetFlag

SPS flag

Type: Byte


WriteConstraintsSubDescriptor

WriteConstraintsSubDescriptor flag

Type: Bool


DataSource

Identifies P2 data source.

Type: char[]


UserClipName

Identifies P2 user clip name.

Type: char[]


XmlClipMetadata

Panasonic P2 Ultra AVC XML metadata string

Note: Defaults to the default file name.

Type: string


Thumbnail

Panasonic P2 Ultra AVC BMP thumbnail content

Type: byte []


Enumerations:

FieldWrappingTypes

MXF picture element wrapping types.

Value Name Description
1227956256 Interlaced1FieldKlv I1: Frame wrapped (interlaced). A KLV contains 1 field AUs.
1176510496 Frame F: Frame wrapped (unspecified). A KLV contains 1 frame (or 2 field) AUs.
1228021792 InterlacedFrame I: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1126178848 Clip C: Clip wrapped. A KLV contains multiple AUs.
1228021792 Interlaced2FieldKlv I2: Frame wrapped (interlaced). A KLV contains 2 field AUs.
1177624608 Field F1: Field wrapped. A KLV contains 1 field AU.
1345396768 ProgressiveFrame P1:Frame wrapped (progressive). A KLV contains 1 frame AU.
1196380192 Group GOP: GOP wrapped. A KLV contains 1 one or more closed GOPs.

QuickTime Movie [mov ]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


SuppressEditList

Sets a value indicating whether the edit list should be suppressed.

Type: Bool


MdatAlignment

Sets the ‘mdat’ chunk alignment.

Type: long long


UserData

Named property collection of raw user data.

This property can be set on the media properties for each track and on the container writer itself.

Type: CProperties


FreeSize

Sets the size of the ‘free’ box following the ‘moov’ box.

Type: long long


MoovRate

Sets the rate (in seconds) at which the ‘moov’ box is updated.

If this property is non-zero the value determines the rate (in seconds) at which the ‘moov’ is rewritten.

If ‘fast’ start is enabled and there is sufficient free space the ‘moov’ box is updated in place. Otherwise the current ‘mdat’ box is closed, the previous ‘moov’ box is invalidated (overwritten by a ‘skip’ box) and a new ‘moov’ box is written at the current file position.

Type: Int


TrimAudio

Sets a value indicating whether the audio tracks are trimmed to the video track duration.

Type: Bool


MdatExtendedSize

Sets a value indicating whether the ‘mdat’ chunk should have an extended size.

Type: Bool


PrecisionWidth

Sets the video track header width. Does not reflect actual size of video, only display resolution.

Type: UInt32


FastStart

Sets a value indicating whether the ‘moov’ box should precede the ‘mdat’ box.

If this property is true and there is sufficent free space the ‘moov’ box will be written before the ‘mdat’ box. Otherwise the ‘moov’ will be written after the ‘mdat’ box.

Type: Bool


AncillaryDataType

Indicates the presence and data type of the caption track.

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

Type: Four


TimeCodeSource

Indicates the time code source

Type: utf8[]


PrecisionHeight

Sets the video track header height. Does not reflect actual size of video, only display resolution.

Type: UInt32


ReferenceMovieAlias

Selects the type of alias to use for reference movies.

Type: ReferenceMovieAliasType


AllowAnnexB

Sets ability of the writer to allow annex B ‘h264’ style samples

Type: Bool


SuppressBitRate

Prevents the writer from emitting a ‘btrt’ atom

Type: Bool


CompressorName

Sets the description in the sample description table to the compressor name.

Type: String


TimeCodeDropFrame

Indicates the time code drop framiness (timecode track description written before samples)

Type: Bool


TimeCodeMode

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

Type: TimeCodeModeType


ColorParameter

Indicates the color parameter type.

The colr atom typically contains the colorspace triplet (primaries, matrix coefficients, and transfer characteristics). Specifying ExtendedVideoParameterType for this property will also include the video range into the atom. It should be noted that since the extended form of the atom has rarely been seen there are concerns that if an application doesn’t recognize the extended form it won’t recognize any of the colorspace information.

Type: ColorParameterType


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


DataCompression

Sets the ‘cmov’ box data compression type.

If this property is non-zero the ‘moov’ box will be compressed into a ‘cmov’ box using the specified data compression format. Currently ‘zlib’ is the only supported data compression.

Type: Four


TimeCodeTimeScale

The timescale used for audio only timecode tracks.

Note: Only used if the TimeCodeMode is TimeCodeTrackEnabled and there are no video tracks.

Type: Int


TimeCodeFrameDuration

The frame duration used for audio only timecode tracks.

Note: Only used if the TimeCodeMode is TimeCodeTrackEnabled and there are no video tracks.

Type: Int


ClapMode

Enables or disables the ‘clap’ atom.

Type: Bool


TaptMode

Sets the ‘apmd’ user data box and enables or disables the ‘tapt’ atom.

If this property is non-zero then a ‘tapt’ box will be added to the track. Also, a user data item ‘apmd’ will be added to the ‘moov’ user data box. The value of this property should be one of: ‘clea’, ‘prod’, ‘clas’, or ‘enco’.

Type: Four


OmneonTimeCode

Sets the ‘Omud’ user data box.

If this property is non-zero then an ‘Omud’ box will be added to the movie. The timecode offset was provided to us by Omneon and we set it to the property value. A value of -1 indicates that the timecode should be the same as the first sample in the timecode track.

Type: UInt32


Enumerations:

ReferenceMovieAliasType

ReferenceMovieAliasType enumeration

Value Name Description
0 SelfContained None (‘url ' self contained data references)
1 Url Url (‘url ' data references)
2 Apple Apple (‘alis’ data references)
3 Omneon Omneon (‘alis’ data reference)

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].
8 TimeCodeTrackLast Time code should be last track
64 VideoTrackRef Make a reference from the video track.
128 StaticTimeCode Make a static timecode track (i.e. start time code only).

ColorParameterType

ColorParameter enumeration

Value Name Description
1852009571 VideoParameterType ‘nclc’ - Video colorspace triplet.
1852009592 ExtendedVideoParameterType ‘nclx’ - Video colorspace triplet plus video range.

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


Properties JSON format [prop]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


EmitLastSampleOnly

Discards all but the last sample.

Enabling this property will reduce the file size if only the last sample is necessary.

Type: Bool


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


DropFrame

Flag indicating drop frame timecodes.

Type: Bool


Subtitle Document [sdoc]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


Version

Check to see which Tifo version we have

Type: Uint32


FlushPeriod

Specified the maximum period (in ms) the writer should flush to disk

Type: Int


MaxFileSize

Specified the maximum filesize when operated as a circular file

Type: Int64


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


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]


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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.


XML Properties [xmlp]

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


IsRenamable

Specifies if this writer creates renamable streams

Type: Bool


CreateIndex

Specifies if this writer should create an index file.

Type: Bool


IndexFilePath

Specifies the name of the index file to create.

Note: Not all container writers support writing index files.

Type: String


ContainerFormat

The format in which to emit video samples.

Type: Int32


Template

The path template.

The path template specifies the naming pattern for files created by the writer. For example, a package may choose to use different names for video or audio files. Each element in the variant array should be of the form { ‘Name’ : type, ‘Path’ : path } where type is either ‘media’, ‘video’, ‘audio’, or ‘subtitle’ and path is the path template for the specified type.

The path can contain template tokens that will be replaced by the appropriate value (if applicable) to resolve the file name. These include:

  • Package Tokens:
  • package
  • session
  • kid
  • Container Tokens
  • segment
  • directory
  • init
  • container
  • playlist_name
  • uuid
  • title
  • extension
  • track
  • Media Tokens:
  • media
  • data
  • pid
  • format
  • video_format
  • audio_format
  • subtitle_format
  • language
  • LANGUAGE
  • language3
  • LANGUAGE3
  • region
  • REGION
  • region3
  • REGION3
  • bps
  • kbps
  • mbps
  • time
  • System Tokens
  • date
  • now
  • Video Tokens
  • width
  • height
  • Audio Tokens
  • channels
  • layout

The tokens should be bookended by ‘$’. For example, to set the video and audio file names for an Omneon reference movie one could set the path template to: \code [ { ‘Name’ : ‘video’, ‘Path’ : ‘$media$$track$.h264’ }, { ‘Name’ : ‘audio’, ‘Path’ : ‘$media$$track$.aac’ } ] \endcode

Type: Array of Properties.