Class Subtitles

Index

Constructors

Methods

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

Constructors

constructor

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

Methods

addTextBlock

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

clone

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

fitDurationToBlocks

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

getDuration

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

getId

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

getLanguage

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

getTextBlocks

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

removeTextBlock

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

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;
    }[];
}
- duration: number
- id: string
- language: string
- textBlocks: {
      duration: number;
      text: string;
      time: number;
  }[]
- Defined in src/modules/library/Subtitles.ts:142

setDuration

setDuration(duration): void
Parameters
- duration: number
Returns void
- Defined in src/modules/library/Subtitles.ts:95

setLanguage

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

setTextBlocks

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

updateTextBlock

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

validateTextBlocks

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

`Static` deserialize

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

Generated using TypeDoc