Interface SourceLabelingConfig

An object with callback functions to provide labels for audio tracks, qualities and subtitle tracks.

interface SourceLabelingConfig {
    qualities?: (quality: QualityMetadata) => string;
    subtitles?: (subtitle: SubtitleTrack) => string;
    tracks?: (track: TrackMetadata) => string;
}

Index

Properties

qualities? subtitles? tracks?

Properties

`Optional`qualities

qualities?: (quality: QualityMetadata) => string

A function that generates a label for a quality, usually a video quality.

Type Declaration

- (quality: QualityMetadata): string
- Parameters
  - quality: QualityMetadata
    Object with metadata about the quality for which the label should be generated.
  Returns string

`Optional`subtitles

subtitles?: (subtitle: SubtitleTrack) => string

A function that generates a label for a subtitle.

Type Declaration

- (subtitle: SubtitleTrack): string
- Parameters
  - subtitle: SubtitleTrack
    The subtitle for which the label should be generated.
  Returns string

`Optional`tracks

tracks?: (track: TrackMetadata) => string

A function that generates a label for a track, usually an audio track.

Type Declaration

- (track: TrackMetadata): string
- Parameters
  - track: TrackMetadata
    Object with metadata about the track for which the label should be generated. The id field is populated when used for HLS, the mimeType when used for DASH.
  Returns string