Class ConnectionMessaging

messaging_only 専用のクラス 利用する場合は Sora 側での設定が必要 Role は "sendonly" に固定される

Hierarchy (View Summary)

Constructors

constructor

Properties

authMetadata bundleId channelId clientId connectedSignalingUrl connectionId constraints contactSignalingUrl debug encodings metadata options pc remoteConnectionIds role sessionId signalingUrlCandidates simulcast spotlight stream

Accessors

audio datachannels signalingUrl video

Methods

connect disconnect on removeAudioTrack removeVideoTrack replaceAudioTrack replaceVideoTrack sendMessage stopAudioTrack stopVideoTrack

Constructors

constructor

Properties

authMetadata

authMetadata: JSONType

type offer に含まれる認証 metadata

bundleId

bundleId: null | string

バンドルID

channelId

channelId: string

チャネルID

clientId

clientId: null | string

クライアントID

connectedSignalingUrl

connectedSignalingUrl: string

WS シグナリングで type offer メッセージを受信したシグナリング URL

connectionId

connectionId: null | string

コネクションID

constraints

constraints: unknown

PeerConnection に渡す configuration

contactSignalingUrl

contactSignalingUrl: string

WS シグナリングで最初に type connect を送信したシグナリング URL

debug

debug: boolean

デバッグフラグ

encodings

encodings: RTCRtpEncodingParameters[]

サイマルキャストで使用する RTCRtpEncodingParameters のリスト

metadata

metadata: undefined | JSONType

メタデータ

options

options: ConnectionOptions

接続オプション

pc

pc: null | RTCPeerConnection

PeerConnection インスタンス

remoteConnectionIds

remoteConnectionIds: string[]

リモートコネクションIDのリスト

role

role: string

ロール(sendonly | sendrecv | recvonly)

sessionId

sessionId: null | string

type offer に含まれるセッションID。Sora 2023.2.0 以降に接続した時に含まれる

signalingUrlCandidates

signalingUrlCandidates: string | string[]

シグナリングに使用する URL 候補

simulcast

simulcast: boolean

サイマルキャスト

spotlight

spotlight: boolean

スポットライト

stream

stream: null | MediaStream

メディアストリーム

Accessors

audio

  • get audio(): boolean

  • audio が有効かどうか

    Returns boolean

datachannels

signalingUrl

  • get signalingUrl(): string | string[]

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

    Returns string | string[]

    Deprecated

video

  • get video(): boolean

  • video が有効かどうか

    Returns boolean

Methods

connect

  • connect(): Promise<void>

  • Sora へ接続するメソッド、legacyStream は利用できない

    Returns Promise<void>

    Example

    const messaging = connection.messaging("sora");
    await messaging.connect();

disconnect

  • disconnect(): Promise<void>

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

    Returns Promise<void>

    Example

    await sendrecv.disconnect();

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

    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 処理
    });

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);

    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);

    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]);

    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]);

    Remarks

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

sendMessage

  • sendMessage(label: string, message: Uint8Array<ArrayBufferLike>): Promise<void>

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

    Parameters

    • label: string

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

    • message: Uint8Array<ArrayBufferLike>

      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);

    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);

    Remarks

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods