Class ProxyConnectionService

constructor

• new ProxyConnectionService(
      options?: {
          convertVideoToDesktop?: boolean;
          jitsiConnection?: JitsiConnection;
          onRemoteStream: Function;
          onSendMessage: Function;
          pcConfig?: any;
      },
  ): ProxyConnectionService

  Initializes a new {@code ProxyConnectionService} instance.

  Parameters

  • options: {
        convertVideoToDesktop?: boolean;
        jitsiConnection?: JitsiConnection;
        onRemoteStream: Function;
        onSendMessage: Function;
        pcConfig?: any;
    } = {}

    Values to initialize the instance with.

    • OptionalconvertVideoToDesktop?: boolean

      Whether or not proxied video should be returned as a desktop stream. Defaults to false.

    • OptionaljitsiConnection?: JitsiConnection

      The {@code JitsiConnection} which will be used to fetch TURN credentials for the P2P connection.

    • onRemoteStream: Function

      Callback to invoke when a remote video stream has been received and converted to a {@code JitsiLocakTrack}. The {@code JitsiLocakTrack} will be passed in.

    • onSendMessage: Function

      Callback to invoke when a message has to be sent (signaled) out. The arguments passed in are the jid to send the message to and the message.

    • OptionalpcConfig?: any

      The {@code RTCConfiguration} to use for the WebRTC peer connection.

  Returns ProxyConnectionService

_options

_peerConnection

processMessage

• processMessage(message: { data: { iq: string }; from: string }): void

  Parses a message object regarding a proxy connection to create a new proxy connection or update and existing connection.

  Parameters

  • message: { data: { iq: string }; from: string }

    A message object regarding establishing or updating a proxy connection.

    • data: { iq: string }

      An object containing additional message details.

      • iq: string

        The stringified iq which explains how and what to update regarding the proxy connection.

    • from: string

      The message sender's full jid. Used for sending replies.

  Returns void

start

• start(peerJid: string, localTracks?: JitsiLocalTrack[]): void

  Instantiates and initiates a proxy peer connection.

  Parameters

  • peerJid: string

    The jid of the remote client that should receive messages.
  • localTracks: JitsiLocalTrack[] = []

    Initial media tracks to send through to the peer.

  Returns void

stop

• stop(): void

  Terminates any active proxy peer connection.

  Returns void