Class SubtitleQueue

Index

Methods

create push cancel cancelAll clear isShowing count visible list forEach tick dispose

Methods

`Static`create

create(opts?: SubtitleQueueOptions): SubtitleQueue
Parameters
- opts: SubtitleQueueOptions = {}
Returns SubtitleQueue
- Defined in runtime/subtitle-queue.ts:113

push

push(spec: SubtitleSpec): boolean
Parameters
- spec: SubtitleSpec
Returns boolean
- Defined in runtime/subtitle-queue.ts:117

cancel

cancel(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/subtitle-queue.ts:154

cancelAll

cancelAll(): void
Returns void
- Defined in runtime/subtitle-queue.ts:167

clear

clear(): void
Returns void
- Defined in runtime/subtitle-queue.ts:180

isShowing

isShowing(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/subtitle-queue.ts:182

count

count(): number
Returns number
- Defined in runtime/subtitle-queue.ts:186

visible

visible(maxLines?: number): SubtitleSnapshot[]
Parameters
- OptionalmaxLines: number
Returns SubtitleSnapshot[]
- Defined in runtime/subtitle-queue.ts:189

list

list(): SubtitleSnapshot[]
Returns SubtitleSnapshot[]
- Defined in runtime/subtitle-queue.ts:204

forEach

forEach(cb: (line: SubtitleSnapshot) => void): void
Parameters
- cb: (line: SubtitleSnapshot) => void
Returns void
- Defined in runtime/subtitle-queue.ts:212

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/subtitle-queue.ts:221

dispose

dispose(): void
Returns void
- Defined in runtime/subtitle-queue.ts:270