Class ConnectionPublisher

authMetadata

bundleId

channelId

clientId

connectedSignalingUrl

connectionId

constraints

contactSignalingUrl

debug

encodings

metadata

options

pc

remoteConnectionIds

role

sessionId

signalingUrlCandidates

simulcast

spotlight

stream

audio

• get audio(): boolean

  audio が有効かどうか

  Returns boolean

datachannels

• get datachannels(): DataChannelConfiguration[]

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

  Returns DataChannelConfiguration[]

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 extends keyof Callbacks,
      U extends
      
              | ((event: SoraCloseEvent) => void)
              | ((event: SignalingPushMessage, transportType: TransportType) => void)
              | ((event: RTCTrackEvent) => void)
              | ((event: MediaStreamTrackEvent) => void)
              | ((event: SignalingNotifyMessage, transportType: TransportType) => void)
              | ((title: string, message: JSONType) => void)
              | (() => void)
              | ((event: TimelineEvent) => void)
              | ((event: SignalingEvent) => void)
              | ((event: DataChannelMessageEvent) => void)
              | ((event: DataChannelEvent) => void),
  >(
      kind: T,
      callback: U,
  ): void

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

  Type Parameters

  • T extends keyof Callbacks
  • U extends
        | ((event: SoraCloseEvent) => void)
        | ((event: SignalingPushMessage, transportType: TransportType) => void)
        | ((event: RTCTrackEvent) => void)
        | ((event: MediaStreamTrackEvent) => void)
        | ((event: SignalingNotifyMessage, transportType: TransportType) => void)
        | ((title: string, message: JSONType) => void)
        | (() => void)
        | ((event: TimelineEvent) => void)
        | ((event: SignalingEvent) => void)
        | ((event: DataChannelMessageEvent) => void)
        | ((event: DataChannelEvent) => 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

removeAudioTrack

• removeAudioTrack(stream: MediaStream): 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.removeAudioTrack(mediaStream);
  Copy

  Remarks

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

removeVideoTrack

• removeVideoTrack(stream: MediaStream): 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.removeVideoTrack(mediaStream);
  Copy

  Remarks

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

replaceAudioTrack

• replaceAudioTrack(
      stream: MediaStream,
      audioTrack: MediaStreamTrack,
  ): 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: MediaStream,
      videoTrack: MediaStreamTrack,
  ): 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: string, message: Uint8Array): Promise<void>

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

  Parameters

  • label: string

    メッセージを送信する DataChannel のラベル
  • message: Uint8Array

    Uint8Array

  Returns Promise<void>

stopAudioTrack

• stopAudioTrack(stream: MediaStream): Promise<void>

  audio track を削除するメソッド

  Parameters

  • stream: MediaStream

    audio track を削除する MediaStream

  Returns Promise<void>

  Deprecated

  この関数は非推奨です。代わりに removeAudioTrack を使用してください

  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: MediaStream): Promise<void>

  video track を削除するメソッド

  Parameters

  • stream: MediaStream

    video track を停止する MediaStream

  Returns Promise<void>

  Deprecated

  この関数は非推奨です。代わりに removeVideoTrack を使用してください

  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 を削除します