Listening to Subscriber Events

The Subscriber(s) included in the SDK are event emitters that have a basic API for subscribing and unsubscribing to events either by name or by wildcard.

To subscribe to all events from a subscriber:

function handleSubscriberEvent (event) {
  // The name of the event:
  const { type } = event
  // The dispatching publisher instance:
  const { subscriber } = event
  // Optional data releated to the event (not available on all events):
  const { data } = event
}

var subscriber = new RTCSubscriber()
subscriber.on('*', handleSubscriberEvent)

The * type assignment is considered a "Wildcard" subscription - all events being issued by the subscriber instance will invoke the assign event handler.

To unsubscribe to all events from a subscriber after assinging an event handler:

subscriber.off('*', handleSubscriberEvent)

The following sections of this document describe the event types that can also be listened to directly, instead of using the * wildcard.