この機能にはVimeo Enterpriseプランが必要です。
この記事では、Vimeo Live APIを使用したライブイベントの詳細の取得に関する情報をご紹介しています。詳細については、APIリファレンスをご覧ください。
記事の内容:
定期的なイベントの詳細を取得する
ライブイベント中は、接続中断/再接続時に同じ埋め込みコードで引き続き機能するように、基になる個々のクリップよりもイベントコンテナを埋め込むことをお勧めします。
APIを使用してIDでイベントコンテナを取得する:
https://api.vimeo.com/live_events/{event_id}
レスポンスから、embed:html より埋め込み可能なiframeコードを取得します
チャットは有効になっていますか? "chat_enabled" true/false
trueになっている場合「chat_embed_code」には埋め込み可能なiframeコードが含まれます。
IDによる応答がない場合、IDは1回限りのイベントに関連付けられている可能性があります。「個々の動画クリップまたは1回限りのイベントの詳細を取得する」を参照してください。
アプリケーションで知っておく必要のあるイベントコンテナの詳細:
- 「配信プライバシー」はプライバシーのレベルを反映しています
- 「埋め込み」:「公開」、「ホワイトリスト」または「プライベート」。「プライベート」設定はパートナーが埋め込むことはできません
- 「stream_password」は配信のパスワードを反映します
- 「バッジ」には、プレーヤーに通知するクリップに関する情報が含まれています:
- 「ライブ」は「ストリーミング」を示します:true/false またはアーカイブされた true/false
- 「vod」は、vodかどうかを示します。
詳細の書面は、APIリファレンスを参照してください。
イベント後 - 定期的なイベント内のクリップ
イベント後、プレーヤーの埋め込みでは次の3つのいずれかが表示されます:
- 前回のセッションの最新のVODクリップ
- (次の)配信がまだ開始されていないというメッセージ
- 定期的なイベントを使用して再度配信する場合の新規イベント。
適切なVODクリップを確実に表示するには、個々のクリップとイベントを埋め込む必要があります。イベントのAPIレスポンスから個々のクリップのIDとデータを取得します。
定期的なイベントには、2つの関連するオブジェクトが含まれています。参照するオブジェクトは、いつデータを取得するかによって異なります。
- live_clips -(配信後)。完了したイベントのすべての動画クリップの配列。これには、イベントが配信されたときの動画IDとエポックタイムスタンプが含まれます。
- streamable_clip -(配信前 / 最中)。これは、配信前 / 配信中のアクティブなクリップです。 IDと埋め込みコードは、配信中の個々のクリップと、結果のVODに対応します。
配信が停止すると、そのクリップ情報は live_clips 配列に移動し、次に配信するクリップの情報を含み streamable_clip が変更されます。
個々の動画クリップまたは1回限りのイベントの詳細を取得する
IDで直接動画クリップにアクセスできます。この方法は、1回限りのイベントまたは個々のVODの詳細にアクセスするために使用されます。ライブがVODに変換されても、IDと埋め込みは変更されません。
個々の動画クリップの詳細:
https://api.vimeo.com/videos/{video_id}
- 「リンク」はURLです
- 「embed」には、クリップの埋め込みプロパティが含まれています
- 「html」はクリップの iframe ソースです
- 「バッジ」には、プレーヤーに通知するクリップに関する情報が含まれています:
- 「ライブ」は「ストリーミング」を示します:true/false またはアーカイブされた true/false
- 「vod」は、vodかどうかを示します。
- 「chat_embed_code」はチャット用の埋め込みコードです。定期的なライブイベント(RLE)の場合は継承される可能性があります。
- 「chat_enabled」はtrue/falseです。定期的なライブイベント(RLE)の場合は継承される可能性があります。
- 「ライブ」にはストリーミングの情報が含まれ、イベント親コンテナに関する情報が含まれます(存在する場合)
詳細はAPIリファレンスをご参照ください。