ライブプロファイルの作成および更新を行うAPIです。
■リクエストURL
https://file-platform.stream.co.jp/writeapi/live/setProfile/[アップロードキー]
※「アップロードキー」の取得方法は「認証API」をご参照ください。
- contentType：multipart/form-data
■パラメータ
| パラメータ | 必須 | 説明 | デフォルト値 （新規） | フォーマット | |
| 新規 | 更新 | ||||
| lpid | --- | ○ | ライブID | 自動連番 | 半角数 |
| name | ○ | --- | ライブ配信設定名 | 無し | 全角半角 100文字 |
| description | --- | --- | ライブ設定説明 | 空白 | 全角半角 500文字 |
| group_id | --- | --- | グループ設定 （録画ファイルアップロード先） |
無し | 半角数 |
| transcode_id | --- | --- | トランスコードID | デフォルトに指定した トランスコードID |
半角数 |
| max_client | --- | --- | 同時接続数制限 | ライブの同時接続数上限 | 半角数 |
| liveapp_flg | --- | --- | EQライブキャスト利用 | 0:利用しない | 0:利用しない 1:利用する ※1 |
| quality_fhd | ○ ※2 |
--- | フルHD画質 | 0:無効 | 0:無効 1:有効 |
| quality_hd | ○ ※2 |
--- | HD画質 | 0:無効 | 0:無効 1:有効 |
| quality_high | ○ ※2 |
--- | 高画質 | 0:無効 | 0:無効 1:有効 |
| quality_standard | ○ ※2 |
--- | 標準画質 | 0:無効 | 0:無効 1:有効 |
| quality_low | ○ ※2 |
--- | 低画質 | 0:無効 | 0:無効 1:有効 |
| encoder_type | --- | --- | ご使用の ライブエンコーダー台数 |
2:2台 ※3 |
1:1台 2:2台 |
| vod_flg | --- | --- | VODの使用可否 | 1:有効 | 0:無効 1:有効 |
| exlink_flg | --- | --- | 動画からのリンク | 1:利用する | 0:利用しない 1:利用する |
| exlink1_txt | --- | --- | 関連ページリンク(1) リンクテキスト |
空白 | 全角半角 100文字 |
| exlink1_url | --- | --- | 関連ページリンク(1) リンクURL |
空白 | URL形式 1000文字 |
| exlink2_txt | --- | --- | 関連ページリンク(2) リンクテキスト |
空白 | 全角半角 100文字 |
| exlink2_url | --- | --- | 関連ページリンク(2) リンクURL |
空白 | URL形式 1000文字 |
| exlink3_txt | --- | --- | 関連ページリンク(3) リンクテキスト |
空白 | 全角半角 100文字 |
| exlink3_url | --- | --- | 関連ページリンク(3) リンクURL |
空白 | URL形式 1000文字 |
| vlp_id | --- | --- | セキュリティプロファイルID | 「制限なし」で登録 | 半角数 |
| thumb_feedout | --- | --- | 配信停止サムネイル | デフォルトサムネイル | フルパス形式 2MB以下 *.gif; *.jpeg; *.jpg; *.png |
| thumb_feedin | --- | --- | 配信準備サムネイル | デフォルトサムネイル | フルパス形式 2MB以下 *.gif; *.jpeg; *.jpg; *.png |
| thumb_liveopen | --- | --- | 配信終了サムネイル | デフォルトサムネイル | フルパス形式 2MB以下 *.gif; *.jpeg; *.jpg; *.png |
| server_number | --- | --- | ライブエンコーダーを １台のみご利用頂く際の 詳細設定 |
2:2系統 ※3 |
1:1系統 2:2系統 |
| chat_flg | --- | --- | チャット設定利用可否 | 0:利用しない | 0:利用しない 1:利用する |
| chat_auto_resize | --- | --- | チャットの自動リサイズ | 0:無効 | 0:無効 1:有効 |
| chat_width | --- | --- | チャットのwidth | 600 | 300 ～ 1920 |
| chat_height | --- | --- | チャットのheight | 400 | 320 ～ 1080 |
| chat_block_type | --- | --- | 投稿されるメッセージ管理 | 0:メッセージを全て許可する | 0:メッセージを全て許可する 1:不適切な可能性のあるメッセージを保留して確認する 2:すべてのメッセージを保留して確認する |
| chat_enter_msg | --- | --- | 入退室メッセージの表示 | 0:表示する | 0:表示する 1:入室メッセージのみ表示する 2:表示しない |
| chat_good_btn | --- | --- | いいねボタン表示 | 1:有効 | 0:無効 1:有効 |
| chat_trouble_btn | --- | --- | わかりませんボタン表示 | 1:有効 | 0:無効 1:有効 |
| chat_display_name | --- | --- | 管理者表示名 | "admin":管理者 | "admin":管理者 "operator":運営 "secretariat":事務局 "任意の15文字以内" |
| chat_block_words | --- | --- | ブロックする文字列 （カンマ区切り） |
空白 | 全角半角 1000文字 |
※1 「利用する」を指定した場合、「有効」に設定された画質の中から最高画質のみが選択されます。
※2 5画質の内、最低1つは「有効」に設定する必要があります。
（画質が一つも「有効」に設定されていない場合はエラーとなります。）
※3 「EQライブキャスト利用」を「利用する」と指定した場合、「ご使用のライブエンコーダー台数」と「ライブエンコーダーを１台のみご利用頂く際の詳細設定」は『1』で固定となります。
■レスポンス情報
- 出力タイプ：JSON
- Content-Type：application/json
- 文字コード：UTF-8(BOMなし)
■レスポンス例：正常時
| { "error_code": 0, "message": "OK", "lpid": 1 } |
error_code：レスポンスコード message：メッセージ lpid：ライブID |
■レスポンス例：エラー時
| { "error_code": 9021, "message": "request parameter error", "lpid": 1 } |
■レスポンスコード
| レスポンスコード | 説明 |
| 0 | 正常 |
| 7000 | 一部のみ更新（ライブ配信準備中時、一部設定登録不可） |
| 9021 | パラメータエラー |
| 9022 | 未対応サムネイル |
| 9502 | サムネイルアップロード中エラー |
| 9503 | 削除済み、または登録されていない |
| 9512 | ライブ中またはライブ準備中更新NGエラー |
| 9516 | ライブ設定上限超過エラー |
| 9519 | 有効なグループIDなし |
| 9520 | 有効なトランスコードIDなし |
| 9521 | ライブ同時接続数上限超過エラー |
| 9522 | 有効なセキュリティプロファイルIDなし |
| 9999 | その他システムエラー |