Interface SourceLabelingConfig

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

Hierarchy

SourceLabelingConfig

Index

Properties

qualities? subtitles? tracks?

Properties

`Optional` qualities

qualities?: ((quality) => string)

Type declaration

- (quality): string
- A function that generates a label for a quality, usually a video quality.
  Parameters
  - quality: QualityMetadata
    
    Object with metadata about the quality for which the label should be generated.
  Returns string

`Optional` subtitles

subtitles?: ((subtitle) => string)

Type declaration

- (subtitle): string
- A function that generates a label for a subtitle.
  Parameters
  - subtitle: SubtitleTrack
    
    The subtitle for which the label should be generated.
  Returns string

`Optional` tracks

tracks?: ((track) => string)

Type declaration

- (track): string
- A function that generates a label for a track, usually an audio track.
  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

Generated using TypeDoc