imgix APIs動画 API概要

動画 API 概要

imgixの動画APIを使用すると、ビデオを自動的にストリーミング可能な形式に変換して、Webプレーヤーを使用して任意のブラウザやデバイスで表示できます。

このドキュメントのこのセクションでは、imgix動画APIで使用可能なすべてのパラメータについて説明し、プレイできるコードサンプルを含めています。ビデオの実装方法に関する詳しい情報は、チュートリアルセクションを参照してください。

ビデオ処理

ビデオがソースのオリジンにアップロードされると、imgixは自動的にオリジンアセット内の新しいビデオファイルを検出して、サービスによって処理されるようにします。まだ処理されていないビデオが要求されると、ビデオURLへのリクエストをエンコードするためにロードが開始され、処理待ちの間は423ステータスコードが返されます。

このドキュメントのこのセクションでは、imgix動画APIで使用可能なすべてのパラメータについて説明し、プレイできるコードサンプルを含めています。ビデオの実装方法に関する詳しい情報は、チュートリアルセクションを参照してください。

新しいビデオが検出されると、imgixはビデオをhls形式に変換し始めます。これにより、ビデオURLにパラメータを適用できるようになります。hls形式についての詳細は、こちらをクリックしてください。

処理時間はビデオの長さによって異なります。処理の進行状況はアセットマネージャーで追跡できます。ビデオは以下のようなstatusの状態でマークされます。

  • Processing: ビデオは現在、サービスによって処理されています。
  • Processed: ビデオは正常に変換され、imgix.videoドメインを介して配信できるようになりました。
  • Error: ビデオの処理中に問題が発生しました。

ビデオは一度だけエンコードされます。その後、変換されたままとなり、Originでビデオファイルに変更が検出されるまで維持されます。ビデオを再処理するには、リフレッシュエンドポイントを使用します。

ビデオは、ビデオが互換性がないか、ビデオにアクセスできない問題がある場合にerror状態を返します。一貫したビデオ変換を確保するために、ビデオがOriginにアップロードされた後にビデオをリネームしたり削除したりしないことをお勧めします。

ビデオキャプション

キャプションは、ビデオがimgixによって処理されたときに自動生成されます。

キャプションの有効化はビデオプレイヤーによって異なりますが、通常、ビデオの右下にキャプションをオンにするオプションがあります。キャプションが利用可能な場合、imgixを含むほとんどのビデオプレイヤーは自動的にそれを認識します。

サポートされている言語のリストは以下の通りです:

  • ブルガリア語
  • カタロニア語
  • クロアチア語
  • チェコ語
  • デンマーク語
  • オランダ語
  • 英語
  • フィンランド語
  • フランス語
  • ドイツ語
  • ギリシャ語
  • イタリア語
  • ノルウェー語
  • ポーランド語
  • ポルトガル語
  • ルーマニア語
  • ロシア語
  • スロバキア語
  • スペイン語
  • スウェーデン語
  • トルコ語
  • ウクライナ語

ビデオ機能が有効になっているソースからダッシュボードでビデオキャプションを有効にすることができます。

Video encoding caption configuration

ビデオの透かし

透かしは、ビデオにロゴや画像を追加する機能であり、ビデオ機能が有効になっているソース設定で構成する必要があります。透かしの位置、サイズ、および不透明度を制御するさまざまな設定があります。

Video encoding watermark configuration

以下の例では、ソース設定でビデオの右下に imgix ロゴ を透かしとして追加するように指定されています。

ビデオの透かし設定を更新するには、更新機能を使用するか、サポート に連絡してビデオを再処理することができます。

ビデオの削除

レンダリングAPIとは異なり、ビデオはOriginでの利用可能性のスキャンが続行されます。ビデオがOriginから削除されると、以下が発生します。

  • ビデオURLは再生をサポートしなくなります。
  • アセットの状態はアセットマネージャーでdeletedに変更されます。

受け入れ可能なビデオファイル形式

どんな種類の動画ファイルでもアップロードできます。ただし、動画をスムーズに再生するために、動画の情報(メタデータ)と、動画が再生されるときの設定(ヘッダー応答)で、動画の種類を正しく指定する必要があります。

単一のアセットの最大持続時間は12時間です。ビデオ入力の標準化に関する詳細については、ビデオパフォーマンスの最適化ガイドを参照してください。

制限

動画のキャッシュ

imgixは動画コンテンツのキャッシュ設定を直接制御しておらず、キャッシュ制御ヘッダーは動画配信に影響を与えません。キャッシュの動作は、HLSの.tsチャンクやMP4レンディションなど、動画フォーマットによって異なる場合があります。また、最適な体験を提供するために、時間とともに進化する可能性があります。

ウェブプレーヤーでのビデオの使用

パラメータが適用されていない場合、.video URLは404応答を返します。 fm=hlsパラメータを適用すると、ビデオがウェブプレーヤーを使用して再生できる形式にフォーマットされます。

以下は、ix-elementsライブラリを使用してimgixビデオをストリーミングするコード例です:

<!-- Note: type 'module' here is important -->
<script
  defer
  type="module"
  src="https://static.imgix.net/ix-player/@latest/dist/ix-player.mjs"
></script>
<ix-player
  gif-preview
  type="hls"
  src="https://assets.imgix.video/videos/girl-reading-book-in-library.mp4?ixembed=docs&fm=hls"
>
</ix-player>

Click here to modify this in a CodeSandbox.