Class TextTrack
java.lang.Object
com.azure.resourcemanager.mediaservices.models.TrackBase
com.azure.resourcemanager.mediaservices.models.TextTrack
Represents a text track in an asset. A text track is usually used for sparse data related to the audio or video
tracks.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the displayName property: The display name of the text track on a video player.fileName()
Get the fileName property: The file name to the source file.Get the hlsSettings property: The HLS specific setting for the text track.Get the languageCode property: The RFC5646 language code for the text track.Get the playerVisibility property: When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client.void
validate()
Validates the instance.withDisplayName
(String displayName) Set the displayName property: The display name of the text track on a video player.withFileName
(String fileName) Set the fileName property: The file name to the source file.withHlsSettings
(HlsSettings hlsSettings) Set the hlsSettings property: The HLS specific setting for the text track.withPlayerVisibility
(Visibility playerVisibility) Set the playerVisibility property: When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client.
-
Constructor Details
-
TextTrack
public TextTrack()Creates an instance of TextTrack class.
-
-
Method Details
-
fileName
Get the fileName property: The file name to the source file. This file is located in the storage container of the asset.- Returns:
- the fileName value.
-
withFileName
Set the fileName property: The file name to the source file. This file is located in the storage container of the asset.- Parameters:
fileName
- the fileName value to set.- Returns:
- the TextTrack object itself.
-
displayName
Get the displayName property: The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.- Returns:
- the displayName value.
-
withDisplayName
Set the displayName property: The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.- Parameters:
displayName
- the displayName value to set.- Returns:
- the TextTrack object itself.
-
languageCode
Get the languageCode property: The RFC5646 language code for the text track.- Returns:
- the languageCode value.
-
playerVisibility
Get the playerVisibility property: 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".- Returns:
- the playerVisibility value.
-
withPlayerVisibility
Set the playerVisibility property: 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".- Parameters:
playerVisibility
- the playerVisibility value to set.- Returns:
- the TextTrack object itself.
-
hlsSettings
Get the hlsSettings property: The HLS specific setting for the text track.- Returns:
- the hlsSettings value.
-
withHlsSettings
Set the hlsSettings property: The HLS specific setting for the text track.- Parameters:
hlsSettings
- the hlsSettings value to set.- Returns:
- the TextTrack object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classTrackBase
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-