Skip to content

Commit

Permalink
feat(apidocs): simplify SideLoadedSubtitleTrack definition
Browse files Browse the repository at this point in the history
  • Loading branch information
rolandkakonyi committed Oct 10, 2023
1 parent 1411673 commit c73c55d
Showing 1 changed file with 1 addition and 29 deletions.
30 changes: 1 addition & 29 deletions src/subtitleTrack.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,37 +49,9 @@ export interface SubtitleTrack {
* A subtitle track that can be added to `SourceConfig.subtitleTracks`.
*
*/
export interface SideLoadedSubtitleTrack {
/**
* The URL to the timed file, e.g. WebVTT file.
*/
export interface SideLoadedSubtitleTrack extends SubtitleTrack {
url: string;
/**
* The label for this track.
*/
label: string;
/**
* The IETF BCP 47 language tag associated with this track, e.g. `pt`, `en`, `es` etc.
*/
language: string;
/**
* The unique identifier for this track. If no value is provided, a random UUIDv4 will be generated for it.
*/
identifier?: string;
/**
* Specifies the file format to be used by this track.
*/
format: SubtitleFormat;
/**
* If set to true, this track would be considered as default. Default is `false`.
*/
isDefault?: boolean;
/**
* Tells if a subtitle track is forced. If set to `true` it means that the player should automatically
* select and switch this subtitle according to the selected audio language. Forced subtitles do
* not appear in `Player.getAvailableSubtitles`.
*
* Default is `false`.
*/
isForced?: boolean;
}

0 comments on commit c73c55d

Please sign in to comment.