Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 4.98 KB

Track.md

File metadata and controls

68 lines (45 loc) · 4.98 KB

Track

Properties

Name Type Description Notes
id String Unique identifier for the Track [optional]
type TypeEnum The type of track [optional]
duration Double The duration in seconds of the track media. This parameter is not set for `text` type tracks. This field is optional and may not be set. The top level `duration` field of an asset will always be set. [optional]
maxWidth Long The maximum width in pixels available for the track. Only set for the `video` type track. [optional]
maxHeight Long The maximum height in pixels available for the track. Only set for the `video` type track. [optional]
maxFrameRate Double The maximum frame rate available for the track. Only set for the `video` type track. This field may return `-1` if the frame rate of the input cannot be reliably determined. [optional]
maxChannels Long The maximum number of audio channels the track supports. Only set for the `audio` type track. [optional]
maxChannelLayout String Only set for the `audio` type track. [optional]
textType TextTypeEnum This parameter is only set for `text` type tracks. [optional]
textSource TextSourceEnum The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_vod`: Tracks generated by automatic speech recognition on an on-demand asset. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. [optional]
languageCode String The language code value represents BCP 47 specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is only set for `text` and `audio` track types. [optional]
name String The name of the track containing a human-readable description. The HLS manifest will associate a subtitle `text` or `audio` track with this value. For example, the value should be "English" for a subtitle text track for the `language_code` value of `en-US`. This parameter is only set for `text` and `audio` track types. [optional]
closedCaptions Boolean Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set tracks where `type` is `text` and `text_type` is `subtitles`. [optional]
passthrough String Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is only set for `text` type tracks. Max 255 characters. [optional]
status StatusEnum The status of the track. This parameter is only set for `text` type tracks. [optional]
primary Boolean For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted. [optional]

Enum: TypeEnum

Name Value
VIDEO "video"
AUDIO "audio"
TEXT "text"

Enum: TextTypeEnum

Name Value
SUBTITLES "subtitles"

Enum: TextSourceEnum

Name Value
UPLOADED "uploaded"
EMBEDDED "embedded"
GENERATED_LIVE "generated_live"
GENERATED_LIVE_FINAL "generated_live_final"
GENERATED_VOD "generated_vod"

Enum: StatusEnum

Name Value
PREPARING "preparing"
READY "ready"
ERRORED "errored"
DELETED "deleted"