ライブエンコーダー設定情報の取得を行う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 | --- | ライブエンコーダー | 半角文字 "wirecast":WireCastフォーマット "liveusolo":LiveUSoloフォーマット "liveshell":LiveShellフォーマット |
"json": jsonフォーマット |
■レスポンス
|
パラメータ |
名称 | ||
|
error_code |
エラーコード | ||
|
message |
メッセージ |
||
|
lpid |
ライブ設定ID | ||
| encoder_setting | server_mainurl | メイン配信URL | |
| server_suburl | バックアップ配信URL | ||
|
qualities |
name | 画質名 | |
| jpname | 画質名（日本語） | ||
| stream_name |
ストリーム名（ストリームキー） |
||
| keyframe | キーフレーム | ||
| video_bitrate | 動画ビットレート(kbps) | ||
| audio_bitrate | 音声ビットレート(kbps) | ||
| width | 動画横サイズ | ||
| height | 動画縦サイズ | ||
| audio_sampling_frequency | 音声サンプリングレート(khz) | ||
■パラメータ「type」を指定しない場合のレスポンス例：正常時（JSONフォーマット）
| { "error_code": 0, "message": "OK", "lpid": 1, "encoder_setting": { "server_mainurl": "rtmp://XXXXXXXXXXX- org1.wlive.cloud.stream.co.jp:XXXX/XXXXXXXXXXXXXX?key=XXXXXXX", "server_suburl": "rtmp://XXXXXXXXXXX-org2.wlive.cloud.stream.co.jp:XXXX/XXXXXXXXXXXXXX?key=XXXXXXX", "qualities": [ { "name": "fhd", "jpname": "フルＨＤ画質", "stream_name": "XXXXXXXXXXXXX", "keyframe": 30, "video_bitrate": 6000, "audio_bitrate": 128, "width": 1920, "height": 1080, "audio_sampling_frequency": 44 } ] } } |
■パラメータ「type」を指定した際のレスポンス例：正常時（LiveShellフォーマット）
| 【配信するサーバ情報(RTMP)】 ■配信先URL ■ストリーム名 【エンコーダー設定の推奨値】 【CUSTOM】 ■VIDEO QUALITY |
■レスポンス例：エラー時
| { "error_code": 9021, "message": "request parameter error" } |
■レスポンスコード
| レスポンスコード | 説明 |
| 0 | 正常 |
| 9021 | パラメータエラー |
| 9503 | 削除済み、または登録されていない |
| 9999 | その他システムエラー |