このトピックでは、Media API の読み取りメソッドが返す Video、Playlist、Image、Rendition、CuePoint、LogoOverlay オブジェクトのリファレンスを提供します。
これらの Media API オブジェクトは、プレーヤ API で使用されるオブジェクトに似ていても、同じものではないことに注意してください。Media API リファレンスには、これらの関連オブジェクトの参照情報も含まれます。
Video オブジェクトは、動画に関連したメタデータとアセット情報の集合体です。Video には以下のプロパティがあります。
| プロパティ名 | 型 | 読み取り専用? | 説明 |
|---|---|---|---|
| name | 文字列 | いいえ | Video のタイトル。255 文字以内。name は、動画を作成するときの必須プロパティです。 |
| id | long | はい | 動画を一意に識別する番号で、動画が作成されたときに Brightcove で自動的に割り当てます。 |
| referenceId | 文字列 | いいえ | Video を一意に識別する、ユーザーが指定した ID。150 文字以内。referenceIｄ は、他のシステムでこの動画を識別するために、外部キーとして使用できます。find_videos_by_reference_ids メソッドは、コンマを含む referenceId を扱うことができないことに注意してください。したがって、referenceId 値ではコンマの使用は避けた方が良いでしょう。 |
| accountId | long | はい | Video が属するアカウントを一意に識別するために、Brightcove によって割り当てられた数値。 |
| shortDescription | 文字列 | いいえ | Video の短い説明文。250 文字以内。shortDescription は、動画を作成するときの必須プロパティです。 |
| longDescription | 文字列 | いいえ | この動画の長い説明文。5,000 文字以内。 |
| FLVURL | 文字列 | はい | この動画の動画ファイルの URL。このプロパティは、Media API で特別な読み取りトークンまたは書き込みトークンを使用しないとアクセスできません。動画のエンコーディングが FLV （VP6）、H.264 のいずれであっても、このプロパティは適用されます。Media API で動画コンテンツにアクセスするを参照してください。 |
| renditions | 配列 | いいえ | この Video で利用可能な多重ビットレート ストリーミング レンディションを表す Renditions の配列。動画には、最大 10 個までのレンディションを含めることができます。このプロパティは、Media API で特別な読み取りトークンまたは書き込みトークンを使用しないとアクセスできません。Media API で動画コンテンツにアクセスするを参照してください。 |
| videoFullLength | レンディション | いいえ | Ｖｉｄｅｏ の動画ファイルを表す、単独のレンディション。このプロパティは、Media API で特別な読み取りトークンまたは書き込みトークンを使用しないとアクセスできません。Media API で動画コンテンツにアクセスするを参照してください。 |
| creationDate | 日付 | はい | この動画が作成された日。UNIX エポックからのミリ秒数で表されます。 |
| publishedDate | 日付 | はい | この Video が最後にアクティブになった日。UNIX エポックからのミリ秒数で表されます。 |
| lastModifiedDate | 日付 | はい | この Ｖｉｄｅｏ が最後に変更された日。UNIX エポックからのミリ秒数で表されます。 |
| itemState | 列挙 | いいえ | ItemStateEnum。次のプロパティのいずれか。ACTIVE、INACTIVE、または DELETED です。このプロパティは、ACTIVE または INACTIVE にしか設定できません。itemState を DELETED に設定しても、動画を削除することはできません。 |
| startDate | 日付 | いいえ | この Video が最初に再生可能になった日。UNIX エポックからのミリ秒数で表されます。 |
| endDate | 日付 | いいえ | この Video が再生可能な最後の日。UNIX エポックからのミリ秒数で表されます。 |
| linkURL | 文字列 | いいえ | 関連アイテムへの URL。255 文字以内。 |
| linkText | 文字列 | いいえ | linkURL に表示する文字列。255 文字以内。 |
| tags | List | いいえ | この動画に割り当てられたタグを表す文字列のリスト。各タグは 128 文字以内で入力します。また、1 本の動画に割り当て可能なタグは最大 1,200 個です。 |
| videoStillURL | 文字列 | はい | この動画の静止画像 URL。静止画像は 480x360 ピクセルです。 |
| thumbnailURL | 文字列 | はい | この動画のサムネイル画像の URL。サムネイルは 120 x 90 ピクセル。 |
| length | long | はい | この動画の長さ（ミリ秒）。 |
| customFields | オブジェクト | いいえ | アカウントの動画に設定されたカスタム フィールドの名前と値のマッピング。詳細および例は、こちらを参照してください。 |
| economics | 列挙 | いいえ | EconomicsEnum。FREE または AD_SUPPORTED。AD_SUPPORTED は、Video で広告要求が有効になっていることを表します。 |
| adKeys | 文字列 | いいえ | 動画に割り当てられた広告のキーと値のペアを表す文字列。キーと値のペアは、「キー=値」のフォーマットを使用し、アンパサンド（&）で区切ります。次に例を示します。 "adKeys":"category=sports&live=true" |
| geoRestricted | ブール値 | いいえ | true は、動画が地域限定であることを意味します。 |
| geoFilteredCountries | List | いいえ | 地域制限ルールを強制的に適用する国の、ISO-3166 の 2 文字コードのリスト。国コードには、アルファベットの小文字を使用します。 |
| geoFilterExclude | ブール値 | いいえ | true にすると、geoFilteredCountries で指定した国を除いて、すべての国でその動画を視聴できます。false にすると、geoFilteredCountries で指定した国でのみ、その動画を視聴できます。 |
| cuePoints | List | いいえ | この Video に割り当てられた CuePoints オブジェクトのリスト。 |
| playsTotal | 整数 | はい | Video が作成されて以来、視聴された回数。 |
| playsTrailingWeek | 整数 | はい | 今日を除いて過去 7 日間に Video が視聴された回数。 |
プレイリスト オブジェクトは、動画 のコレクションです。Playlist には以下のプロパティがあります。
| プロパティ名 | 型 | 読み取り専用? | 説明 |
|---|---|---|---|
| id | long | はい | Playlist を一意に識別する番号。この ID は、プレイリストが作成されたときに自動的に割り当てられます。 |
| referenceId | 文字列 | いいえ | この Playlist を一意に識別するユーザーが指定した ID。150 文字以内。find_playlists_by_reference_ids メソッドは、コンマを含む referenceId を扱うことができないことに注意してください。したがって、referenceId 値ではコンマの使用は避けた方が良いでしょう。 |
| accountId | long | はい | このプレイリストが属するアカウントを一意に識別するため、Brightcove によって割り当てられた数値。 |
| name | 文字列 | いいえ | このプレイリストのタイトル。100 文字以内。名前は、プレイリストを作成するときの必須プロパティです。 |
| shortDescription | 文字列 | いいえ | Playlist の短い説明文。250 文字以内。 |
| videoIds | List | いいえ | Playlist にカプセル化された Video の ID のリスト。 |
| videos | List | いいえ | Playlist にカプセル化された Video オブジェクトのリスト。 |
| playlistType | 列挙 | いいえ |
マニュアル プレイリストでは、これを EXPLICIT に設定します。スマート プレイリストでは、これを次のいずれかに設定し、プレイリストの並べ順を示します。OLDEST_TO_NEWEST (アクティブ化された日について) playlistType は、プレイリストを作成するときの必須プロパティです。 |
| filterTags | List | いいえ | このスマート プレイリストに適用するタグのリスト。たとえば、 "filterTags":["Sitka","ticks"] |
| tagInclusionRule | 列挙 | いいえ | スマート プレイリストについて、動画にfilterTags内のすべての値を含むか、または1つ以上の値を含むかを定義します。「すべてを含む」には AND を、「1 つ以上を含む」には OR を使います。Read API メソッドでは使用できません。 |
| thumbnailURL | 文字列 | はい | このプレイリストのサムネイル画像の URL。 |
このオブジェクトは、アカウント内の画像ファイルに関するメタデータを表します。画像は、サムネイル画像、動画の静止画像、またはロゴ オーバーレイとして、動画と関連付けられています。画像は、JPEG、GIF、または PNG 形式です。新しい画像アセットを作成する際、必要となる唯一のプロパティは type です。ファイルをアップロードしない場合は、remoteUrl プロパティも必要です。詳細は、Media API で動画に画像を追加するおよび Media API を使って動画にロゴ オーバーレイを追加するを参照してください。
| プロパティ名 | 型 | 読み取り専用? | 説明 |
|---|---|---|---|
| id | Long | はい | Image を一意に識別する番号。この ID は、Image が作成されたときに Brightcove によって自動的に割り当てられます。 |
| referenceId | 文字列 | いいえ | この Image を一意に識別するユーザーが指定した ID |
| タイプ | ImageTypeEnum | いいえ | THUMBNAIL、VIDEO_STILL、またはLOGO_OVERLAY。タイプは書き込み可能で、画像を作成するときに必須です。以後は変更できません。 |
| remoteUrl | 文字列 | いいえ | リモートの画像ファイルの URL。このプロパティは、画像アセットのファイルをアップロードしない場合は必須です。 |
| displayName | 文字列 | いいえ | アセットの名前。Media モジュールに表示されます。 |
Rendition オブジェクトは、動画の多重ビットレート ストリーミング レンディションの 1 つを表します。Video には、最大 10 個までの Rendition オブジェクトを含めることができます。詳細は、多重ビットレート ストリーミングを使用するおよび多重ビットレート ストリーミング用の動画を作成するを参照してください。
| プロパティ名 | 型 | 読み取り専用? | 説明 |
|---|---|---|---|
| url | 文字列 | はい | レンディション ファイルの URL |
| audioOnly | ブール値 | いいえ | true にすると、このレンディションは音声のみとなり動画コンテンツがありません。音声のみのレンディションは低帯域接続でのモバイル ストリーミングに使用できます。iOS アプリケーション内の動画は64 Kbps の音声のみのレンディションを含めることを推奨します。 |
| controllerType | 列挙 | いいえ | CDN に応じて、以下のいずれかの値となります。
|
| encodingRate | 整数 | はい | レンディションのエンコーディング レート（単位: bps） |
| frameHeight | 整数 | はい | レンディションのディスプレイの高さ（単位: ピクセル） |
| frameWidth | 整数 | はい | レンディションのディスプレイの幅（単位: ピクセル） |
| size | long | はい | 必須。レンディションのファイル サイズ（単位: バイト） |
| remoteUrl | 文字列 | いいえ | 必須、リモート アセット用。リモート サーバーでホスティングされるファイルへの完全なパス。ファイルがプログレッシブ ダウンロードで提供される場合は、ファイルの名前と拡張子を含める必要があります。また、ファイル名と拡張子を含む URL にリダイレクトする URL を使用することもできます。ファイルが Flash ストリーミングで提供される場合は、remoteStreamName 属性を使用してストリーム名を提供します。 |
| remoteStreamName | 文字列 | いいえ | [任意 - ストリーミングリモートアセットでのみ必要] remoteUrl プロパティの値に付加される、Flash ストリーミングのストリーム名。 |
| videoCodec | 列挙 | いいえ | 必須。有効な値は、SORENSON、ON2、およびH264 です。 |
| videoContainer | 列挙 | いいえ | メタデータを提供し、動画と音声をファイルに保存する方法を記述しているラッパのフォーマット。有効な値は、FLV、MP4、および M2TS です。詳細はサポートされる動画コーデックおよびコンテナを参照してください。 |
| videoDuration | long | いいえ | 必須。リモート動画アセットの長さ（ミリ秒）。 |
Rendition オブジェクトの controllerType フィールドの値は、コンテンツの配信方法と使用している CDN により異なります。仕様可能な controllerType の値を以下に示します。
| controllerType の値 | 説明 |
|---|---|
| AKAMAI_STREAMING | Akamai CDN、ライブではない、TTL なし |
| AKAMAI_SECURE_STREAMING | Akamai CDN、ライブではない、TTL あり |
| AKAMAI_LIVE | Akamai CDN、ライブ、DVR |
| AKAMAI_HD | Akamai HD |
| AKAMAI_HD_LIVE | DVR によるライブ (アカウントの主な CDN が Akamai かどうかに関係なく) |
| LIMELIGHT_LIVE | Limelight CDN、ライブ |
| LIMELIGHT_MEDIAVAULT | Limelight CDN、Limelight の Media Vault サービス オプションを使用 |
CuePoint オブジェクトは、動画内の特定時点を示すマーカーです。キュー ポイントを使用することにより、ミッドロール広告（動画の途中に挟む広告）をトリガすることや、長時間動画を複数のチャプタやシーンに分割することができます。詳細は、動画にキュー ポイントを追加するおよび Media API でキュー ポイントを設定するを参照してください。
| プロパティ名 | 型 | 読み取り専用? | 説明 |
|---|---|---|---|
| name | 文字列 | はい | 必須。キュー ポイントの名前。この名前を使用してキュー ポイントを参照することができます。 |
| videoId | 文字列 | はい | このキュー ポイントを挿入する動画の参照 ID。複数個指定する場合は、参照 ID をコンマで区切ります。 |
| time | Long | はい | 必須。このキュー ポイントの挿入時点（動画の先頭からの経過時間、単位: ミリ秒） |
| forceStop | ブール値 | いいえ | true にすると、キュー ポイントで動画の再生を停止します。この設定は、タイプが AD のキュー ポイントにのみ有効です。 |
| type | 列挙 | はい | 必須。キュー ポイントのタイプに対応する整数コード。0 (AD) または1 (CODE) のいずれか。AD キューポイントは、ミッドロール広告要求をトリガする際に使用します。Code キューポイントは、この動画のチャプタやシーンの区切りを示す際に使用します。 |
| metadata | 文字列 | いいえ | CODE キュー ポイントと一緒に渡すことのできる文字列。512 文字以下。 |
LogoOverlay オブジェクトは、動画に割り当てられたロゴ オーバーレイです。ロゴ オーバーレイは、動画の再生中ずっと動画表示の一部に表示されます。詳細は、ロゴ オーバーレイを作成するおよび Media API を使って動画にロゴ オーバーレイを追加するを参照してください。アカウントのデフォルト ロゴ オーバーレイを設定することもできます。ロゴ オーバーレイをアカウント レベルで設定し、動画にもロゴ オーバーレイを設定している場合、動画に設定されたロゴ オーバーレイが表示されます。アカウント レベルのロゴ オーバーレイは表示されません。
| プロパティ名 | 型 | 説明 |
|---|---|---|
| id | Long | LogoOverlay を一意に識別する番号。この ID は、LogoOverlay が作成されたときに Brightcove によって自動的に割り当てられます。 |
| 画像 | Image | その ID または referenceId と type=LOGO_OVERLAY で定義される、Image オブジェクト。 |
| tooltip | 文字列 | 任意。ロゴ オーバーレイの上にマウス ポインタを置いた際に表示されるテキスト。 |
| linkURL | 文字列 | 任意。ロゴ オーバーレイをクリックした際のリンク先の URL。 |
| alignment | 列挙 | 任意。動画表示に対するロゴ オーバーレイの向きを表す LogoOverlayAlignmentEnum。TOP_LEFT、BOTTOM_LEFT、TOP_RIGHT、または BOTTOM_RIGHT を指定します。デフォルトは BOTTOM_RIGHT です。 |