import SubtitleTrackController from 'hls.js/src/controller/subtitle-track-controller.ts'

public class | source

SubtitleTrackController

Extends:

src/controller/base-playlist-controller.js~BasePlaylistController → SubtitleTrackController

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	asyncPollTrackChange: *
public	groupId: *
public	media: *
public	queuedDefaultTrack: number
public	retryCount: number
public	selectDefaultTrack: boolean
public get	subtitleDisplay: boolean
public set	subtitleDisplay: boolean
public	subtitlePollingInterval: number
public get	subtitleTrack: number get/set index of the selected subtitle track (based on index in subtitle track lists) *
public set	subtitleTrack: number
public get	subtitleTracks: * get alternate subtitle tracks list from playlist *
public	trackChangeListener: *
public	trackId: number
public	tracks: *
public	tracksInGroup: *
public	useTextTrackPolling: boolean

Private Members
private	_subtitleDisplay: boolean

Method Summary

Public Methods
public	destroy()
public	findTrackId(name: string): number
public	loadPlaylist(hlsUrlParameters: HlsUrlParameters)
public	onError(event: undefined, data: ErrorData)
public	onLevelLoading(event: undefined, data: LevelLoadingData)
public	onLevelSwitching(event: undefined, data: LevelSwitchingData)
public	onManifestLoading()
public	onManifestParsed(event: undefined, data: ManifestParsedData)
public	onMediaAttached(event: undefined, data: MediaAttachedData)
public	onMediaDetaching()
public	onSubtitleTrackLoaded(event: undefined, data: TrackLoadedData)
public	onTextTracksChanged()
public	pollTrackChange(timeout: number)
public	registerListeners()
public	setSubtitleTrack(newId: number, lastTrack: undefined) This method is responsible for validating the subtitle index and periodically reloading if live.
public	switchLevel(levelIndex: number)
public	toggleTrackModes(newId: number) Disables the old subtitleTrack and sets current mode on the next subtitleTrack.
public	unregisterListeners()

Public Constructors

public constructor() source

Public Members

public asyncPollTrackChange: * source

public groupId: * source

public media: * source

public queuedDefaultTrack: number source

public retryCount: number source

public selectDefaultTrack: boolean source

public get subtitleDisplay: boolean source

public set subtitleDisplay: boolean source

public subtitlePollingInterval: number source

public get subtitleTrack: number source

get/set index of the selected subtitle track (based on index in subtitle track lists) *

public set subtitleTrack: number source

public get subtitleTracks: * source

get alternate subtitle tracks list from playlist *

public trackChangeListener: * source

public trackId: number source

public tracks: * source

public tracksInGroup: * source

public useTextTrackPolling: boolean source

Private Members

private _subtitleDisplay: boolean source

Public Methods

public destroy() source

public findTrackId(name: string): number source

Params:

Name	Type	Attribute	Description
name	string

Return:

number

public loadPlaylist(hlsUrlParameters: HlsUrlParameters) source

Params:

Name	Type	Attribute	Description
hlsUrlParameters	HlsUrlParameters

public onError(event: undefined, data: ErrorData) source

Params:

Name	Type	Attribute	Description
event	undefined
data	ErrorData

public onLevelLoading(event: undefined, data: LevelLoadingData) source

Params:

Name	Type	Attribute	Description
event	undefined
data	LevelLoadingData

public onLevelSwitching(event: undefined, data: LevelSwitchingData) source

Params:

Name	Type	Attribute	Description
event	undefined
data	LevelSwitchingData

public onManifestLoading() source

public onManifestParsed(event: undefined, data: ManifestParsedData) source

Params:

Name	Type	Attribute	Description
event	undefined
data	ManifestParsedData

public onMediaAttached(event: undefined, data: MediaAttachedData) source

Params:

Name	Type	Attribute	Description
event	undefined
data	MediaAttachedData

public onMediaDetaching() source

public onSubtitleTrackLoaded(event: undefined, data: TrackLoadedData) source

Params:

Name	Type	Attribute	Description
event	undefined
data	TrackLoadedData

public onTextTracksChanged() source

public pollTrackChange(timeout: number) source

Params:

Name	Type	Attribute	Description
timeout	number

public registerListeners() source

public setSubtitleTrack(newId: number, lastTrack: undefined) source

This method is responsible for validating the subtitle index and periodically reloading if live. Dispatches the SUBTITLE_TRACK_SWITCH event, which instructs the subtitle-stream-controller to load the selected track.

Params:

Name	Type	Attribute	Description
newId	number
lastTrack	undefined

public switchLevel(levelIndex: number) source

Params:

Name	Type	Attribute	Description
levelIndex	number

public toggleTrackModes(newId: number) source

Disables the old subtitleTrack and sets current mode on the next subtitleTrack. This operates on the DOM textTracks. A value of -1 will disable all subtitle tracks.

Params:

Name	Type	Attribute	Description
newId	number

SubtitleTrackController

Extends:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor() source

Public Members

public asyncPollTrackChange: * source

public groupId: * source

public media: * source

public queuedDefaultTrack: number source

public retryCount: number source

public selectDefaultTrack: boolean source

public get subtitleDisplay: boolean source

public set subtitleDisplay: boolean source

public subtitlePollingInterval: number source

public get subtitleTrack: number source

public set subtitleTrack: number source

public get subtitleTracks: * source

public trackChangeListener: * source

public trackId: number source

public tracks: * source

public tracksInGroup: * source

public useTextTrackPolling: boolean source

Private Members

private _subtitleDisplay: boolean source

Public Methods

public destroy() source

public findTrackId(name: string): number source

Params:

Return:

public loadPlaylist(hlsUrlParameters: HlsUrlParameters) source

Params:

public onError(event: undefined, data: ErrorData) source

Params:

public onLevelLoading(event: undefined, data: LevelLoadingData) source

Params:

public onLevelSwitching(event: undefined, data: LevelSwitchingData) source

Params:

public onManifestLoading() source

public onManifestParsed(event: undefined, data: ManifestParsedData) source

Params:

public onMediaAttached(event: undefined, data: MediaAttachedData) source

Params:

public onMediaDetaching() source

public onSubtitleTrackLoaded(event: undefined, data: TrackLoadedData) source

Params:

public onTextTracksChanged() source

public pollTrackChange(timeout: number) source

Params:

public registerListeners() source

public setSubtitleTrack(newId: number, lastTrack: undefined) source

Params:

public switchLevel(levelIndex: number) source

Params:

public toggleTrackModes(newId: number) source

Params:

public unregisterListeners() source