API リファレンス

Sora

Sora JS SDK メインオブジェクトです。

SoraConnection

SoraConnection オブジェクトを生成します。 SoraConnection オブジェクトを使って配信者/受信者を作成します。

connection(url, debug=false)

SoraConnection オブジェクトを生成します。

url: String

Sora サーバの URL

debug: Boolean

デバッグ 有効/無効 フラグ

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

Version

sora-js-sdk のバージョンを返します

version()

sora-js-sdk のバージョンを返します

Sora.version();

InitE2EE

E2EE を使用する場合の初期化処理を行います

initE2EE(url)

E2EE を使用する場合の初期化処理を行います

url: sora-e2ee wasm の URL

Sora.initE2EE("http://192.0.2.100/wasm.wasm");

Sendrecv

SoraConnection オブジェクトから sendrecv オブジェクトを生成します。 sendrecv オブジェクトの connect を使用することにより接続が開始されます。

警告

スポットライト機能はプレビュー機能のため、仕様変更の可能性があります

sendrecv(channelId, metadata, options={})

sendrecv オブジェクトを生成します。

channelId: String

チャネルID

metadata: JSON

メタデータ

options

オプション

パラメーター名

タイプ

デフォルト

説明

audio

Boolean

true

オーディオ有効/無効

audioCodecType

String

オーディオコーデックタイプ(OPUS/PCMU)

audioBitRate

Integer

オーディオビットレート

video

Boolean

true

ビデオ有効/無効

videoCodecType

String

ビデオコーデックタイプ(VP8/VP9/H264)

videoBitRate

Integer

ビデオビットレート

multistream

Boolean

マルチストリーム有効/無効

spotlight

Boolean | Integer

スポットライト有効/無効(スポットライトレガシー使用時にはアクティブクライアント数)

spotlightNumber

Integer

スポットライト機能のアクティブクライアント数

simulcast

Boolean

サイマルキャスト有効/無効

simulcastRid

String

サイマルキャストRID (r0/r1/r2)

clientId

String

クライアントID

timeout

Integer

60000

タイムアウト時間(ms)

e2ee

Boolean

E2EE 有効/無効

signalingNotifyMetadata

JSON

signaling notify 用の metadata

connect(stream)

Sora サーバに接続します。

stream

MediaStream オブジェクト

disconnect()

Sora サーバとの接続を切断します。

on(kind, callback)

各イベント時のコールバックを登録します。

イベントタイプは

  • disconnect

  • push

  • track

  • removetrack

  • addstream(非推奨)

  • removestream(非推奨)

  • notify

  • log

  • timeout

が指定可能です。

role

'sendrecv' を返します

channelId

channelId を返します

metadata

metadata を返します

signalingUrl

signalingUrl を返します

options

options を返します

debug

debug を返します

clientId

clientId を返します

詳しくは Sora のドキュメント を参照してください

connectionId

connectionId を返します

詳しくは Sora のドキュメント を参照してください

authMetadata

authMetadata を返します

詳しくは Sora のドキュメント を参照してください

pc

RTCPeerConnection オブジェクトを返します

e2eeSelfFingerprint

E2EE 使用時に自分自身の接続のフィンガープリントを返します

e2eeRemoteFingerprints

E2EE 使用時に視聴するフィンガープリント一覧を返します

remoteConnectionIds

(非推奨) 現在接続中の connectionId のリストを返します

stream

(非推奨) mediaStream オブジェクトを返します

Sendonly

SoraConnection オブジェクトから sendonly オブジェクトを生成します。 sendonly オブジェクトの connect を使用することにより接続が開始されます。

警告

スポットライト機能はプレビュー機能のため、仕様変更の可能性があります

sendonly(channelId, metadata, options={})

sendonly オブジェクトを生成します。

channelId: String

チャネルID

metadata: JSON

メタデータ

options

オプション

パラメーター名

タイプ

デフォルト

説明

audio

Boolean

true

オーディオ有効/無効

audioCodecType

String

オーディオコーデックタイプ(OPUS/PCMU)

audioBitRate

Integer

オーディオビットレート

video

Boolean

true

ビデオ有効/無効

videoCodecType

String

ビデオコーデックタイプ(VP8/VP9/H264)

videoBitRate

Integer

ビデオビットレート

multistream

Boolean

マルチストリーム有効/無効

spotlight

Boolean | Integer

