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

Package detail

@tvkitchen/appliance-video-segment-generator

tvkitchen8LGPL-3.00.3.0

Identifies segments based on payload timestamps.

mpeg, mpeg-ts, video, segmentation, tv programs, processing, live, tv, tvkitchen

readme

TV Kitchen Video Segment Generator Appliance

inputTypes: STREAM.CONTAINER
outputTypes: SEGMENT.START

The Video Segment Generator Appliance will take a stream of payloads and identify new segment starts according to the timestamp of those payloads.

Configuration Options

The appliance takes in the following configuration values:

  • interval (milliseconds): the number of milliseconds that the clock will track (e.g. 60000 would be a clock that can track up to one minute). Default is INTERVALS.INFINITE.

  • startingAt (ISO String): what is the absolute time of the beginning of the first interval. Default is the ISO string value for the time of instantiation.

  • segments: array of objects and / or numbers specifying segment start times. If the value is an object the offset attribute is used to convey the segment start offset. Default is [0].

    • offset (milliseconds): the period offset that demarks the start of the segment.
    • data (json): the data to associate with the new segment.

Exposed Constants

  • PERIOD.INFINITE (0)
  • PERIOD.MINUTE (60000)
  • PERIOD.HOUR (3600000)
  • PERIOD.DAY (86400000)
  • PERIOD.WEEK (604800000)

Dependencies

None.

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-video-segment-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 - 2022-03-04

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 to support origin payloads instead of timestamp.
  • Change origin appliance parameter to startingAt.
  • Update @tvkitchen/appliance-core to version 0.7.0.

Fixed

  • Fixed a bug where non-zero originPositions would result in incorrect periodPositions.

0.1.1 - 2021-04-07

Changed

  • Update the required version of appliance-core to 0.6.1

0.1.0 - 2021-04-07 (DEPRECATED)

Added

  • Initial implementation of the VideoSegmentGenerator appliance.