Class ConnectionPublisher

constructor

• new ConnectionPublisher(signalingUrlCandidates, role, channelId, metadata, options, debug): ConnectionPublisher

• Parameters

  • signalingUrlCandidates: string | string[]

  • role: string

  • channelId: string

  • metadata: JSONType

  • options: ConnectionOptions

  • debug: boolean

  Returns ConnectionPublisher

authMetadata

channelId

clientId

connectedSignalingUrl

connectionId

constraints

contactSignalingUrl

debug

encodings

metadata

options

pc

remoteConnectionIds

role

sessionId

signalingUrlCandidates

stream

audio

• get audio(): boolean

• audio が有効かどうか

  Returns boolean

datachannels

• get datachannels(): DataChannelConfiguration[]

• DataChannel メッセージング用の DataChannel 情報のリスト

  Returns DataChannelConfiguration[]

e2eeRemoteFingerprints

• get e2eeRemoteFingerprints(): undefined | Record<string, string>

• E2EE のリモートのフィンガープリントリスト

  Returns undefined | Record<string, string>

e2eeSelfFingerprint

• get e2eeSelfFingerprint(): undefined | string

• E2EE の自分のフィンガープリント

  Returns undefined | string

signalingUrl

• get signalingUrl(): string | string[]

• シグナリングに使用する URL

  Returns string | string[]

  Deprecated

video

• get video(): boolean

• video が有効かどうか

  Returns boolean

disconnect

• disconnect(): Promise<void>

• 切断処理をするメソッド

  Returns Promise<void>

  Example

  await sendrecv.disconnect();
  Copy

on

• on<T, U>(kind, callback): void

• SendRecv Object で発火するイベントのコールバックを設定するメソッド

  Type Parameters

  • T extends keyof Callbacks

  • U extends ((event) => void) | ((event, transportType) => void) | ((event) => void) | ((event) => void) | ((event) => void) | ((event) => void) | ((event, transportType) => void) | ((title, message) => void) | (() => void) | ((event) => void) | ((event) => void) | ((event) => void) | ((event) => void)

  Parameters

  • kind: T

    イベントの種類(disconnect, push, track, removetrack, notify, log, timeout, timeline, signaling, message, datachannel)

  • callback: U

    コールバック関数

  Returns void

  Example

  const sendrecv = connection.sendrecv("sora");
  sendrecv.on("track", (event) => {
    // callback 処理
  });
  Copy

  Remarks

  addstream イベントは非推奨です. track イベントを使用してください

  removestream イベントは非推奨です. removetrack イベントを使用してください

replaceAudioTrack

• replaceAudioTrack(stream, audioTrack): Promise<void>

• audio track を入れ替えするメソッド

  Parameters

  • stream: MediaStream

    audio track を削除する MediaStream

  • audioTrack: MediaStreamTrack

    新しい audio track

  Returns Promise<void>

  Example

  const sendrecv = connection.sendrecv("sora");
  const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
  await sendrecv.connect(mediaStream);
  
  const replacedMediaStream = await navigator.mediaDevices.getUserMedia({audio: true});
  await sendrecv.replaceAudioTrack(mediaStream, replacedMediaStream.getAudioTracks()[0]);
  Copy

  Remarks

  stream の audio track を停止後、新しい audio track をセットします

replaceVideoTrack

• replaceVideoTrack(stream, videoTrack): Promise<void>

• video track を入れ替えするメソッド

  Parameters

  • stream: MediaStream

    video track を削除する MediaStream

  • videoTrack: MediaStreamTrack

    新しい video track

  Returns Promise<void>

  Example

  const sendrecv = connection.sendrecv("sora");
  const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
  await sendrecv.connect(mediaStream);
  
  const replacedMediaStream = await navigator.mediaDevices.getUserMedia({video: true});
  await sendrecv.replaceVideoTrack(mediaStream, replacedMediaStream.getVideoTracks()[0]);
  Copy

  Remarks

  stream の video track を停止後、新しい video track をセットします

sendMessage

• sendMessage(label, message): void

• DataChannel を使用してメッセージを送信するメソッド

  Parameters

  • label: string

    メッセージを送信する DataChannel のラベル

  • message: Uint8Array

    Uint8Array

  Returns void

stopAudioTrack

• stopAudioTrack(stream): Promise<void>

• audio track を停止するメソッド

  Parameters

  • stream: MediaStream

    audio track を削除する MediaStream

  Returns Promise<void>

  Example

  const sendrecv = connection.sendrecv("sora");
  const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
  await sendrecv.connect(mediaStream);
  
  sendrecv.stopAudioTrack(mediaStream);
  Copy

  Remarks

  stream の audio track を停止後、PeerConnection の senders から対象の sender を削除します

stopVideoTrack

• stopVideoTrack(stream): Promise<void>

• video track を停止するメソッド

  Parameters

  • stream: MediaStream

    video track を削除する MediaStream

  Returns Promise<void>

  Example

  const sendrecv = connection.sendrecv("sora");
  const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
  await sendrecv.connect(mediaStream);
  
  sendrecv.stopVideoTrack(mediaStream);
  Copy

  Remarks

  stream の video track を停止後、PeerConnection の senders から対象の sender を削除します