StreamSwitchHardSettings interface

Settings for the Hard Stream Switch see: NorskControl.streamSwitchHard()

Signature:

export interface StreamSwitchHardSettings<Pins extends string> extends ProcessorNodeSettings<StreamSwitchHardNode<Pins>>

Extends: ProcessorNodeSettings<StreamSwitchHardNode<Pins>>

Properties

Property	Type	Description
activeSource	Pins	The currently active source to display on the output
maxQueueMs?	number	(Optional) Maximum duration to hold any stream in the case that one or more are running behind. In the case the late stream is delayed rather than having a large gap, this will result in discarded input frames.
onInboundContextChange?	(allStreams: Map<Pins, StreamMetadata[]>) ⇒ Promise<void>	(Optional) Callback to be called when inbound context changes on some input; presence of an input means that media has arrived and is ready to switch immediately
onSwitchError?	(message: string, inputPin?: Pins) ⇒ void	(Optional) Callback which will be called if a switch request cannot be fulfilled
outputSource	string	the source name to give the output of this switch operation

Property

Type

Description

activeSource

Pins

The currently active source to display on the output

maxQueueMs?

number

(Optional) Maximum duration to hold any stream in the case that one or more are running behind. In the case the late stream is delayed rather than having a large gap, this will result in discarded input frames.

onInboundContextChange?

(allStreams: Map<Pins, StreamMetadata[]>) ⇒ Promise<void>

(Optional) Callback to be called when inbound context changes on some input; presence of an input means that media has arrived and is ready to switch immediately

onSwitchError?

(message: string, inputPin?: Pins) ⇒ void

(Optional) Callback which will be called if a switch request cannot be fulfilled

outputSource

string

the source name to give the output of this switch operation