API リファレンス

注意

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

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

Integer

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

simulcast

Boolean

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

simulcastQuality

String

サイマルキャストクオリティ(low/middle/high)

clientId

String

クライアントID

timeout

integer

60000

タイムアウト時間(ms)

e2ee

String

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 オブジェクトを返します

remoteConnectionIds

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

stream

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

const sendrecv = sora.sendrecv('channel', 'metadata');

navigator.mediaDevices.getUserMedia({audio: true, video: true})
  .then(mediaStream => sendrecv.connect(mediaStream))
  .catch(e => {
    console.error(e);
  });

// event
sendrecv.on('disconnect', e => {
  console.error(e);
});

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

Integer

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

simulcast

Boolean

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

simulcastQuality

String

サイマルキャストクオリティ(low/middle/high)

clientId

String

クライアントID

timeout

integer

60000

タイムアウト時間(ms)

e2ee

String

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 オブジェクトを返します

remoteConnectionIds

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

stream

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

const sendonly = sora.sendonly('channel', 'metadata');

navigator.mediaDevices.getUserMedia({audio: true, video: true})
  .then(mediaStream => sendonly.connect(mediaStream))
  .catch(e => {
    console.error(e);
  });

// event
sendrecv.on('disconnect', e => {
  console.error(e);
});

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

Integer

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

simulcast

Boolean

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

simulcastQuality

String

サイマルキャストクオリティ(low/middle/high)

clientId

String

クライアントID

timeout

integer

60000

タイムアウト時間(ms)

e2ee

String

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 オブジェクトを返します

remoteConnectionIds

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

stream

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

const recvonly = sora.recvonly('channel', 'metadata');

recvonly.connect()
  .then(stream => {
    // stream を video.src に追加する等の処理
  });

// disconnect
recvonly.disconnect()
  .then(() => {
    // video を止める等の処理
  });

Publisher

非推奨 API です

Subscriber

非推奨 API です