TextTrack interface

  • Reference
Package:
@azure/arm-mediaservices

Represents a text track in an asset. A text track is usually used for sparse data related to the audio or video tracks.

Extends
TrackBase

Properties

displayName

The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.
fileName

The file name to the source file. This file is located in the storage container of the asset.
hlsSettings

The HLS specific setting for the text track.
languageCode

The RFC5646 language code for the text track. NOTE: This property will not be serialized. It can only be populated by the server.
odataType

Polymorphic discriminator, which specifies the different types this object can be
playerVisibility

When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible".

Property Details

displayName

The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.

displayName?: string

Property Value

string

fileName

The file name to the source file. This file is located in the storage container of the asset.

fileName?: string

Property Value

string

hlsSettings

The HLS specific setting for the text track.

hlsSettings?: HlsSettings

Property Value

HlsSettings

languageCode

The RFC5646 language code for the text track. NOTE: This property will not be serialized. It can only be populated by the server.

languageCode?: string

Property Value

string

odataType

Polymorphic discriminator, which specifies the different types this object can be

odataType: "#Microsoft.Media.TextTrack"

Property Value

"#Microsoft.Media.TextTrack"

playerVisibility

When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible".

playerVisibility?: string

Property Value

string