Class Subtitles

Index

Constructors

Methods

addTextBlock clone fitDurationToBlocks getDuration getId getLanguage getTextBlocks removeTextBlock serialize setLanguage setTextBlocks updateSubtitlesClips updateTextBlock validateTextBlocks deserialize

Constructors

constructor

new Subtitles(options?: SubtitlesOptions): Subtitles
Parameters
- Optionaloptions: SubtitlesOptions
Returns Subtitles
- Defined in src/modules/library/Subtitles.ts:42

Methods

addTextBlock

addTextBlock(textBlock: TextBlock, index?: number): void
Parameters
- textBlock: TextBlock
- Optionalindex: number
Returns void
- Defined in src/modules/library/Subtitles.ts:67

clone

clone(): Subtitles
Returns Subtitles
- Defined in src/modules/library/Subtitles.ts:212

fitDurationToBlocks

fitDurationToBlocks(): void
Returns void
- Defined in src/modules/library/Subtitles.ts:143

getDuration

getDuration(): number
Returns number
- Defined in src/modules/library/Subtitles.ts:59

getId

getId(): string
Returns string
- Defined in src/modules/library/Subtitles.ts:51

getLanguage

getLanguage(): string
Returns string
- Defined in src/modules/library/Subtitles.ts:55

getTextBlocks

getTextBlocks(): readonly TextBlock[]
Returns readonly TextBlock[]
- Defined in src/modules/library/Subtitles.ts:63

removeTextBlock

removeTextBlock(index: number): void
Parameters
- index: number
Returns void
- Defined in src/modules/library/Subtitles.ts:84

serialize

serialize(): {
    duration: number;
    id: string;
    language: string;
    textBlocks: { duration: number; text: string; time: number }[];
}
Returns {
    duration: number;
    id: string;
    language: string;
    textBlocks: { duration: number; text: string; time: number }[];
}
- Defined in src/modules/library/Subtitles.ts:197

setLanguage

setLanguage(language: string): void
Parameters
- language: string
Returns void
- Defined in src/modules/library/Subtitles.ts:133

setTextBlocks

setTextBlocks(textBlocks: TextBlock[]): void
Parameters
- textBlocks: TextBlock[]
Returns void
- Defined in src/modules/library/Subtitles.ts:99

updateSubtitlesClips

updateSubtitlesClips(): void
Returns void
- Defined in src/modules/library/Subtitles.ts:186

updateTextBlock

updateTextBlock(index: number, textBlock: Partial<TextBlock>): void
Parameters
- index: number
- textBlock: Partial<TextBlock>
Returns void
- Defined in src/modules/library/Subtitles.ts:113

validateTextBlocks

validateTextBlocks(): void
Returns void
- Defined in src/modules/library/Subtitles.ts:151

`Static`deserialize

deserialize(data: object): Subtitles
Parameters
- data: object
Returns Subtitles
- Defined in src/modules/library/Subtitles.ts:201