# 実験的 API

## 概要

実験的 API とは、今後のアップデートで互換性を保証しない API です。

将来的には正式版としてリリースするか、または非推奨となり廃止するかのどちらかです。

## その他の API

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


### ChangeUpstreamVideoBitRate

**x-sora-target**: Sora_20190327.ChangeUpstreamVideoBitRate

指定した接続のビットレートを動的に変更します。

主に `role` が `sendonly` の **配信ビットレート** を動的に変更し固定することを目的としている API です。

> **注釈**
>
> これは接続後に映像ビットレートを強制的に変更する唯一の仕組みです。

* - キー
  - 型
* - channel_id
  - string
* - connection_id
  - string
* - bit_rate
  - integer (1 - 30000)

```console
$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20190327.ChangeUpstreamVideoBitRate" \
    --json '{"channel_id":"sora","connection_id":"HMRVPQEXJX03D3B3WE778SJGRC","bit_rate":300}' \
    | jq .
{
    "bit_rate": 300,
    "channel_id": "sora",
    "connection_id": "HMRVPQEXJX03D3B3WE778SJGRC"
}
```