音声ストリーミング API¶

StartAudioStreaming¶

バージョン 2022.2.0 で追加。

x-sora-target:: Sora_20221221.StartAudioStreaming

セッションが存在し、音声ストリーミングが開始していないチャネルに対して音声ストリーミングを開始します。

キー	型
channel_id	string

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20221221.StartAudioStreaming" \
    --json '{"channel_id":"sora"}' \
    | jq .
{
    "session_id": "MPXNY180M175Z69YY9FZFJ0QWR"
}

StopAudioStreaming¶

バージョン 2022.2.0 で追加。

x-sora-target:: Sora_20221221.StopAudioStreaming

セッションが存在し、音声ストリーミングが開始しているチャネルに対して音声ストリーミングを停止します。

キー	型
channel_id	string

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20221221.StopAudioStreaming" \
    --json '{"channel_id":"sora"}' \
    | jq .
{
    "session_id": "MPXNY180M175Z69YY9FZFJ0QWR"
}

SubscribeAudioStreamingResultPush¶

バージョン 2022.2.0 で追加。

x-sora-target:: Sora_20221221.SubscribeAudioStreamingResultPush

音声ストリーミングサーバーからの戻り値のプッシュ通知を指定した接続が購読するよう設定します。

キー	型
channel_id	string
connection_id	string

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20221221.SubscribeAudioStreamingResultPush" \
    --json '{"channel_id":"sora","connection_id":"AT10T0WHH94PHEM3M5F45QFGRW"}' \
    | jq .
{
    "channel_id": "sora",
    "connection_id": "AT10T0WHH94PHEM3M5F45QFGRW"
}

UnsubscribeAudioStreamingResultPush¶

バージョン 2022.2.0 で追加。

x-sora-target:: Sora_20221221.UnsubscribeAudioStreamingResultPush

音声ストリーミングサーバーからの戻り値のプッシュ通知を指定した接続が購読しないよう設定します。

キー	型
channel_id	string
connection_id	string

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20221221.UnsubscribeAudioStreamingResultPush" \
    --json '{"channel_id":"sora","connection_id":"4D83B8APHS4JX03C8SZ3176SBM"}' \
    | jq .
{
    "channel_id": "sora",
    "connection_id": "4D83B8APHS4JX03C8SZ3176SBM"
}

ListAudioStreamingResultPushState¶

バージョン 2023.1.0 で追加。

x-sora-target:: Sora_20230628.ListAudioStreamingResultPushState

指定したチャネルのセッションにおける、コネクションごとのサブスクライブ状態を表示します。

キー	型
channel_id	string

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20230628.ListAudioStreamingResultPushState" \
    --json '{"channel_id":"sora"}' \
    | jq .
[
  {
    "connection_id": "B2JPGFZPMD3H973Y811MF8ZZ70",
    "subscribe": true
  },
  {
    "connection_id": "KT116Z11KX5Y547KA1V12HW8PG",
    "subscribe": false
  },
  {
    "connection_id": "A5GYXGRYAX6590M3AFH7F9Z2H4",
    "subscribe": false
  }
]