import SubtitleTrackController from 'hls.js/src/controller/subtitle-track-controller.ts'SubtitleTrackController
Extends:
Constructor Summary
| Public Constructor | ||
| public |
|
|
Member Summary
| Public Members | ||
| public |
media: * |
|
| public |
|
|
| public |
|
|
| public |
|
|
| public get |
get index of the selected subtitle track (index in subtitle track lists) * |
|
| public set |
select a subtitle track, based on its index in subtitle track lists* |
|
| public get |
get alternate subtitle tracks list from playlist * |
|
| public |
|
|
| public |
|
|
| public |
tracks: *[] |
|
| public |
|
|
Method Summary
| Public Methods | ||
| public |
destroy() |
|
| public |
loadPlaylist(hlsUrlParameters: HlsUrlParameters) |
|
| public |
onManifestParsed(event: undefined, data: ManifestParsedData) |
|
| public |
onMediaAttached(event: undefined, data: MediaAttachedData) |
|
| public |
|
|
| public |
onSubtitleTrackLoaded(event: undefined, data: TrackLoadedData) |
|
| Private Methods | ||
| private |
|
|
| private |
|
|
| private |
_setSubtitleTrackInternal(newId: number) This method is responsible for validating the subtitle index and periodically reloading if live. |
|
| private |
_toggleTrackModes(newId: number) Disables the old subtitleTrack and sets current mode on the next subtitleTrack. |
|
| private |
|
|
Public Constructors
public constructor() source
Public Members
public media: * source
public queuedDefaultTrack: * source
public get subtitleTrack: number source
get index of the selected subtitle track (index in subtitle track lists) *
public set subtitleTrack: number source
select a subtitle track, based on its index in subtitle track lists*
public trackChangeListener: * source
public tracks: *[] source
Public Methods
public destroy() source
public loadPlaylist(hlsUrlParameters: HlsUrlParameters) source
Params:
| Name | Type | Attribute | Description |
| hlsUrlParameters | HlsUrlParameters |
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 |
Private Methods
private _onTextTracksChanged() source
private _registerListeners() source
private _setSubtitleTrackInternal(newId: number) 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 |
private _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 |