Type Alias MessageEvents<P, S>

Type declaration

• authError: (reason: AuthErrorReason) => void

  Emitted when authentication fails

• authSuccess: () => void

  Emitted when authentication is successful

• bandwidthEstimationChanged: (estimation: bigint) => void

  Called every time the server estimates client's bandiwdth.

• componentAdded: (peer: Component) => void

  Called each time new peer joins the room.

• componentRemoved: (peer: Component) => void

  Called each time peer leaves the room.

• componentUpdated: (peer: Component) => void

  Called each time peer has its metadata updated.

• connectionError: (error: { event?: Event; message: string }) => void

  Called in case of errors related to multimedia session e.g. ICE connection.

• connectionStarted: () => void

  Emitted when connect method invoked

• disconnected: () => void

  Emitted when the connection is closed

• disconnectRequested: (event: Parameters<WebRTCEndpointEvents["disconnectRequested"]>[0]) => void

• joined: (peerId: string, peers: Peer<P, S>[], components: Component[]) => void

  Called when peer was accepted.

• joinError: (metadata: JoinErrorReason | unknown) => void

  Called when peer was not accepted

• localPeerMetadataChanged: (
      event: Parameters<WebRTCEndpointEvents["localEndpointMetadataChanged"]>[0],
  ) => void

• localTrackAdded: (event: Parameters<WebRTCEndpointEvents["localTrackAdded"]>[0]) => void

• localTrackBandwidthSet: (event: Parameters<WebRTCEndpointEvents["localTrackBandwidthSet"]>[0]) => void

• localTrackEncodingBandwidthSet: (
      event: Parameters<
          WebRTCEndpointEvents["localTrackEncodingBandwidthSet"],
      >[0],
  ) => void

• localTrackEncodingDisabled: (
      event: Parameters<WebRTCEndpointEvents["localTrackEncodingDisabled"]>[0],
  ) => void

• localTrackEncodingEnabled: (
      event: Parameters<WebRTCEndpointEvents["localTrackEncodingEnabled"]>[0],
  ) => void

• localTrackMetadataChanged: (
      event: Parameters<WebRTCEndpointEvents["localTrackMetadataChanged"]>[0],
  ) => void

• localTrackMuted: (event: Parameters<WebRTCEndpointEvents["localTrackMuted"]>[0]) => void

• localTrackRemoved: (event: Parameters<WebRTCEndpointEvents["localTrackRemoved"]>[0]) => void

• localTrackReplaced: (event: Parameters<WebRTCEndpointEvents["localTrackReplaced"]>[0]) => void

• localTrackUnmuted: (event: Parameters<WebRTCEndpointEvents["localTrackUnmuted"]>[0]) => void

• peerJoined: (peer: Peer<P, S>) => void

  Called each time new peer joins the room.

• peerLeft: (peer: Peer<P, S>) => void

  Called each time peer leaves the room.

• peerUpdated: (peer: Peer<P, S>) => void

  Called each time peer has its metadata updated.

• reconnected: () => void

  Emitted on successful reconnection

• reconnectionRetriesLimitReached: () => void

  Emitted when the maximum number of reconnection retries is reached

• reconnectionStarted: () => void

  Emitted when the process of reconnection starts

• socketClose: (event: CloseEvent) => void

  Emitted when the websocket connection is closed

• socketError: (event: Event) => void

  Emitted when occurs an error in the websocket connection

• socketOpen: (event: Event) => void

  Emitted when the websocket connection is opened

• targetTrackEncodingRequested: (
      event: Parameters<WebRTCEndpointEvents["targetTrackEncodingRequested"]>[0],
  ) => void

• trackAdded: (ctx: FishjamTrackContext) => void

  Called each time the peer which was already in the room, adds new track. Fields track and stream will be set to null. These fields will be set to non-null value in MessageEvents.trackReady

• trackReady: (ctx: FishjamTrackContext) => void

  Called when data in a new track arrives.

  This callback is always called after MessageEvents.trackAdded. It informs user that data related to the given track arrives and can be played or displayed.

• trackRemoved: (ctx: FishjamTrackContext) => void

  Called when some track will no longer be sent.

  It will also be called before MessageEvents.peerLeft for each track of this peer.

• tracksPriorityChanged: (
      enabledTracks: FishjamTrackContext[],
      disabledTracks: FishjamTrackContext[],
  ) => void

  Currently, this callback is only invoked when DisplayManager in RTC Engine is enabled and simulcast is disabled.

  Called when priority of video tracks have changed.

• trackUpdated: (ctx: FishjamTrackContext) => void

  Called each time peer has its track metadata updated.