Connection

Role、 ChannelId、 Metadata、Options を指定することにより Sora に接続するための SendRecv オブジェクトを作成します。


sendonly()

SendRecv オブジェクトを配信専用(sendonly)で生成します。 SendRecv オブジェクトの connect を使用することにより接続が開始されます。

引数

channelId: string

チャネルID

metadata: JSON

メタデータ. 初期値は null

options: object

オプション. 初期値は {}

戻り値

SendRecv オブジェクト

const connection = Sora.connection('ws://192.0.2.100:5000/signaling', true);
const sendonly = connection.sendonly("sora");

sendrecv()

SendRecv オブジェクトを送受信用(sendrecv)で生成します。 SendRecv オブジェクトの connect を使用することにより接続が開始されます。

sendrecv を使用する場合は options に必ず multistream: true を設定する必要があります。

引数

channelId: string

チャネルID

metadata: JSON

メタデータ. 初期値は null

options: object

オプション. 初期値は {}

戻り値

SendRecv オブジェクト

const connection = Sora.connection('ws://192.0.2.100:5000/signaling', true);
const options = {
  multistream: true,
};
const sendrecv = connection.sendrecv("sora", null, options);

recvonly()

SendRecv オブジェクトを受信専用(recvonly)で生成します。 SendRecv オブジェクトの connect を使用することにより接続が開始されます。

引数

channelId: string

チャネルID

metadata: JSON

メタデータ. 初期値は null

options: object

オプション. 初期値は {}

戻り値

SendRecv オブジェクト

const connection = Sora.connection('ws://192.0.2.100:5000/signaling', true);
const recvonly = connection.recvonly("sora");

Options

SendRecv オブジェクトのオプション一覧

type Options = {
  audio?: boolean;
  audioBitRate?: number;
  audioCodecType?: "OPUS";
  clientId?: string;
  connectionTimeout?: number;
  dataChannelSignaling?: boolean;
  disconnectWaitTimeout?: number;
  e2ee?: boolean;
  ignoreDisconnectWebSocket?: boolean;
  multistream?: boolean;
  signalingNotifyMetadata?: JSONType;
  simulcast?: boolean;
  simulcastRid?: "r0" | "r1" | "r2";
  spotlight?: boolean | number;
  spotlightFocusRid?: "r0" | "r1" | "r2" | "none";
  spotlightUnfocusRid?: "r0" | "r1" | "r2" | "none";
  spotlightNumber?: number;
  timeout?: number; // deprecated option
  video?: boolean;
  videoBitRate?: number;
  videoCodecType?: "VP8" | "VP9" | "AV1" | "H264" | "H265";
};

audio

音声の配信(視聴)を行うかどうかを設定します。

sendonly()sendrecv() の場合は音声を配信するかどうかが設定できます。 recvonly() の場合は音声を受信するかどうかが設定できます。

参考: 視聴メディアの選択

タイプ

boolean

デフォルト値

true


audioCodecType

音声コーデックタイプを設定します。

参考: オーディオコーデック指定

タイプ

"OPUS"


audioBitRate

音声ビットレートを設定します。

参考: オーディオビットレート指定

タイプ

number


clientId

クライアントIDを設定します。

クライアントIDはクライアント側で接続に対して指定可能なラベルです。255 バイトまでの文字列を指定可能です。

参考: コネクション ID の導入

タイプ

string


connectionTimeout

接続完了までのタイムアウト時間(ms)を設定します。

接続開始から接続完了(RTCPeerConnection.connectionState が connected になる) までに設定された時間を経過した場合、接続処理を中断します。

タイプ

number

デフォルト値

60000


dataChannelSignaling

signaling に DataChannel を使用するかどうかを設定します。

タイプ

boolean


disconnectWaitTimeout

切断完了までのタイムアウト時間(ms)を設定します。

SDK の切断処理は WebSocket / DataChannel / PeerConnection それぞれの state が close になるまで待機します。 切断処理が発生した場合に切断開始から切断完了までに設定された時間を経過した場合、WebSocket / DataChannel / PeerConnection を破棄し切断処理を終了します。

タイプ

number

デフォルト値

3000


e2ee

E2EE を使用するかどうかを設定します。

参考: E2EE 機能

タイプ

boolean


ignoreDisconnectWebSocket

signaling DataChannel 有効時に WebSocket を切断するかどうかを設定します。

タイプ

boolean


multistream

マルチストリームを使用するかどうかを設定します。

参考: マルチストリーム機能

タイプ

boolean

デフォルト値

false


simulcast

サイマルキャストを使用するかどうかを設定します。

参考: サイマルキャスト機能

タイプ

boolean

デフォルト値

false


simulcastRid

サイマルキャスト利用時の RID 初期値を設定します。

参考: サイマルキャスト機能 映像の種類のデフォルト

タイプ

"r0" | "r1" | "r2"


signalingNotifyMetadata

シグナリング通知メタデータを設定します。

参考: シグナリング通知メタデータ

タイプ

JSON


spotlight

スポットライトを使用するかどうかを設定します(スポットライトレガシー使用時にはアクティブな配信数)

参考: スポットライト機能

参考: スポットライトレガシー機能(廃止予定)

タイプ

boolean | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

デフォルト値

false


spotlightNumber

スポットライトのアクティブな配信数を設定します。

参考: スポットライト機能 アクティブな配信数

タイプ

1 | 2 | 3 | 4 | 5 | 6 | 7 | 8


spotlightFocusRid

スポットライトフォーカス時に受信する映像の RID を設定します。

参考: スポットライト機能 スポットライト利用時の映像の種類のデフォルト

タイプ

"r0" | "r1" | "r2" | "none"


spotlightUnfocusRid

スポットライトアンフォーカス時に受信する映像の RID を設定します。

参考: スポットライト機能 スポットライト利用時の映像の種類のデフォルト

タイプ

"r0" | "r1" | "r2" | "none"


timeout

警告

[非推奨] connectionTimeout を使用してください

タイプ

number


video

映像の配信(視聴)を行うかどうかを設定します。

sendonly()sendrecv() の場合は映像を配信するかどうかが設定できます。 recvonly() の場合は映像を受信するかどうかが設定できます。

参考: 視聴メディアの選択

タイプ

boolean

デフォルト値

true


videoCodecType

映像コーデックタイプを設定します。

参考: ビデオコーデック指定

タイプ

"VP8" | "VP9" | "AV1" | "H264" | "H265"


videoBitRate

映像ビットレートを設定します。

参考: ビデオビットレート指定

タイプ

number

© Copyright 2021, Shiguredo Inc. Created using Sphinx 4.1.1