• Public
  • Public/Protected
  • All

Interface LivePipelineProperties

Package version

Live pipeline properties.


  • LivePipelineProperties



Optional description

description: undefined | string

An optional description of the live pipeline.

Optional parameters

parameters: ParameterDefinition[]

List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.

Optional state

Current pipeline state (read-only).

Optional topologyName

topologyName: undefined | string

The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.

Generated using TypeDoc