Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Callbacks

Callbacks that has to be implemented by user.

Hierarchy

  • Callbacks

Index

Properties

Optional onConnectionError

onConnectionError: (message: string) => void

Type declaration

    • (message: string): void
    • Called in case of errors related to multimedia session e.g. ICE connection.

      Parameters

      • message: string

      Returns void

Optional onJoinError

onJoinError: (metadata: any) => void

Type declaration

    • (metadata: any): void
    • Called when peer was not accepted. Triggered by join

      Parameters

      • metadata: any

        Passthru for client application to communicate further actions to frontend

      Returns void

Optional onJoinSuccess

onJoinSuccess: (peerId: string, peersInRoom: [Peer]) => void

Type declaration

    • (peerId: string, peersInRoom: [Peer]): void
    • Called when peer was accepted. Triggered by join

      Parameters

      • peerId: string
      • peersInRoom: [Peer]

      Returns void

Optional onPeerJoined

onPeerJoined: (peer: Peer) => void

Type declaration

    • (peer: Peer): void
    • Called each time new peer joins the room.

      Parameters

      Returns void

Optional onPeerLeft

onPeerLeft: (peer: Peer) => void

Type declaration

    • (peer: Peer): void
    • Called each time peer leaves the room.

      Parameters

      Returns void

onSendMediaEvent

onSendMediaEvent: (mediaEvent: string) => void

Type declaration

    • (mediaEvent: string): void
    • Called each time MembraneWebRTC need to send some data to the server.

      Parameters

      • mediaEvent: string

      Returns void

Optional onTrackAdded

onTrackAdded: (ctx: TrackContext) => void

Type declaration

    • Called when a new track appears.

      This callback is always called after a new peer joins so after calling onPeerJoined.

      Parameters

      • ctx: TrackContext

        Contains information about the new track.

      Returns void

Optional onTrackRemoved

onTrackRemoved: (ctx: TrackContext) => void

Type declaration

    • Called when some track will no longer be sent.

      At this moment there is only one situation in which this callback is invoked i.e. when peer leaves the room. In such scenario, this callback will be invoked for each track this peer was sending and then onPeerLeft will be called.

      Parameters

      Returns void

Generated using TypeDoc