Skip to main content

createPCSignals

function createPCSignals<K>(more, scope): Pick<Signals, SignalKeys>;

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

Type Parameters

Type Parameter
K extends "onReceiveIceCandidate" | keyof PeerConnectionSignals

Parameters

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

Returns

Pick<Signals, SignalKeys>

See

  • PCOptionalsSignals
  • Signal

The following signals created by default 'onOfferRequired', 'onReceiveAnswer', 'onReceiveOffer', 'onOffer', 'onAnswer', 'onError',

  • REQUIRED_SIGNAL_KEYS