Interface ConnectionPublisher

Role が "sendonly" または "sendrecv" の場合に Sora との WebRTC 接続を扱うクラス

interface ConnectionPublisher {
    authMetadata: JSONType;
    bundleId: string | null;
    channelId: string;
    clientId: string | null;
    connectedSignalingUrl: string;
    connectionId: string | null;
    constraints: unknown;
    contactSignalingUrl: string;
    debug: boolean;
    encodings: RTCRtpEncodingParameters[];
    metadata: JSONType | undefined;
    options: ConnectionOptions;
    pc: RTCPeerConnection | null;
    remoteConnectionIds: string[];
    role: string;
    rpcMethods: string[];
    sessionId: string | null;
    signalingUrlCandidates: string | string[];
    simulcast: boolean;
    spotlight: boolean;
    stream: MediaStream | null;
    get audio(): boolean;
    get datachannels(): DataChannelConfiguration[];
    get signalingUrl(): string | string[];
    get video(): boolean;
    connect(stream: MediaStream): Promise<MediaStream>;
    disconnect(): Promise<void>;
    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
                )
                | ((event: SignalingSwitchedMessage) => void)
                | ((event: SignalingNotifyConnectionCreated) => void)
                | ((title: string, message: JSONType) => void)
                | (() => void)
                | ((event: TimelineEvent) => void)
                | ((event: SignalingEvent) => void)
                | ((event: DataChannelMessageEvent) => void)
                | ((event: DataChannelEvent) => void),
    >(
        kind: T,
        callback: U,
    ): void;
    removeAudioTrack(stream: MediaStream): Promise<void>;
    removeVideoTrack(stream: MediaStream): Promise<void>;
    replaceAudioTrack(
        stream: MediaStream,
        audioTrack: MediaStreamTrack,
    ): Promise<void>;
    replaceVideoTrack(
        stream: MediaStream,
        videoTrack: MediaStreamTrack,
    ): Promise<void>;
    rpc<T = unknown>(
        method: string,
        params?: unknown[] | Record<string, unknown>,
        options?: RPCOptions,
    ): Promise<T>;
    sendMessage(label: string, message: Uint8Array): Promise<void>;
    stopAudioTrack(stream: MediaStream): Promise<void>;
    stopVideoTrack(stream: MediaStream): Promise<void>;
}

Hierarchy (View Summary)

ConnectionBase
- ConnectionPublisher

Properties

authMetadata

authMetadata: JSONType

type offer に含まれる認証 metadata

bundleId

bundleId: string | null

バンドルID

channelId

channelId: string

チャネルID

clientId

clientId: string | null

クライアントID

connectedSignalingUrl

connectedSignalingUrl: string

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

connectionId

connectionId: string | null

コネクションID

constraints

constraints: unknown

PeerConnection に渡す configuration

contactSignalingUrl

contactSignalingUrl: string

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

debug

debug: boolean

デバッグフラグ

encodings

encodings: RTCRtpEncodingParameters[]

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

metadata

metadata: JSONType | undefined

メタデータ

options

options: ConnectionOptions

接続オプション

pc

pc: RTCPeerConnection | null

PeerConnection インスタンス

remoteConnectionIds

remoteConnectionIds: string[]

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

role

role: string

ロール(sendonly | sendrecv | recvonly)

rpcMethods

rpcMethods: string[]

type offer に含まれる RPC メソッドのリスト

sessionId

sessionId: string | null

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

signalingUrlCandidates

signalingUrlCandidates: string | string[]

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

simulcast

simulcast: boolean

サイマルキャスト

spotlight

spotlight: boolean

スポットライト

stream

stream: MediaStream | null

メディアストリーム

Accessors

audio

get audio(): boolean
audio が有効かどうか

Returns boolean
Inherited from ConnectionBase.audio

datachannels

get datachannels(): DataChannelConfiguration[]
DataChannel メッセージング用の DataChannel 情報のリスト

