Skip to main content

createMediaSignals

function createMediaSignals<K>(more, scope): Pick<Required<MediaSignals>, SignalKeys>;

Create and return all required and optional (if specified with more), signals for media to work

Type Parameters

Type Parameter
K extends | "onAddTrack" | "onDevicesChanged" | "onMediaTrackMuted" | "onMediaTrackResumed" | "onMediaTrackStopped" | "onMediaTrackSuspended" | "onRemoveTrack" | "onStatusChanged" | "onUpdatingAudio" | "onUpdatingVideo"

Parameters

ParameterTypeDefault valueDescription
moreK[]undefinedKeys from MediaSignalsOptional,
scopestring''any scope prefix for the generated signal name,

Returns

Pick<Required<MediaSignals>, SignalKeys>

See

  • MediaSignalsOptional
  • Signal

The following signals created by default

  • 'onMediaChanged',
  • 'onVAD',
  • REQUIRED_SIGNAL_KEYS