JSON-RPC 2.0 over DataChannel による Sora API 実行機能 (仮)¶

警告

この機能は実験的機能のため、正式版では仕様が変更される可能性があります

Sora では JSON-RPC 2.0 により Sora の API を DataChannel 経由で利用できます。

概要¶

Sora の API を DataChannel シグナリング経由で利用するための機能です。

仕様¶

JSON-RPC 2.0 の仕様に準拠しています
method には API 利用時の x-sora-target ヘッダーに指定する値を指定します
params には API 利用時の JSON を指定します
- channel_id と connection_id は省略することができます
id を付けないことでレスポンスを返さない Notification として利用できます
timeout はミリ秒単位で指定します

パーミッション¶

この機能を利用する場合は認証時の払い出しで API のパーミッションを付与する必要があります。

{
   "allowed": True,
   "rpc_permissions": [
      "Sora_20201124.PutSignalingNotifyMetadata",
      "Sora_20201124.PutSignalingNotifyMetadataItem",
   ]
}

Sora JavaScript SDK での利用¶

const result = await client.rpc('Sora_20201124.PutSignalingNotifyMetadata', {
  metadata: {
   key: 'value'
  },
  {
    // 3000 ミリ秒のタイムアウトを設定
    timeout: 3000
  }
}