Class SubtitleEditor

Used to edit and add to an ISubtitleCollection.

Index

Constructors

Methods

addLanguage addSubtitle addSubtitles export setSubtitle

Constructors

constructor

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

Methods

addLanguage

addLanguage(
languageCode: `${Lowercase<string>}-${Uppercase<string>}`,
): 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: `${Lowercase<string>}-${Uppercase<string>}`,
subtitle: ISubtitle,
): SubtitleEditor
Add a single subtitle line that is associated with the given languageCode
Parameters
- languageCode: `${Lowercase<string>}-${Uppercase<string>}`
- subtitle: ISubtitle
Returns SubtitleEditor
- Defined in configuration/api/subtitle-editor.ts:60

addSubtitles

addSubtitles(
duration: IStrictDuration,
subtitles: Record<TLanguageCode, string>,
): SubtitleEditor
Parameters
- duration: IStrictDuration
- subtitles: Record<TLanguageCode, string>
Returns SubtitleEditor
- Defined in configuration/api/subtitle-editor.ts:69

export

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

setSubtitle

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