Returns DataChannelConfiguration[]
Inherited from ConnectionBase.datachannels

signalingUrl

get signalingUrl(): string | string[]
シグナリングに使用する URL

Returns string | string[]
Deprecated
Inherited from ConnectionBase.signalingUrl

video

get video(): boolean
video が有効かどうか

Returns boolean
Inherited from ConnectionBase.video

Methods

connect

connect(stream: MediaStream): Promise<MediaStream>

Sora へ接続するメソッド

Parameters

stream: MediaStream
メディアストリーム

Returns Promise<MediaStream>

Example

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

disconnect

disconnect(): Promise<void>
切断処理をするメソッド

Returns Promise<void>
Example
```
await sendrecv.disconnect();
```
Inherited from ConnectionBase.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)
            | ((event: SignalingSwitchedMessage) => void)
            | ((event: SignalingNotifyConnectionCreated) => 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)
      | ((event: SignalingSwitchedMessage) => void)
      | ((event: SignalingNotifyConnectionCreated) => 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, switched, connected, log, timeout, timeline, signaling, message, datachannel)
- callback: U
  コールバック関数
Returns void
Example
```
const sendrecv = connection.sendrecv("sora");
sendrecv.on("track", (event) => {
  // callback 処理
});
```
Inherited from ConnectionBase.on

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 を削除します
Inherited from ConnectionBase.removeAudioTrack

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 を削除します
Inherited from ConnectionBase.removeVideoTrack

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 をセットします
Inherited from ConnectionBase.replaceAudioTrack

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 をセットします
Inherited from ConnectionBase.replaceVideoTrack

rpc

rpc<T = unknown>(
    method: string,
    params?: unknown[] | Record<string, unknown>,
    options?: RPCOptions,
): Promise<T>
RPC DataChannel でリクエストを送信するメソッド
Type Parameters
- T = unknown
Parameters
- method: string
  RPC メソッド名
- Optionalparams: unknown[] | Record<string, unknown>
  RPC パラメーター
- Optionaloptions: RPCOptions
  RPC オプション
Returns Promise<T>
Promise - レスポンスの result
Example
```
const result = await connection.rpc('simulcast.change_sending_encodings', { rids: ['r0', 'r1'] });
```
Inherited from ConnectionBase.rpc

sendMessage

sendMessage(label: string, message: Uint8Array): Promise<void>
DataChannel を使用してメッセージを送信するメソッド
Parameters
- label: string
  メッセージを送信する DataChannel のラベル
- message: Uint8Array
  Uint8Array
Returns Promise<void>
Inherited from ConnectionBase.sendMessage

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 を削除します
Inherited from ConnectionBase.stopAudioTrack

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 を削除します
Inherited from ConnectionBase.stopVideoTrack

Interface ConnectionPublisher

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

authMetadata

bundleId

channelId

clientId

connectedSignalingUrl

connectionId

constraints

contactSignalingUrl

debug

encodings

metadata

options

pc

remoteConnectionIds

role

rpcMethods

sessionId

signalingUrlCandidates

simulcast

spotlight

stream

Accessors

audio

Returns boolean

datachannels

Returns DataChannelConfiguration[]

signalingUrl

Returns string | string[]

Deprecated

video

Returns boolean

Methods

connect

Parameters

Returns Promise<MediaStream>

Example

disconnect

Returns Promise<void>

Example

on

Type Parameters

Parameters

Returns void

Example

removeAudioTrack

Parameters

Returns Promise<void>

Example

Remarks

removeVideoTrack

Parameters

Returns Promise<void>

Example

Remarks

replaceAudioTrack

Parameters

Returns Promise<void>

Example

Remarks

replaceVideoTrack

Parameters

Returns Promise<void>

Example

Remarks

rpc

Type Parameters

Parameters

Returns Promise<T>

Example

sendMessage

Parameters

Returns Promise<void>

stopAudioTrack