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

Optional onPeerUpdated

onPeerUpdated: (peer: Peer) => void

Type declaration

    • (peer: Peer): void
    • Called each time peer has its metadata updated.

      Parameters

      Returns void

Optional onRemoved

onRemoved: (reason: string) => void

Type declaration

    • (reason: string): void
    • Called every time a local peer is removed by the server.

      Parameters

      • reason: string

      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 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 onTrackReady

      Parameters

      Returns void

Optional onTrackEncodingChanged

onTrackEncodingChanged: (peerId: string, trackId: string, encoding: TrackEncoding) => void

Type declaration

    • (peerId: string, trackId: string, encoding: TrackEncoding): void
    • Called each time track encoding has changed.

      Track encoding can change in the following cases:

      • when user requested a change
      • when there was a significant change in network bandwidth and client library is no longer able to receive given encoding
      • when sender stopped sending some encoding (because of bandwidth change)

      Parameters

      • peerId: string

        id of peer that owns track

      • trackId: string

        id of track that changed encoding

      • encoding: TrackEncoding

        new encoding

      Returns void

Optional onTrackReady

onTrackReady: (ctx: TrackContext) => void

Type declaration

    • Called when data in a new track arrives.

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

      Parameters

      Returns void

Optional onTrackRemoved

onTrackRemoved: (ctx: TrackContext) => void

Type declaration

    • Called when some track will no longer be sent.

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

      Parameters

      Returns void

Optional onTrackUpdated

onTrackUpdated: (ctx: TrackContext) => void

Type declaration

    • Called each time peer has its track metadata updated.

      Parameters

      Returns void

Optional onTracksPriorityChanged

onTracksPriorityChanged: (enabledTracks: TrackContext[], disabledTracks: TrackContext[]) => void

Type declaration

    • Called when priority of video tracks have changed.

      Parameters

      • enabledTracks: TrackContext[]

        list of tracks which will be sent to client from SFU

      • disabledTracks: TrackContext[]

        list of tracks which will not be sent to client from SFU

      Returns void

Generated using TypeDoc