ライブエンコーダー設定情報の取得を行うAPIです。
■リクエストURI
https://eqapi.stream.co.jp/live/v1/getEncoder/[アップロードキー]
※「アップロードキー」の取得方法は「アップロードキー取得API」をご参照ください。
■メソッドタイプ
POST
■ヘッダー
| HTTPヘッダー | 値 |
| Accept | multipart/form-data |
| Content-Type | multipart/form-data |
■パラメータ
| パラメータ | 必須 | 説明 | フォーマット | デフォルト値 |
| lpid | ○ | ライブ設定ID | 半角数字 | 無し |
| type | --- | ライブエンコーダー |
半角文字 ※互換性のため以下の値でも設定ファイルを取得可能ですが、取得できるファイルはencorderText指定時と同様のものです。 "wirecast" |
"json" |
■レスポンス
|
パラメータ |
名称 | ||
| error_code | エラーコード | ||
| message | メッセージ |
||
| lpid | ライブ設定ID | ||
| encoder_setting | server_mainurl | メイン配信URL | |
| server_suburl | バックアップ配信URL | ||
|
qualities |
name | 画質名 | |
| jpname | 画質名（日本語） | ||
| stream_name | ストリーム名（ストリームキー） |
||
| video_bitrate | 動画ビットレート(kbps) | ||
| audio_bitrate | 音声ビットレート(kbps) | ||
| width | 動画横サイズ | ||
| height | 動画縦サイズ | ||
| audio_sampling_frequency | 音声サンプリングレート(khz) | ||
■パラメータ「type」を指定しない、もしくは「json」を指定した場合のレスポンス例：正常時
| { "errorCode": 0, "message": "OK", "lpid": "2", "encoder_setting": { "server_mainurl": "rtmp://XXXXXXXXXXX-org1.wlive.cloud.stream.co.jp:1935/XXXXXXXXXXX?key=XXXXXXXXXXX", "server_suburl": "rtmp://XXXXXXXXXXX-org2.wlive.cloud.stream.co.jp:1935/XXXXXXXXXXX?key=XXXXXXXXXXX", "qualities": { "name": "high", "jpname": "高画質", "stream_name": XXXXXXXXXXX", "video_bitrate": 1600, "audio_bitrate": 128, "width": 854, "height": 480, "audio_sampling_frequency": [ 44.1, 48 ] } } } |
■パラメータ「type」を「encorderText」を指定した際のレスポンス例：正常時
| 【配信設定】 ■メインエンコーダーURL： rtmp://XXXXXXXXXXX-org1.wlive.cloud.stream.co.jp:1935/XXXXXXXXXXX?key=XXXXXXXXXXX ■バックアップエンコーダーURL： rtmp://XXXXXXXXXXX-org2.wlive.cloud.stream.co.jp:1935/XXXXXXXXXXX?key=XXXXXXXXXXX ■ストリームキー XXXXXXXXXXX 【エンコーダー設定の推奨値】 下記はエンコーダーに設定する推奨値です。 ■エンコーダー映像設定 フルHD画質(1080p, 6000kbps) ■フレームレート 30 fps ■キーフレーム間隔 30 フレームごと ( 1 秒ごと) ■エンコーダー音声設定 128 kbps ( 44.1 または 48 kHz) |
■レスポンス例：エラー時
| { "error_code": 9021, "message": "request parameter error" } |
■レスポンスコード
| レスポンスコード | 説明 |
| 0 | 正常 |
| 9021 | パラメータエラー |
| 9503 | 削除済み、または登録されていない |
| 9999 | その他システムエラー |