Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@tvkitchen/appliance-caption-srt-generator

tvkitchen8LGPL-3.00.3.0

Converts a caption stream into srt format.

mpeg, mpeg-ts, cc, closed captions, CCExtractor, HD HomeRun, tv, srt, transcript, text, tvkitchen

readme

TV Kitchen Caption SRT Generator Appliance

inputTypes: TEXT.ATOM, SEGMENT.START
outputTypes: TEXT.SRT

The Caption SRT Generator appliance ingests a stream of captions and converts them into the SubRip file format.

Timestamps are determined by the position value of the TEXT.ATOM payloads processed.

Configuration Options

The appliance takes in the following configuration values:

  • includeCounter (boolean): determines if the output includes a counter as part of the text of each payload.

Examples

includeCounter: true (default)

Payload {
  data: "2\n00:00:19,886 --> 00:00:20,787\n>>> WE'RE BACK ON WHAT HAS BEEN\n",
  type: 'TEXT.SRT',
  createdAt: '2021-02-18T20:17:50.583Z',
  timestamp: '',
  duration: 901,
  position: 19886
}

includeCounter: false

Payload {
  data: "00:00:19,886 --> 00:00:20,787\n>>> WE'RE BACK ON WHAT HAS BEEN\n",
  type: 'TEXT.SRT',
  createdAt: '2021-02-18T20:17:50.583Z',
  timestamp: '',
  duration: 901,
  position: 19886
}

Dependencies

This appliance has no external dependencies.

About the TV Kitchen

TV Kitchen is a project of Bad Idea Factory. Learn more at the TV Kitchen project site.

changelog

Changelog for @tvkitchen/appliance-caption-srt-generator

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.3.0 - 2021-05-13

Changed

  • Update @tvkitchen/appliance-core to version 0.9.0.

0.2.0 - 2021-05-13

Changed

  • Update @tvkitchen/base-classes to version 2.0.0-alpha.1.
  • Update @tvkitchen/appliance-core to version 0.7.0.
  • Update the referenced base dependencies.

Added

  • Support for responding to SEGMENT.START payloads.

0.1.0 - 2021-02-19

Added

  • Initial implementation of the CaptionSrtGenerator appliance.