Class SubtitleEditor

Used to edit and add to an ISubtitleCollection.

Hierarchy

SubtitleEditor

Index

Constructors

Properties

Methods

_getLanguage addLanguage addSubtitle addSubtitles export setSubtitle

Constructors

constructor

new SubtitleEditor(collection?): SubtitleEditor
Parameters
- collection: ISubtitleCollection[] = []
Returns SubtitleEditor
- Defined in configuration/api/subtitle-editor.ts:13

Properties

`Private` collection

collection: ISubtitleCollection[] = []

Methods

`Private` _getLanguage

_getLanguage(languageCode): undefined | ISubtitleCollection
Parameters
- languageCode: string
Returns undefined | ISubtitleCollection
- Defined in configuration/api/subtitle-editor.ts:15

addLanguage

addLanguage(languageCode): SubtitleEditor
Adds a new ISubtitleCollection for the given languageCode.

If collections already exist for existing language codes then a duplicate of these collections is created with the same duration info but all of the text is left empty.
Parameters
- languageCode: `${Lowercase<string>}-${Uppercase<string>}`
Returns SubtitleEditor
- Defined in configuration/api/subtitle-editor.ts:29

addSubtitle

addSubtitle(languageCode, subtitle): SubtitleEditor
Parameters
- languageCode: `${Lowercase<string>}-${Uppercase<string>}`
- subtitle: ISubtitle
Returns SubtitleEditor
- Defined in configuration/api/subtitle-editor.ts:52

addSubtitles

addSubtitles(duration, subtitles): SubtitleEditor
Parameters
- duration: IStrictDuration
- subtitles: Record<`${Lowercase<string>}-${Uppercase<string>}`, string>
Returns SubtitleEditor
- Defined in configuration/api/subtitle-editor.ts:61

export

export(): ISubtitleCollection[]
Returns ISubtitleCollection[]
- Defined in configuration/api/subtitle-editor.ts:95

setSubtitle

setSubtitle(languageCode, subtitle): SubtitleEditor
Parameters
- languageCode: `${Lowercase<string>}-${Uppercase<string>}`
- subtitle: ISubtitle
Returns SubtitleEditor
- Defined in configuration/api/subtitle-editor.ts:75

Generated using TypeDoc