API リファレンス

注意

  • 見出しの先頭に [Beta] と付記された仕様は、ベータ版であることを指します。

SoraConnection

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

connection(url, debug=false)

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

url: String
Sora サーバーの URL
debug: Boolean
デバッグ 有効/無効 フラグ

exmaple:

var sora = Sora.connection('ws://192.168.0.2:5000/signaling');

Publisher

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

警告

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

publisher(channelId, metadata, options={})

配信者 オブジェクトを生成します。

channelId
チャネルID
metadata
チャネルID
options

オプション

パラメーター名 タイプ デフォルト 説明
audio Boolean true オーディオ有効/無効
audioCodecType String   オーディオコーデックタイプ(OPUS/PCMU)
audioBitRate Integer   オーディオビットレート
video Boolean true ビデオ有効/無効
videoCodecType String   ビデオコーデックタイプ(VP8/VP9/H264)
videoBitRate Integer   ビデオビットレート
multistream Boolean   マルチストリーム有効/無効
spotlight Integer   スポットライト機能のアクティブクライアント数
connect(stream)

Sora サーバーに接続します。

stream
MediaStream オブジェクト
disconnect()
Sora サーバーとの接続を切断します。
on(kind, callback)

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

イベントタイプは

  • disconnect
  • push
  • addstream
  • removestream
  • notify
  • log

が指定可能です。

exmaple:

var publisher = sora.publisher('channel', 'metadata');

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

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

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

Subscriber

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

警告

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

subscriber(channelId, metadata, options={})

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

channelId
チャネルID
metadata
メタデータ
options

オプション

パラメーター名 タイプ デフォルト 説明
audio Boolean true オーディオ有効/無効
audioCodecType String   オーディオコーデックタイプ(OPUS/PCMU)
audioBitRate Integer   オーディオビットレート
video Boolean true ビデオ有効/無効
videoCodecType String   ビデオコーデックタイプ(VP8/VP9/H264)
videoBitRate Integer   ビデオビットレート
multistream Boolean   マルチストリーム有効/無効
spotlight Integer   スポットライト機能のアクティブクライアント数
connect(stream)

Sora サーバーに接続します。

stream
MediaStream オブジェクト
disconnect()
Sora サーバーとの接続を切断します。
on(kind, callback)

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

イベントタイプは

  • disconnect
  • push
  • addstream
  • removestream
  • notify
  • log

が指定可能です。

exmaple:

var subscriber = sora.publisher('channel', 'metadata');

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

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

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