instructions.json

{
  "channelId": {
    "description": "接続するチャネルの ID を指定します。\n1-255 文字までの文字列を指定できます。"
  },
  "role": {
    "description": "クライアントの役割を指定します。"
  },
  "multistream": {
    "description": "マルチストリームを使用するかどうかを指定します。Sora は未指定の場合、マルチストリームを使用します。"
  },
  "simulcast": {
    "description": "サイマルキャストを使用するかどうかを指定します。"
  },
  "simulcastRid": {
    "description": "サイマルキャストで配信されている映像を受信する際のエンコードの初期値を指定します。"
  },
  "spotlight": {
    "description": "スポットライトを使用するかどうかを指定します。"
  },
  "spotlightNumber": {
    "description": "スポットライトでフォーカスする配信数の最大値を指定します。"
  },
  "spotlightFocusRid": {
    "description": "スポットライトでフォーカスした場合の映像を受信する際のエンコードの初期値を指定します。"
  },
  "spotlightUnfocusRid": {
    "description": "スポットライトでフォーカスが外れた場合の映像を受信する際のエンコードの初期値を指定します。"
  },
  "audio": {
    "description": "音声配信をするかどうかを指定します。"
  },
  "audioCodecType": {
    "description": "音声のコーデックタイプを指定します。"
  },
  "audioBitRate": {
    "description": "音声のビットレートを指定します。\n6 ~ 510 kbps の範囲で指定できます。"
  },
  "video": {
    "description": "映像配信をするかどうかを指定します。"
  },
  "videoCodecType": {
    "description": "映像のコーデックタイプを指定します。"
  },
  "videoBitRate": {
    "description": "映像のビットレートを指定します。\n15,000 kbps までがサポート対象、それ以上のビットレートはサポート対象外です。"
  },
  "videoVP9Params": {
    "description": "映像のコーデックタイプに VP9 を指定した場合の設定を指定します。"
  },
  "videoH264Params": {
    "description": "映像のコーデックタイプに H264 を指定した場合の設定を指定します。"
  },
  "videoH265Params": {
    "description": "映像のコーデックタイプに H265 を指定した場合の設定を指定します。"
  },
  "videoAV1Params": {
    "description": "映像のコーデックタイプに AV1 を指定した場合の設定を指定します。"
  },
  "reconnect": {
    "description": "一度接続に成功したあとに意図しない切断があった場合に再接続するかどうかを指定します。"
  },
  "clientId": {
    "description": "接続時に任意のクライアント ID を指定できます。"
  },
  "metadata": {
    "description": "認証するための判断材料としてのメタデータを指定します。"
  },
  "bundleId": {
    "description": "複数接続時に同一の bundle_id を指定すると、同一 bundle_id の接続から音声や映像やメッセージングを受信しなくなります。"
  },
  "signalingNotifyMetadata": {
    "description": "クライアントが参加や離脱したときに送られるシグナリング通知に含まれるメタデータを指定します。"
  },
  "signalingUrlCandidates": {
    "description": "シグナリングをするURLを改行区切りで複数指定します。"
  },
  "forwardingFilters": {
    "description": "転送フィルターを複数指定します。"
  },
  "forwardingFilter": {
    "description": "転送フィルターを指定します。"
  },
  "audioStreamingLanguageCode": {
    "description": "音声解析用の言語コードを指定します。"
  },
  "dataChannels": {
    "description": "メッセージング用の DataChannel を指定します。"
  },
  "dataChannelSignaling": {
    "description": "シグナリングを DataChannel 経由に切り替えるかどうかを指定します。"
  },
  "ignoreDisconnectWebSocket": {
    "description": "シグナリングを DataChannel 経由に切り替えた際に、 WebSocket が閉じても、接続が切断しないようにするかどうかを指定します。"
  },
  "mediaType": {
    "description": "メディアタイプを指定します。\ngetUserMedia: デバイスのカメラ/マイクをメディアとして使用します。\ngetDisplayMedia: ディスプレイまたはその一部(ウィンドウ等)をメディアとして使用します。\nfakeMedia: ダミーの映像と音声をメディアとして使用します\nmediacaptureRegion: 現在開いているタブの一部をメディアとして使用します。"
  },
  "fakeVolume": {
    "description": "mediaType に fakeMedia を選択した際の音量を指定します。"
  },
  "mp4File": {
    "description": "mediaType に mp4Media を選択した際に使用する MP4 ファイル (H.264 + Opus のみ対応) を指定します。"
  },
  "audioContentHint": {
    "description": "MediaStreamTrack audio の contentHint を指定します。"
  },
  "autoGainControl": {
    "description": "MediaTrackConstraints の autoGainControl を指定します。"
  },
  "noiseSuppression": {
    "description": "MediaTrackConstraints の noiseSuppression を指定します。"
  },
  "echoCancellation": {
    "description": "MediaTrackConstraints の echoCancellation を指定します。"
  },
  "echoCancellationType": {
    "description": "MediaTrackConstraints の echoCancellationType を指定します。"
  },
  "mediaProcessorsNoiseSuppression": {
    "description": "shiguredo Media Processors のノイズ抑制を使用するかどうか指定します。"
  },
  "videoContentHint": {
    "description": "MediaStreamTrack video の contentHint を指定します。"
  },
  "resolution": {
    "description": "解像度を指定します。任意の解像度を指定する場合は、幅と高さを x 区切りで指定します。 (例: 640x480)"
  },
  "mediaStats": {
    "description": "映像の統計情報を映像に重ねて表示します。"
  },
  "frameRate": {
    "description": "MediaTrackConstraints の frameRate を指定します。"
  },
  "aspectRatio": {
    "description": "MediaTrackConstraints の aspectRatio を指定します。"
  },
  "resizeMode": {
    "description": "MediaTrackConstraints の resizeMode を指定します。"
  },
  "blurRadius": {
    "description": "shiguredo Media Processors の背景ぼかしを使用するかどうか指定します。"
  },
  "lightAdjustment": {
    "description": "shiguredo Media Processors のライト調整を使用するかどうか指定します。"
  },
  "audioInput": {
    "description": "音声入力を指定します。"
  },
  "videoInput": {
    "description": "映像入力を指定します。"
  },
  "audioOutput": {
    "description": "音声出力を指定します。"
  },
  "displayResolution": {
    "description": "画面に表示する際の解像度を指定します。任意の解像度を指定する場合は、幅と高さを x 区切りで指定します。 (例: 640x480)"
  },
  "micDevice": {
    "description": "Audio MediaStreamTrack を生成するかどうかを切り替えます。"
  },
  "cameraDevice": {
    "description": "Video MediaStreamTrack を生成するかどうかを切り替えます。"
  },
  "audioTrack": {
    "description": "Audio MediaStreamTrack の enabled 属性を切り替えます。"
  },
  "videoTrack": {
    "description": "video MediaStreamTrack の enabled 属性を切り替えます。"
  },
  "facingMode": {
    "description": "モバイルカメラのフロント/バックを切り替えます。"
  },
  "changeAllRecvStream": {
    "description": "サイマルキャストで受信中の全てのストリームの rid を操作します。"
  }
}