Data - MediaDataDoc

The MediaDataDoc document is a data document that contains the meta data and source information for a media data file.

Field Data Type Required Default Description
id String Yes - A unique identifier that is referenced by all other documents see section Unique Id Generation.
configDocId String Yes - The unique identifier (id) of the ConfigDoc document that this document is associated with.
name String Yes - A free form value to describe the unique name of the media element.
description String No - A free for value for the description of the media.
offset 64-bit Long No - A 64-bit Long value specifying the offset in nanoseconds from the start of the media file, at which the related configDoc data begins. The value can be both positive and negative. The timestamp represents the number of nanoseconds since the reference time of midnight, 1st January 1970.
offsetConfig 64-bit ULong No - A 64-bit Long value specifying the offset into the config, at which this media file starts to play. The value only be positive. The timestamp represents the number of nanoseconds since the reference time of midnight, 1st January 1970.
source String Yes - The source file name (including extension) for the media file.
mediaType Fixed String Yes Audio A fixed type description of the media. Valid options are: Audio, Video, Image, VideoStream, AudioStream.
tags Array [String, String] No - An array of key/pair free form string values. Used to store meta data related to the data stored by this document.
type Fixed String Fixed MediaDataDoc The fixed value is always set to MediaDataDoc.