目次
- contents/get_all_broadcasts（全てのLIVE配信を取得）
- contents/create_broadcast（LIVE配信を登録）
- contents/get_broadcast_details（LIVE配信の詳細情報を取得）
- contents/modify_broadcast_info（LIVE配信の情報を編集）
- contents/start_broadcast（LIVE配信を開始）
- contents/stop_broadcast（LIVE配信を停止）
contents/get_all_broadcasts
概要
全てのLIVE配信を取得。
カテゴリ
コンテンツ
入力
※limit,filters,order対応
出力
コンテンツ要素のリスト。
ステータス
有効
contents/create_broadcast
概要
LIVE配信を登録。
カテゴリ
コンテンツ
入力
| 名前(要素名) | 値(要素の内容) |
|---|---|
| name | コンテンツ名 |
| duration_minutes | 配信時間 |
| id_recipe | エンコード設定のID(省略可) settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。 |
| visible | 1=常に表示。0=常に非表示。DATE,DATE=期間公開。(省略可) |
| archive | アーカイブの有無。1=有効。0=無効。(オプション・省略可) |
| description | 説明(省略可) |
| metatag | タグ(省略可) |
| usermeta | USERMETA(省略可) |
| custom_status | 配信状態を変更して再生前のプレイヤー表示を制御できます(省略可)。 省略時には自動設定となり、エンコーダの入力状態に準拠します。 listen (“準備完了”)。publishing (“配信中”)。established (“待機中”)。closed (“配信終了”)。 |
| permanent_use | 配信期限の有無 1=期限なし。0=期限あり（オプション・省略可） |
| original_stream_publish | 非トランスコード配信の有無。 1=非トランスコード配信。0=トランスコード配信。（オプション・省略可、アカウントのトランスコードoptionがOFFの場合、入力値に関係なく一律非トランコード配信の1に設定される） |
| autocommit | 1を指定した場合、登録後に自動公開処理を行う(省略可) |
出力
| 名前(要素名) | 値(要素の内容) |
|---|---|
| id_contents | コンテンツID |
ステータス
有効
contents/get_broadcast_details
概要
LIVE配信の詳細情報を取得。
カテゴリ
コンテンツ
入力
| 名前 | 値 |
|---|---|
| id_contents | コンテンツID |
出力
| 名前(要素名) | 値(要素の内容) |
|---|---|
| id_contents | コンテンツID |
| name | コンテンツ名 |
| description | 説明 |
| metatag | メタタグ |
| visible | 1=常に表示。0=常に非表示。DATE,DATE=期間公開。 |
| create_date | 作成日 |
| id_video_thumbnail | サムネイルID |
| meta_url | メタURL |
| update_date | 更新日 |
| gid | コンテンツユニークID |
| usermeta | USERMETA ※未指定時は空文字 |
| id_recipe | エンコード設定のID settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。 |
| external_id_event | 外部LIVE配信ID |
| archive | アーカイブの有無（1=有。2=無） |
| archive_id_contents | 登録されたarchive情報のリスト contents/get_video_detailsのレスポンス情報を参照してください。 (オプション) |
| custom_status | 再生前のプレイヤー表示。null (“自動”)。listen (“準備完了”)。publishing (“配信中”)。established (“待機中”)。closed (“配信終了”)。 未指定の場合、null (“自動”)が返されます。 |
| publish_url | 配信用URL |
| publish_stream | 配信用stream |
| publish_started_at | 配信開始時間 |
| publish_ended_at | 配信終了時間 |
| broadcast_status | 配信ステータス |
| duration_minutes | 配信時間 |
| permanent_use | 配信期限の有無 true=期限なし。false=期限あり（オプション・省略可） |
| original_stream_publish | 非トランスコード配信の有無。 true=非トランスコード配信。false=トランスコード配信。（オプション・省略可、アカウントのトランスコードoptionがOFFの場合、入力値に関係なく一律非トランスコード配信のtrueに設定される） |
| deliveryStart | Liveの配信開始許可状態。 1=配信開始許可。0=配信非許可状態。 |
| original_format | 元動画のフォーマット |
| original_width | 元動画の幅 |
| original_height | 元動画の高さ |
ステータス
有効
contents/modify_broadcast_info
概要
LIVE配信の情報を編集。
カテゴリ
コンテンツ
入力
| 名前 | 値 |
|---|---|
| id_contents | コンテンツID |
| name | コンテンツ名 |
| duration_minutes | 配信時間(省略可)。設定変更は『配信ステータス：準備完了』の場合にのみ可能です。 |
| id_recipe | エンコード設定のID(省略可) settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。 設定変更は『配信ステータス：準備完了』の場合にのみ可能です。 |
| visible | 1=常に表示。0=常に非表示。DATE,DATE=期間公開。(省略可) |
| archive | アーカイブの有無(省略可)。1=有効。0=無効。設定変更は『配信ステータス：配信終了』以外の場合に可能です。 |
| description | 説明(省略可) |
| metatag | タグ(省略可) |
| usermeta | USERMETA(省略可) |
| custom_status | 配信状態を変更して再生前のプレイヤー表示を制御できます(省略可)。 listen (“準備完了”)。publishing (“配信中”)。established (“待機中”)。closed (“配信終了”)。 |
| autocommit | 1を指定した場合、登録後に自動公開処理を行う(省略可) |
| test | テスト配信のON/OFF 1=テスト配信である。0=テスト配信ではない。 |
| original_stream_publish | 非トランスコード配信の有無。 1=非トランスコード配信。0=トランスコード配信。（オプション・省略可、アカウントのトランスコードoptionがOFFの場合、入力値に関係なく一律非トランコード配信の1に設定される） |
| ※ test、duration_minutes、id_recipeとoriginal_stream_publishはbroadcast_statusが「listen」の時のみ変更可能です。 | |
ステータス
有効
contents/start_broadcast
概要
LIVE配信を開始。
カテゴリ
コンテンツ
入力
| 名前(要素名) | 値(要素の内容) |
|---|---|
| id_contents | コンテンツID |
ステータス
有効
contents/stop_broadcast
概要
LIVE配信を停止。
カテゴリ
コンテンツ
入力
| 名前(要素名) | 値(要素の内容) |
|---|---|
| id_contents | コンテンツID |
ステータス
有効