スポットライト有効/無効(スポットライトレガシー使用時にはアクティブクライアント数)

spotlightNumber

Integer

スポットライト機能のアクティブクライアント数

simulcast

Boolean

サイマルキャスト有効/無効

simulcastRid

String

サイマルキャストRID (r0/r1/r2)

clientId

String

クライアントID

timeout

Integer

60000

タイムアウト時間(ms)

e2ee

Boolean

E2EE 有効/無効

signalingNotifyMetadata

JSON

signaling notify 用の metadata

connect(stream)

Sora サーバに接続します。

stream

MediaStream オブジェクト

disconnect()

Sora サーバとの接続を切断します。

on(kind, callback)

各イベント時のコールバックを登録します。

イベントタイプは

  • disconnect

  • push

  • track

  • removetrack

  • addstream(非推奨)

  • removestream(非推奨)

  • notify

  • log

  • timeout

が指定可能です。

role

'sendonly' を返します

channelId

channelId を返します

metadata

metadata を返します

signalingUrl

signalingUrl を返します

options

options を返します

debug

debug を返します

clientId

clientId を返します

詳しくは Sora のドキュメント を参照してください

connectionId

connectionId を返します

詳しくは Sora のドキュメント を参照してください

authMetadata

authMetadata を返します

詳しくは Sora のドキュメント を参照してください

pc

RTCPeerConnection オブジェクトを返します

e2eeSelfFingerprint

E2EE 使用時に自分自身の接続のフィンガープリントを返します

e2eeRemoteFingerprints

E2EE 使用時に視聴するフィンガープリント一覧を返します

remoteConnectionIds

(非推奨) 現在接続中の connectionId のリストを返します

stream

(非推奨) mediaStream オブジェクトを返します

Recvonly

SoraConnection オブジェクトから recvonly オブジェクトを生成します。 recvonly オブジェクトの connect を使用することにより接続が開始されます。

警告

スポットライト機能はプレビュー機能のため、仕様変更の可能性があります

recvonly(channelId, metadata, options={})

視聴者 オブジェクトを生成します。

channelId: String

チャネルID

metadata: JSON

メタデータ

options

オプション

パラメーター名

タイプ

デフォルト

説明

audio

Boolean

true

オーディオ有効/無効

audioCodecType

String

オーディオコーデックタイプ(OPUS/PCMU)

audioBitRate

Integer

オーディオビットレート

video

Boolean

true

ビデオ有効/無効

videoCodecType

String

ビデオコーデックタイプ(VP8/VP9/H264)

videoBitRate

Integer

ビデオビットレート

multistream

Boolean

マルチストリーム有効/無効

spotlight

Boolean | Integer

スポットライト有効/無効(スポットライトレガシー使用時にはアクティブクライアント数)

spotlightNumber

Integer

スポットライト機能のアクティブクライアント数

simulcast

Boolean

サイマルキャスト有効/無効

simulcastRid

String

サイマルキャストRID (r0/r1/r2)

clientId

String

クライアントID

timeout

integer

60000

タイムアウト時間(ms)

e2ee

Boolean

E2EE 有効/無効

signalingNotifyMetadata

JSON

signaling notify 用の metadata

connect()

Sora サーバに接続します。

disconnect()

Sora サーバとの接続を切断します。

on(kind, callback)

各イベント時のコールバックを登録します。

イベントタイプは

  • disconnect

  • push

  • track

  • removetrack

  • addstream(非推奨)

  • removestream(非推奨)

  • notify

  • log

  • timeout

が指定可能です。

role

'recvonly' を返します

channelId

channelId を返します

metadata

metadata を返します

signalingUrl

signalingUrl を返します

options

options を返します

debug

debug を返します

clientId

clientId を返します

詳しくは Sora のドキュメント を参照してください

connectionId

connectionId を返します

詳しくは Sora のドキュメント を参照してください

authMetadata

authMetadata を返します

詳しくは Sora のドキュメント を参照してください

pc

RTCPeerConnection オブジェクトを返します

e2eeSelfFingerprint

E2EE 使用時に自分自身の接続のフィンガープリントを返します

e2eeRemoteFingerprints

E2EE 使用時に視聴するフィンガープリント一覧を返します

remoteConnectionIds

(非推奨) 現在接続中の connectionId のリストを返します

stream

(非推奨) mediaStream オブジェクトを返します

Publisher

非推奨 API です

Subscriber

非推奨 API です