Class Subsrt

constructor

• new Subsrt(): Subsrt

  Returns Subsrt

format

build

• build(captions: Caption[], options?: BuildOptions): string

  Builds a subtitle content.

  Parameters

  • captions: Caption[]

    The captions to build

  • options: BuildOptions = ...

    The building options

  Returns string

  The built subtitle content

  Throws

  TypeError If the format cannot be determined

  Throws

  TypeError If the format is not supported

  Throws

  TypeError If the handler does not support 'build' op

convert

• convert(content: string, _options?: string | ConvertOptions): string

  Converts subtitle format.

  Parameters

  • content: string

    The subtitle content

  • _options: string | ConvertOptions = ...

  Returns string

  The converted subtitle content

detect

• detect(content: string): string

  Detects a subtitle format from the content.

  Parameters

  • content: string

    The subtitle content

  Returns string

  The detected format

list

• list(): string[]

  Gets a list of supported subtitle formats.

  Returns string[]

  The list of supported subtitle formats

parse

• parse(content: string, options?: ParseOptions): Caption[]

  Parses a subtitle content.

  Parameters

  • content: string

    The subtitle content

  • options: ParseOptions = ...

    The parsing options

  Returns Caption[]

  The parsed captions

  Throws

  TypeError If the format cannot be determined

  Throws

  TypeError If the format is not supported

  Throws

  TypeError If the handler does not support 'parse' op

resync

• resync(
      captions: Caption[],
      options?: number | ResyncOptions | ResyncFunction,
  ): Caption[]

  Shifts the time of the captions.

  Parameters

  • captions: Caption[]

    The captions to resync

  • options: number | ResyncOptions | ResyncFunction = ...

    The resync options

  Returns Caption[]

  The resynced captions

  Throws

  TypeError If the 'options' argument is not defined