このトピックでは、ApsaraVideo VOD API の基本データ型について説明します。
基本メディアアセット情報
Video:オーディオおよびビデオ情報
名前 | 型 | 説明 |
VideoId | String | オーディオまたはビデオの ID。 |
Title | String | オーディオまたはビデオのタイトル。 |
Description | String | オーディオまたはビデオの説明。 |
Duration | Float | オーディオまたはビデオの長さ。単位:秒。 |
CoverURL | String | オーディオまたはビデオのサムネイル URL。 |
String | オーディオまたはビデオのステータス。詳細については、「Status:オーディオまたはビデオファイルのステータス」をご参照ください。 | |
CreationTime | String | オーディオまたはビデオが作成された時刻。時刻は UTC である必要があります。 |
Size | Long | ソースファイルのサイズ。単位:バイト。 |
Snapshots | String[] | ビデオスナップショットの URL。 |
CateId | Long | オーディオまたはビデオのカテゴリ ID。 |
CateName | String | オーディオまたはビデオのカテゴリ名。 |
Tags | String | オーディオまたはビデオのタグ。複数のタグはコンマ (,) で区切ります。 |
TemplateGroupId | String | オーディオまたはビデオファイルのトランスコーディングに使用されるトランスコーディングテンプレートグループの ID。 |
StorageLocation | String | オーディオまたはビデオファイルのストレージの場所。 |
String | アプリケーションの ID。 |
Status:オーディオおよびビデオのステータス
値 | 説明 | 備考 |
Uploading | アップロード中 |
|
UploadFail | アップロード失敗 |
|
UploadSucc | アップロード完了 |
|
Transcoding | トランスコード中 | このステータスのメディアファイルはトランスコーディング中です。ビデオが初期トランスコーディング中の場合、有効な再生ストリームは利用できず、API 操作を呼び出して再生 URL を取得することはできません。トランスコーディングのステータスは、「単一解像度トランスコーディング完了」または「トランスコーディング完了」イベント通知を使用して判断できます。 |
TranscodeFail | トランスコード失敗 | トランスコーディングの失敗は、通常、ソースファイルのエラーが原因です。エラーメッセージは、「単一解像度トランスコーディング完了」または「トランスコーディング完了」イベント通知から取得できます。トランスコーディングの失敗のトラブルシューティング方法の詳細については、「トランスコーディングに関するよくある質問」をご参照ください。 |
Checking | 審査中 |
説明 ここでの審査中ステータスは、オーディオまたはビデオファイルのステータス (ApsaraVideo VOD コンソール > メディアアセット > オーディオ/ビデオのステータス列で表示可能) を示します。これは、機械支援モデレーションの審査中ステータス (ApsaraVideo VOD コンソール > 審査管理 > ビデオ審査で表示可能) とは異なります。機械支援モデレーションの審査中ステータスは機械審査ジョブのステータスのみを示し、オーディオまたはビデオファイルの審査中ステータスは機械支援と手動の両方の審査ジョブのステータスを示します。 |
Blocked | ブロック済み |
|
Normal | 通常 |
|
ProduceFail | 合成失敗 | これは、ビデオクリップの制作が失敗したことを示します。ApsaraVideo VOD のオンライン編集を使用してビデオクリップを制作する場合、使用されるすべてのメディアアセットが通常ステータスであることを確認してください。そうしないと、ビデオ制作が失敗する可能性があります。 |
ImageInfo:画像情報
名前 | 型 | 説明 |
ImageId | String | 画像の ID。 |
URL | String | 画像の URL。高速化ドメイン名が設定されている場合は CDN URL が返され、そうでない場合は Object Storage Service (OSS) URL が返されます。 |
Title | String | 画像のタイトル。 |
Tags | String | 画像のタグ。 |
ImageType | String | 画像のタイプ。 |
CateId | Long | カテゴリの ID。 |
CateName | String | カテゴリの名前。 |
Description | String | 説明。 |
StorageLocation | String | ストレージの場所。 |
Mezzanine | 画像のソースファイル情報。 | |
CreationTime | String | 画像が作成された時刻。時刻は UTC です。 |
String | 画像のステータス。詳細については、「Status:画像のステータス」をご参照ください。 | |
String | アプリケーションの ID。 |
Status:画像のステータス
値 | 説明 | 備考 |
Uploading | アップロード中 | これは画像の初期ステータスで、アップロード中であることを示します。画像が長期間このステータスのままである場合は、「アップロードしたファイルが常にアップロード中のステータスになるのはなぜですか?」をご参照ください。 |
UploadFail | 画像のアップロードに失敗しました。 | ネットワークの問題やソースファイルの破損により、アップロードが失敗することがあります。再試行するか、別のソースファイルをアップロードしてください。 |
Normal | 通常 | 画像のアップロードが成功しました。 |
AttachedMediaInfo:補助メディアアセットの情報
名前 | 型 | 説明 |
MediaId | String | 補助メディアアセットの ID。 |
URL | String | 補助メディアアセットの URL。CDN のドメイン名が指定されている場合は CDN URL が返され、そうでない場合は OSS URL が返されます。 |
Title | String | タイトル。 |
Tags | String | タグ。 |
Type | String | 補助メディアアセットのタイプ。 |
Categories | Category[] | カテゴリ。 |
Description | String | 説明 |
StorageLocation | String | ストレージの場所。 |
CreationTime | String | 補助メディアアセットが作成された時刻。時刻は UTC である必要があります。 |
ModificationTime | String | 補助メディアアセットが最後に変更された時刻。時刻は UTC である必要があります。 |
String | 補助メディアアセットのステータス。詳細については、「Status:補助メディアアセットのステータス」をご参照ください。 | |
String | アプリケーションの ID。 |
Status:補助メディアアセットのステータス
値 | 説明 | 説明 |
Uploading | アップロード中 | 初期ステータス。補助メディアアセットはアップロード中です。 |
Normal | 通常 | 補助メディアアセットは正常にアップロードされました。 |
UploadFail | 失敗 | 補助メディアアセットのアップロードに失敗しました。 |
メディアリソースファイル情報
Mezzanine:オーディオおよびビデオのソースファイル情報
名前 | 型 | 説明 |
VideoId | String | ビデオの ID。 |
FileName | String | ファイルの名前。 |
Duration | String | ファイルの長さ (秒)。 |
Status | String | ソースファイルのステータス。詳細については、「Status:オーディオまたはビデオのソースファイルのステータス」をご参照ください。 |
CreationTime | String | ファイルが作成された時刻。時刻は UTC です。 |
Height | Long | ファイルの高さ (ピクセル単位)。 |
Width | Long | ファイルの幅 (ピクセル単位)。 |
Fps | String | ファイルのフレームレート (fps)。 |
FileURL | String | ファイルの URL。 |
Bitrate | String | ファイルのビットレート (Kbps)。 |
Size | Long | ファイルのサイズ (バイト)。 |
OutputType | String | 出力ファイルのタイプ。有効な値:
|
VideoStreamList | ビデオストリーム情報のリスト。 | |
AudioStreamList | オーディオストリーム情報のリスト。 |
VideoStream:ビデオストリーム情報
名前 | 型 | 説明 |
Index | String | ビデオストリームの序数。これは、メディアストリーム内のビデオストリームの位置を識別します。 |
CodecName | String | エンコード形式の短縮名。 |
CodecLongName | String | エンコード形式の正式名。 |
Profile | String | コーデックプロファイル。 |
CodecTimeBase | String | コーデックタイムベース。 |
CodecTagString | String | エンコード形式のタグテキスト。 |
CodecTag | String | エンコード形式のタグ。 |
Width | Long | ビデオ解像度の幅。 |
Height | Long | ビデオ解像度は高いです。 |
HasBFrames | String | ストリームに B フレームがあるかどうかを示します。 |
Sar | String | エンコード信号の解像度比。 |
Dar | String | 表示アスペクト比 (DAR)。 |
PixFmt | String | ピクセルフォーマット。 |
Level | String | エンコーディングレベル。 |
Fps | String | ターゲットフレームレート。 |
AvgFPS | String | 平均フレームレート。 |
Timebase | String | タイムベース。 |
StartTime | String | 開始時刻。 |
Duration | String | 期間。 |
NumFrames | String | 総フレーム数。 |
Lang | String | 言語。 |
Rotate | String | ビデオの回転角度。値は [0, 360) の範囲内である必要があります。 |
AudioStream:オーディオストリーム情報
名前 | 型 | 説明 |
Index | String | オーディオストリームの序数。これは、メディアストリーム内のオーディオストリームの位置を識別します。 |
CodecName | String | エンコード形式の短縮名。 |
CodecLongName | String | エンコード形式の正式名。 |
CodecTimeBase | String | コーデックタイムベース。 |
CodecTagString | String | エンコード形式のタグテキスト。 |
CodecTag | String | エンコード形式のタグ。 |
SampleFmt | String | サンプリングフォーマット。 |
SampleRate | String | サンプルレート。 |
Channels | String | サウンドチャンネルの数。 |
ChannelLayout | String | サウンドチャンネルのレイアウト。 |
Timebase | String | タイムベース。 |
StartTime | String | 開始時刻。 |
Duration | String | 期間。 |
Bitrate | String | ビットレート。 |
NumFrames | String | 総フレーム数。 |
Lang | String | 言語。 |
Status:オーディオまたはビデオのソースファイルのステータス
値 | 説明 | 備考 |
Uploading | アップロード中 | ファイルの初期状態。ファイルがアップロード中であることを示します。 |
Normal | 通常 | ファイルは正常にアップロードされました。 |
UploadFail | 失敗 | ファイルのアップロードに失敗しました。 |
Deleted | 削除済み | ファイルは削除されました。 |
Mezzanine:画像ソースファイル情報
名前 | 型 | 説明 |
FileURL | String | 画像の OSS URL。 |
OriginalFileName | String | アップロードされたファイルの名前。 |
FileSize | Long | ファイルサイズ (バイト)。 |
Width | Integer | 画像の幅 (ピクセル単位)。 |
Height | Integer | 画像の高さ (ピクセル単位)。 |
URL に基づいて複数のメディアファイルを一括でアップロード
URLUploadInfo:URL ベースのアップロードジョブに関する情報
名前 | 型 | 説明 |
JobId | String | アップロードジョブの ID。 |
UploadURL | String | アップロードするファイルの URL。 |
MediaId | String | アップロードするファイルの ID。 |
FileSize | String | アップロードするファイルのサイズ。単位:バイト。 |
String | URL ベースのアップロードジョブのステータス。このパラメーターの詳細については、「Status:URL ベースのアップロードジョブのステータス」をご参照ください。 | |
CreationTime | String | ジョブが作成された時刻。 |
CompleteTime | Long | ジョブが完了した時刻。 |
UserData | String | ユーザー定義フィールド。 |
ErrorCode | String | エラーコード |
ErrorMessage | String | エラーメッセージ。 |
Status:URL ベースのアップロードジョブのステータス
値 | 説明 |
PENDING | アップロードジョブが送信され、処理を待っています。 |
PROCESSING | タスクの処理を開始できます。 |
DOWNLOADING | ファイルはダウンロード中です。 |
DOWNLOAD_SUCCESS | ファイルはダウンロードされました。 |
DOWNLOAD_FAIL | ファイルのダウンロードに失敗しました。 |
UPLOADING | ファイルはアップロード中です。 |
UPLOAD_SUCCESS | ファイルはアップロードされました。 |
UPLOAD_FAIL | ファイルのアップロードに失敗しました。 |
SUCCESS | アップロードジョブは成功し、コールバックは完了しました。 |
ビデオとオーディオの再生
VideoBase:基本ビデオ情報
名前 | 型 | 説明 |
VideoId | String | ビデオ ID |
Title | String | ビデオタイトル |
Duration | String | ビデオの長さ (秒)。 |
CoverURL | String | ビデオのサムネイル。 |
String | ビデオまたはオーディオファイルのステータス。 | |
CreationTime | String | ビデオまたはオーディオファイルが作成された時刻。時刻は UTC です。 |
MediaType | MediaType | メディアファイルのタイプ。有効な値:
|
デフォルトでは、再生 API 操作は CDN 高速化 URL を返します。ドメイン名が設定されていない場合、API 操作は OSS ソース URL を返します。この場合、MP4 ファイルの URL のみが再生に使用できます。
PlayInfo:メディアストリームの再生情報
名前 | 型 | 説明 |
Bitrate | String | メディアストリームのビットレート (Kbps)。 |
Definition | String | メディアストリームの定義。有効な値:
|
Specification | String | ビデオおよびオーディオのトランスコーディングの出力仕様。詳細については、「出力仕様」をご参照ください。 |
Duration | String | メディアストリームの長さ (秒)。 |
Encrypt | Long | メディアストリームが暗号化されているかどうかを示します。有効な値:
|
EncryptType | String | メディアストリームの暗号化タイプ。有効な値:
|
PlayURL | String | メディアストリームの再生 URL。 |
Format | String | メディアストリームのフォーマット。 メディアファイルがビデオの場合、有効な値は次のとおりです:
メディアファイルがオーディオのみの場合、有効な値は mp3 です。 |
Fps | String | メディアストリームのフレームレート (fps)。 |
Size | Long | メディアストリームのサイズ (バイト)。 |
Width | Long | メディアストリームの幅 (ピクセル単位)。 |
Height | Long | メディアストリームの高さ (ピクセル単位)。 |
StreamType | String | メディアストリームのタイプ。
|
JobId | String | メディアストリームのトランスコーディングジョブの ID。この ID は、メディアストリームの一意の識別子です。 |
WatermarkId | String | メディアストリームに関連付けられているウォーターマークの ID。 |
Status | String | メディアストリームのステータス。有効な値:
|
NarrowBandType | String | ナローバンド HD のタイプ。有効な値:
このパラメーターは、組み込みのナローバンド HD 1.0 トランスコーディングテンプレートの解像度が設定されている場合にのみ有効です。詳細については、「TranscodeTemplate:トランスコーディングテンプレートの設定」をご参照ください。 |
CreationTime | String | ストリームが作成された時刻。時刻は UTC です。 |
ModificationTime | String | ストリームが最後に更新された時刻。時刻は UTC です。 |
VideoMeta:ビデオメタデータ
名前 | 型 | 説明 |
VideoId | String | ビデオの ID。 |
Title | String | ビデオのタイトル。 |
Duration | Float | ビデオの長さ (秒)。 |
CoverURL | String | ビデオのサムネイル。 |
String | ビデオのステータス。 |
メディアアセットのクエリ
Media:メディアアセットに関する情報
名前 | 型 | 説明 |
MediaId | String | メディアアセットの ID。 |
CreationTime | String | メディアアセットが作成された時刻。時刻は UTC である必要があります。 |
MediaType | String | メディアアセットのタイプ。有効な値:
|
Video | ビデオに関する情報。 | |
Audio | オーディオに関する情報。 | |
Image | 画像に関する情報。 | |
AttachedMedia | 補助メディアアセットに関する情報。 |
メディアアセットのカテゴリ
Category:メディアアセットの分類
名前 | 型 | 説明 |
CateId | Long | カテゴリの ID。 |
CateName | String | カテゴリの名前。値は最大 64 バイトの長さで、UTF-8 形式でエンコードする必要があります。 |
ParentId | Long | 親カテゴリの ID。レベル 1 カテゴリの親カテゴリ ID は -1 です。 |
Level | Long | カテゴリのレベル。値 0 はレベル 1 カテゴリを示します。 |
Live to VOD
LiveRecordVideo:Live to VOD 録画に関する情報
名前 | 型 | 説明 |
StreamName | String | ライブストリームの名前。 |
DomainName | String | ドメイン名。 |
AppName | String | アプリケーションの名前。 |
PlaylistId | String | 再生リストの ID。 |
RecordStartTime | String | 録画の開始時刻。 |
RecordEndTime | String | 録画の終了時刻。 |
Video | Video | ビデオ情報。 |
オンライン編集
EditingProject:オンライン編集プロジェクト
名前 | 型 | 説明 |
ProjectId | String | オンライン編集プロジェクトの ID。 |
Title | String | オンライン編集プロジェクトのタイトル。 |
CreationTime | String | オンライン編集プロジェクトが作成された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。 たとえば、値 2017-01-11T12:00:00Z は、北京時間 (UTC+8) の 2017 年 1 月 11 日 20:00:00 を示します。 |
ModifiedTime | String | オンライン編集プロジェクトの最終変更時刻。時刻は UTC で、yyyy-MM-ddTHH:mm:ssZ 形式を使用します。 たとえば、2017-01-11T12:00:00Z (これは 2017 年 1 月 11 日 20:00:00、UTC+8) です。 |
Status | String | オンライン編集プロジェクトのステータス。 |
Description | String | オンライン編集プロジェクトの説明。 |
Timeline | String | オンライン編集プロジェクトのタイムライン。値は JSON 文字列です。 |
Duration | String | オンライン編集プロジェクトの総時間。タイムラインの総時間と同じでなければなりません。 |
CoverURL | String | オンライン編集プロジェクトのサムネイル URL。 |
ProjectStatus:オンライン編集プロジェクトのステータス
値 | 説明 | 備考 |
Normal | 下書き | これはオンライン編集プロジェクトの初期ステータスです。 |
Producing | レンダリング中 | なし。 |
Produced | ビデオ制作は成功しました。 | なし。 |
ProduceFailed | 合成に失敗しました。 | なし。 |
Material:オンライン編集プロジェクトの素材情報
このタイプは、素材管理モジュールの素材とメディアライブラリのビデオの両方を含む、広範な素材を指します。
名前 | 型 | 説明 |
MaterialId | String | 素材の ID。 |
Title | String | 素材のタイトル。 |
Description | String | 素材の説明。 |
Duration | Float | 素材の長さ (秒)。値は小数点以下 4 桁まで正確です。 |
CoverURL | String | 素材のサムネイル URL。 |
Status | String | 素材のステータス。 |
CreationTime | String | 素材が作成された時刻。時刻は UTC で表示されます。 |
Size | Long | ソースファイルのサイズ (バイト)。 |
CateId | Long | 素材カテゴリ ID。 |
CateName | String | 素材カテゴリ名。 |
Tags | String | 素材のタグ。複数のタグはコンマ (,) で区切ります。 |
Snapshots | String[] | 素材のスナップショット URL の配列。 |
Sprites | String[] | 素材のスプライト URL の配列。 |
ProduceConfig:ビデオ制作設定
名前 | 型 | 説明 |
TemplateGroupId | String | 制作されたビデオファイルのトランスコーディングに使用されるトランスコーディングテンプレートグループの ID。制作されたビデオはトランスコーディングのソースファイルとして機能します。このプロセスは、ファイルアップロード完了後に実行されるトランスコーディングに似ています。 このフィールドはオプションです。空の場合、トランスコーディング設定のデフォルトテンプレートグループが使用されます。指定された場合、指定されたテンプレートグループが使用されます。テンプレートグループ ID を表示するには、ApsaraVideo VOD コンソールの [トランスコーディング設定] に移動します。 |
TemplateId | String | メディアリソースのソースファイルを生成するためのビデオ合成に使用される合成テンプレート ID。このフィールドはオプションです。値が空の場合、組み込みのオンライン編集テンプレートが合成に使用されます。 合成ターゲットがビデオファイルの場合、組み込みテンプレートのエンコード形式は H.264、コンテナフォーマットは MP4 です。 アニメーション画像合成、インテリジェント字幕、M3U8 クイック編集、またはカスタム合成パラメータサポートなど、合成パラメータを指定する他の要件がある場合は、チケットを送信して申請してください。 |
Width | Integer | 出力ビデオの幅 (ピクセル単位)。 このパラメータはオプションです。デフォルトでは、出力ビデオの解像度は、タイムライン内のすべてのソースファイルから最大幅と最大高を使用して設定されます。 たとえば、タイムラインに 1280 × 720 ピクセル、1920 × 1080 ピクセル、720 × 1280 ピクセルの 3 つのソースファイルが含まれている場合、出力ビデオの解像度は 1920 × 1280 ピクセルになります。 |
Height | Integer | 出力ビデオの高さ (ピクセル単位)。 このパラメータはオプションです。デフォルトでは、出力解像度は、タイムライン内のすべてのソースファイルから最大幅と最大高を使用して設定されます。 たとえば、タイムラインが 1280×720、1920×1080、720×1280 の 3 つのソースファイルを使用する場合、出力ビデオの解像度は 1920×1280 になります。 |
Bitrate | Integer | 制作されたビデオのビットレート。単位:Kbit/s。 このパラメータはオプションです。デフォルト値は、タイムラインで指定したソースファイルの最大ビットレートです。 たとえば、タイムラインに 3 つの素材を指定し、ソースファイルのビットレートが 400、600、800 Kbit/s の場合、制作されたビデオのデフォルトのビットレートは 800 Kbit/s になります。 |
StorageLocation | String | ファイルのストレージの場所。このパラメータは、中国 (上海) 以外のリージョンで必須です。 |
MediaMetadata:制作されたビデオのメタデータ
名前 | 型 | 説明 |
Title | String | 制作されたビデオのタイトル。値は最大 128 バイトの長さで、UTF-8 でエンコードする必要があります。 |
Description | String | 制作されたビデオの説明。値は最大 1,024 バイトの長さで、UTF-8 でエンコードする必要があります。 |
CoverURL | String | 制作されたビデオのカスタムサムネイルの URL。 |
CateId | String | 制作されたビデオのカテゴリ ID。ApsaraVideo VOD コンソールにログインします。左側のナビゲーションウィンドウで、設定管理 > メディア管理 > カテゴリを選択します。 |
Tags | String | 制作されたビデオのタグ。各タグ名は最大 32 バイトの長さです。最大 16 個のタグを指定できます。複数のタグはコンマ (,) で区切ります。文字列は UTF-8 形式でエンコードする必要があります。 |
オンライン編集 - タイムライン (新しいエディタ用)
オンライン編集機能はリージョンによって異なります。この機能を使用する前に、ご利用のサービスリージョンが対応していることを確認してください。詳細については、「サービスリージョン」をご参照ください。旧エディタのオンライン編集データ型に関するパラメータの説明については、「オンライン編集データ型 (旧エディタ用)」をご参照ください。
Timeline:タイムライン情報
タイムラインは、ビデオの創造的なビジョンに基づいてメディアアセットを配置し、エフェクトを適用した結果です。主に、トラック、メディアアセット、エフェクトの 3 種類のオブジェクトが含まれます。
名前 | 型 | 必須 | 説明 |
VideoTracks | いいえ。VideoTracks が空の場合、AudioTracks は空であってはなりません。 | ビデオトラックのリスト。複数のトラックの重ね順は、配列要素の順序に従います。たとえば、最初の配列要素のレイヤーが一番下に表示され、2 番目の要素のレイヤーがその上に表示される、というようになります。 | |
AudioTracks | いいえ。AudioTracks が空の場合、VideoTracks は空であってはなりません。 | オーディオトラックのリスト。 | |
SubtitleTracks | いいえ | 字幕トラックのリスト。 | |
EffectTracks | いいえ | エフェクトトラックのリスト。 |
VideoTrack:ビデオトラック情報
VideoTrack は、ビデオや画像素材を含む、画像ベースのメディアアセットを配置します。
名前 | 型 | 必須 | 説明 |
Type | String | いいえ | デフォルトは標準ビデオトラックです。 Type=Effect の場合、現在のトラックはエフェクトトラックとして機能します。この場合、VideoTrackClips には EffectTrackItem を含めることができます。 |
MainTrack | Boolean | いいえ | 現在のトラックがメイントラックかどうかを指定します。デフォルトは False です。 |
VideoTrackClips | はい | ビデオトラックメディアクリップのリスト。 |
AudioTrack:オーディオトラック情報
AudioTrack は、オーディオのみのファイルやオーディオストリームを含むビデオなど、オーディオベースのメディアアセットを配置します。
名前 | 型 | 必須 | 説明 |
MainTrack | Boolean | いいえ | 現在のトラックがメイントラックかどうかを指定します。デフォルトは False です。 |
AudioTrackClips | はい | オーディオトラックメディアクリップのリスト。 |
SubtitleTrack:字幕トラック情報
SubtitleTrack は、バナーテキストや外部字幕ファイルを含む字幕を配置します。
名前 | 型 | 必須 | 説明 |
SubtitleTrackClips | はい | 字幕トラックメディアクリップのリスト。 |
EffectTrack:エフェクトトラック情報
EffectTrack は、ビデオ全体にグローバルエフェクトを追加し、フィルターと VFX をサポートします。
名前 | 型 | 必須 | 説明 |
EffectTrackItems | はい | エフェクトトラックアイテムのリスト。 |
VideoTrackClip:ビデオトラックメディア情報
VideoTrackClip には、ビデオと画像の両方のメディアアセットが含まれます。
In、Out、TimelineIn、TimelineOut は、ソースクリップの開始点と終了点、およびタイムライン上の配置を示します。たとえば、ビデオの 5〜10 秒のセグメントをタイムラインの 15〜20 秒の位置に配置するには、In=5、Out=10、TimelineIn=15、TimelineOut=20 と設定できます。
名前 | 型 | 必須 | 説明 |
MediaId | String | いいえ | ビデオトラッククリップのメディア ID。一部のコンテキストでは、これは VideoId (ビデオ/オーディオ用) または ImageId (画像用) とも呼ばれます。 |
Type | String | いいえ | メディアクリップのタイプ。デフォルトは Video です。 有効な値:
|
X | Float | いいえ | 画像またはビデオの左上隅から出力ビデオの左上隅までの水平距離。パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの幅のパーセンテージを表し、≥2 の整数は絶対ピクセルを表します。 |
Y | Float | いいえ | 画像またはビデオの左上隅から出力ビデオの左上隅までの垂直距離。パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの高さのパーセンテージを表し、≥2 の整数は絶対ピクセルを表します。 |
Width | Float | いいえ | 出力ビデオ内の画像の幅。パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの幅のパーセンテージを表し、≥2 の整数は絶対ピクセルを表します。 |
Height | Float | いいえ | 出力ビデオ内の画像の高さ。パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの高さのパーセンテージを表し、≥2 の整数は絶対ピクセルを表します。 |
AdaptMode | String | いいえ | ビデオスケーリングモード。デフォルトは Fill です。このモードは、ビデオトラックに Width と Height の両方が設定されている場合にのみ有効です。この場合、Width と Height はターゲット領域のディメンションを定義し、ビデオはその領域内で適応的にスケーリングされます。
|
In | Float | いいえ | ソースメディアに対するクリップの開始時刻。オーディオ/ビデオソースにのみ適用されます。単位:秒、小数点以下 4 桁まで正確。指定しない場合はデフォルトで 0 になります。 |
Out | Float | いいえ | ソースメディアに対するクリップの終了時刻。オーディオ/ビデオソースにのみ適用されます。単位:秒、小数点以下 4 桁まで正確。指定しない場合は、ソースの全長がデフォルトになります。 |
MaxOut | Float | いいえ | ソースメディアに対するクリップの最大終了時刻。設定されている場合、実際の Out ポイントはソースの長さまたは MaxOut の小さい方になります。オーディオ/ビデオソースにのみ適用されます。単位:秒、小数点以下 4 桁まで正確。Out が指定されている場合、MaxOut は無視されます。 |
Duration | Float | いいえ | クリップの長さ。通常、画像ソースに使用されます。単位:秒、小数点以下 4 桁まで正確。 |
DyncFrames | Int | いいえ | アニメーション画像のフレームレート。ソースがアニメーション画像の場合にのみ適用されます。 |
TimelineIn | Float | いいえ | タイムライン上のクリップの開始時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合、TimelineIn はシーケンシャル配置に基づいて自動的に計算されます。 |
TimelineOut | Float | いいえ | タイムライン上のクリップの終了時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合、TimelineOut はシーケンシャル配置に基づいて自動的に計算されます。 |
Speed | Float | いいえ | ビデオクリップの再生速度。有効範囲:0.1–100。たとえば、Speed=2 はクリップを 2 倍速で再生し、最終出力での長さを半分にします。 |
MaskVideoUrl | String | いいえ | マスクビデオの URL。通常、アルファチャンネルを持つビデオで、元のビデオに透明効果を追加するために使用されます。 パブリック OSS URL のみがサポートされています。 |
Effects | Effect[] | いいえ | クリップに適用されるエフェクトのリスト。 |
AudioTrackClip:オーディオトラックメディア情報
AudioTrackClip には、オーディオのみのファイルと、オーディオストリームを含むビデオが含まれます。
In、Out、TimelineIn、TimelineOut は、ソースクリップの開始点と終了点、およびタイムライン上の配置を示します。たとえば、ビデオの 5〜10 秒のセグメントをタイムラインの 15〜20 秒の位置に配置するには、In=5、Out=10、TimelineIn=15、TimelineOut=20 と設定できます。
名前 | 型 | 必須 | 説明 |
MediaId | String | いいえ | オーディオトラッククリップのメディア ID。 |
In | Float | いいえ | ソースメディアに対するクリップの開始時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合はデフォルトで 0 になります。 |
Out | Float | いいえ | ソースメディアに対するクリップの終了時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合は、ソースの全長がデフォルトになります。 |
TimelineIn | Float | いいえ | タイムライン上のクリップの開始時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合、TimelineIn はシーケンシャル配置に基づいて自動的に計算されます。 |
TimelineOut | Float | いいえ | タイムライン上のクリップの終了時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合、TimelineOut はシーケンシャル配置に基づいて自動的に計算されます。 |
Speed | Float | いいえ | オーディオクリップの再生速度。有効範囲:0.1–100。たとえば、Speed=2 はクリップを 2 倍速で再生し、最終出力での長さを半分にします。 |
Effects | Effect[] | いいえ | クリップに適用されるエフェクトのリスト。 |
LoopMode | Boolean | いいえ | タイムライン上のクリップのループ再生動作。True はループ再生を有効にします。False (デフォルト) はループを無効にします。 |
SubtitleTrackClip:字幕トラックメディア情報
SubtitleTrackClip には、字幕メディアアセットが含まれます。
名前 | 型 | 必須 | 説明 |
Type | String | はい | 字幕メディアのタイプ。有効な値:
|
SubType | String | いいえ | 字幕メディアのサブタイプ。有効な値:
Type が Text の場合は、このフィールドを無視してください。 |
FileURL | String | いいえ | 字幕ファイルの OSS URL。Type が Subtitle の場合は必須です。フォーマット: https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.srt 説明 FileURL はパブリック OSS URL のみをサポートします。高速化された OSS URL、CDN URL、およびその他の HTTP URL はサポートされていません。 |
X | Float | いいえ | Type が Text の場合、テキストの左上隅から出力ビデオの左上隅までの水平距離。パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの幅のパーセンテージを表し、>=2 の整数は絶対ピクセルを表します。 |
Y | Float | いいえ | Type が Text の場合、テキストの左上隅から出力ビデオの左上隅までの垂直距離。パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの高さのパーセンテージを表し、>=2 の整数は絶対ピクセルを表します。 |
TimelineIn | Float | いいえ | Type が Text の場合、タイムライン上のテキストの開始時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合、TimelineIn はシーケンシャル配置に基づいて自動的に計算されます。 |
TimelineOut | Float | いいえ | Type が Text の場合、タイムライン上のテキストの終了時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合、TimelineOut はシーケンシャル配置に基づいて自動的に計算されます。 |
Content | String | いいえ | Type が Text の場合、必須です。テキストコンテンツを指定します。 |
Font | String | いいえ | Type が Text の場合、フォントを指定します。デフォルトは SimSun です。サポートされているフォントの完全なリストについては、「フォントリスト」をご参照ください。 |
FontSize | Int | いいえ | キャプションタイプがバナーテキストの場合、フォントサイズを指定します。 |
FontColor | String | いいえ | Type が Text の場合、16 進数形式でフォントの色を指定します (# の後に 16 進数が続きます)。例:#ffffff。 |
FontColorOpacity | String | いいえ | Type が Text の場合、フォントの透明度を指定します。有効範囲:0–1。デフォルトは 1 (不透明) です。0 は完全に透明を意味します。 |
FontFace | いいえ | Type が Text の場合、フォントスタイルを指定します。 | |
Spacing | Int | いいえ | Type が Text の場合、文字間隔を指定します。単位:ピクセル。デフォルトは 0 です。 |
Angle | Float | いいえ | Type が Text の場合、反時計回りの回転角度を指定します。単位:度。デフォルトは 0 です。 |
BorderStyle | Int | いいえ | バナーテキストの境界線と影のスタイルを指定します。有効な値:1 または 3。1 = 境界線 + 影。3 = 不透明な背景ボックス。デフォルトは 1 です。 |
Outline | Int | いいえ | Type が Text の場合、ストローク幅を指定します。単位:ピクセル。デフォルトは 0 です。 |
OutlineColour | String | いいえ | Type が Text の場合、16 進数形式でストロークの色を指定します (# の後に 16 進数が続きます)。例:#ffffff。 |
Shadow | Int | いいえ | Type が Text の場合、影の深さを指定します。単位:ピクセル。デフォルトは 0 です。 |
BackColour | String | いいえ | Type が Text の場合、16 進数形式で影の色を指定します (# の後に 16 進数が続きます)。例:#ffffff。 |
Alignment | String | いいえ | Type が Text の場合、テキストの配置を指定します。デフォルトは TopLeft です。有効な値:
|
AdaptMode | String | いいえ | バナーテキストがビデオの幅または指定された TextWidth を超えた場合の適応方法を指定します。有効な値:
|
TextWidth | Integer | いいえ | 字幕テキストボックスの幅。AdaptMode が設定されている場合にのみ有効です。自動改行またはスケーリングでは、この幅が使用されます。指定しない場合は、ビデオの幅が使用されます。単位:ピクセル。 |
FontUrl | String | いいえ | Type が Text の場合、OSS バケットからカスタムフォントファイルをサポートします。サポートされている形式:ttf、otf、woff。例:https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf |
EffectColorStyle | String | いいえ | Type が Text の場合、ワードアートスタイルを指定します。 ワードアートのスタイルと効果については、「ワードアート効果の例」をご参照ください。 |
AaiMotionInEffect | String | いいえ | Type が Text の場合、入場アニメーションエフェクトを指定します。 入場エフェクトのタイプと例については、「入場エフェクト」をご参照ください。 |
AaiMotionIn | Float | いいえ | Type が Text の場合、入場エフェクトの持続時間を指定します。単位:秒、小数点以下 4 桁まで正確。指定しない場合はデフォルトで 0.5 秒になります。テキストの総持続時間が 0.5 秒未満の場合、入場持続時間は総持続時間から退場持続時間を引いたものになります。 |
AaiMotionOutEffect | String | いいえ | 字幕タイプがバナーの場合、バナーテキストの入場エフェクトを指定します。 キャプションの入場エフェクトのタイプと効果については、「入場エフェクト」をご参照ください。 |
AaiMotionOut | Float | いいえ | Type が Text の場合、退場エフェクトの持続時間を指定します。単位:秒、小数点以下 4 桁まで正確。指定しない場合はデフォルトで 0.5 秒になります。テキストの総持続時間が 0.5 秒未満の場合、退場持続時間はテキストの総持続時間と同じになります。 |
AaiMotionLoopEffect | String | いいえ | Type が Text の場合、ループアニメーションエフェクトを指定します。入場または退場エフェクトと併用することはできません。 ループエフェクトのタイプと例については、「ループエフェクト」をご参照ください。 |
Ratio | Float | いいえ | Type が Text の場合、ループエフェクトの再生速度を指定します。小数点以下 4 桁まで正確。指定しない場合はデフォルトで 1 になります。1 より大きい値はループを速くし、1 より小さい値はループを遅くします。 |
EffectTrackItem:エフェクトトラックアイテム情報
EffectTrackItem には、VFX とフィルターエフェクトが含まれます。
名前 | 型 | 必須 | 説明 |
Type | String | はい | エフェクトトラックアイテムのタイプ。有効な値:VFX、Filter。 |
SubType | String | はい | エフェクトトラックアイテムのサブタイプ。サポートされているエフェクトタイプと例については、「特殊効果の例」および「フィルター効果の例」をご参照ください。 |
TimelineIn | Float | いいえ | タイムライン上のエフェクトの開始時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合はデフォルトで 0 になります。 |
TimelineOut | Float | いいえ | タイムライン上のエフェクトの終了時刻。単位:秒、小数点以下 4 桁まで正確。指定しない場合は、ビデオの終了時刻がデフォルトになります。 |
Duration | Float | いいえ | タイムライン上のエフェクトの持続時間。単位:秒、小数点以下 4 桁まで正確。指定しない場合は、ビデオの持続時間がデフォルトになります。 説明 Duration または TimelineOut のいずれか一方のみが有効です。 |
X | Float | いいえ | SubType が mosaic_rect または blur の場合にのみ適用されます。エフェクト領域の左上隅から出力ビデオの左上隅までの水平距離。 パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの幅のパーセンテージを表し、≥2 の整数は絶対ピクセルを表します。 |
Y | Float | いいえ | SubType が mosaic_rect または blur の場合にのみ適用されます。 エフェクト領域の左上隅から出力ビデオの左上隅までの垂直距離。パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの高さのパーセンテージを表し、≥2 の整数は絶対ピクセルを表します。 |
Width | Float | いいえ | SubType が mosaic_rect または blur の場合にのみ適用されます。出力ビデオ内のエフェクト領域の幅。パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの幅のパーセンテージを表し、≥2 の整数は絶対ピクセルを表します。 |
Height | Float | いいえ | SubType が mosaic_rect または blur の場合にのみ適用されます。出力ビデオ内のエフェクト領域の高さ。パーセンテージまたはピクセル値をサポートします。[0–0.9999] の間の値は出力ビデオの高さのパーセンテージを表し、≥2 の整数は絶対ピクセルを表します。 |
FontFace:フォントスタイル
名前 | 型 | 必須 | 説明 |
Bold | Boolean | いいえ | 太字。 |
Italic | Boolean | いいえ | 斜体。 |
Underline | Boolean | いいえ | 下線。 |
Effect:エフェクト情報
異なるエフェクトタイプには独自プロパティがありますが、共通の属性も共有しています。
個々の Effect プロパティの詳細な説明については、「エフェクト設定リファレンス」をご参照ください。
共通の Effect プロパティは次のとおりです:
名前 | 型 | 必須 | 説明 |
Type | String | はい | エフェクトタイプ。有効な値:
|
SubType | String | いいえ | エフェクトのサブタイプ。
|
ビデオスナップショットと動的画像
SnapshotJob:スナップショットジョブ情報
名前 | 型 | 説明 |
JobId | String | ジョブ ID。 |
VodTemplateInfo:スナップショットテンプレート情報
名前 | 型 | 説明 |
Name | String | テンプレート名。 |
VodTemplateId | String | テンプレート ID。 |
TemplateType | String | テンプレートタイプ。有効な値:
|
IsDefault | String | これがデフォルトのウォーターマークであるかどうかを示します。有効な値:
|
TemplateConfig | JSON | テンプレートの詳細な設定。値は JSON 文字列である必要があります。
|
CreationTime | String | テンプレートが作成された時刻。時刻は UTC 形式です。 |
ModifyTime | String | テンプレートが最後に変更された時刻。時刻は UTC 形式です。 |
MediaSnapshot:メディアスナップショットデータ
名前 | 型 | 説明 |
JobId | String | スナップショットジョブ ID。 |
CreationTime | String | スナップショットジョブが作成された時刻。時刻は UTC です。 |
Total | Long | スナップショットの総数。 |
Regular | String | スナップショット URL を生成するためのルール。 |
Snapshots | Snapshot[] | スナップショットデータ。 |
Snapshot:スナップショット情報
名前 | 型 | 説明 |
Index | String | スナップショットのインデックス値。 |
Url | String | スナップショット URL。 |
DynamicImage:動的画像情報
名前 | 型 | 説明 |
VideoId | String | ビデオ ID。 |
DynamicImageId | String | 動的画像 ID。 |
FileURL | String | 動的画像ファイルの URL。 |
Width | String | 動的画像の幅。 |
Height | String | 動的画像の高さ。 |
Duration | String | 動的画像の長さ。 |
Format | String | 動的画像のフォーマット。有効な値は `gif` または `webp` です。 |
FileSize | String | 動的画像ファイルのサイズ。 |
Fps | String | 動的画像のフレームレート。 |
ウォーターマーク
WatermarkInfo:ウォーターマークに関する情報
名前 | 型 | 必須 | 説明 |
CreationTime | String | はい | ウォーターマークが追加された時刻。 |
Name | String | はい | ウォーターマークの名前。 |
IsDefault | String | はい | ウォーターマークがデフォルトであるかどうかを示します。有効な値:
|
Type | String | はい | ウォーターマークのタイプ。有効な値:
|
WatermarkId | String | はい | ウォーターマークの ID。 |
FileUrl | String | いいえ | ウォーターマークファイルの OSS URL または CDN URL。このパラメータはテキストウォーターマークには適用されません。 |
WatermarkConfig | はい | テキストまたは画像ウォーターマークの位置と効果の設定。値は JSON 文字列である必要があります。 |
オーディオとビデオのトランスコーディング
TranscodeJob:トランスコーディングジョブに関する情報
名前 | 型 | 説明 |
JobId | String | トランスコーディングジョブの ID。 |
TranscodeTemplateGroup:トランスコーディングテンプレートグループに関する情報
名前 | 型 | 必須 | 説明 |
Name | String | はい | テンプレートグループの名前。 |
TranscodeTemplateGroupId | String | はい | トランスコーディングテンプレートグループの ID。 |
IsDefault | String | はい | これがデフォルトのテンプレートグループであるかどうかを示します。有効な値:
|
CreationTime | String | はい | テンプレートグループが作成された時刻。 |
ModifyTime | String | はい | テンプレートグループが最後に変更された時刻。 |
TranscodeTemplateList | はい | トランスコーディングテンプレート設定のリスト。 |
TranscodeTemplate:トランスコーディングテンプレート設定
名前 | 型 | 必須 | 説明 |
Type | String | いいえ | テンプレートタイプ。有効な値:
デフォルト値:Normal。 |
Video | はい | ビデオストリームのトランスコーディング設定。値は JSON 文字列である必要があります。 | |
Audio | はい | オーディオストリームのトランスコーディング設定。値は JSON 文字列である必要があります。 | |
Definition | String | はい | 通常のトランスコーディングテンプレートの定義。有効な値:
説明
ナローバンド HD 1.0 トランスコーディングテンプレートの定義です。有効な値:
説明
|
Container | はい | オーディオおよびビデオストリームをカプセル化するために使用されるコンテナフォーマット。値は JSON 文字列である必要があります。 | |
MuxConfig | いいえ | トランスコーディングのセグメント設定。コンテナフォーマットが HLS の場合、このパラメータを指定する必要があります。値は JSON 文字列である必要があります。 | |
TransConfig | いいえ | 条件付きトランスコーディング設定。このパラメータを使用して、トランスコードされたビデオを生成する前に、ソースビデオのビットレートと解像度に基づいて基本的なロジックを適用します。値は JSON 文字列である必要があります。 | |
TranscodeFileRegular | String | いいえ | 出力ファイルを保存するためのカスタムパス。 説明
設定例 {MediaId}/watermark-{PlayDefinition}:トランスコーディング中、ApsaraVideo VOD は {MediaId} をビデオ ID (例:8ff5cc93f6da4079a47a77bf71d) に、{PlayDefinition} を解像度 (例:fd) に置き換えます。 出力例 8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4 (ApsaraVideo VOD はファイル拡張子 (.mp4、.m3u8、.flv など) を自動的に追加します)。 |
Clip | いいえ | ビデオクロッピング設定。値は JSON 文字列である必要があります。 たとえば、このパラメータを設定して、ビデオから 5 秒のコンテンツを抽出して新しいビデオを生成します。 | |
Rotate | String | いいえ | ビデオの回転角度。有効な値:[0,360]。 たとえば、このパラメータを 180 に設定すると、ビデオ画像が上下反転します。 |
EncryptSetting | いいえ | トランスコーディングの暗号化設定。 | |
PackageSetting | いいえ | パッケージング設定。HLS アダプティブビットレートパッケージングと DASH パッケージングのみがサポートされています。値は JSON 文字列である必要があります。 | |
SubtitleList | いいえ | 字幕設定。値は JSON 文字列である必要があります。 | |
WatermarkIds | String[] | いいえ | 関連付けられたウォーターマークの ID。最大 4 つのウォーターマーク ID を関連付けることができます。USER_DEFAULT_WATERMARK はデフォルトのウォーターマークの ID を表します。 |
TranscodeTemplateId | String | いいえ | トランスコーディングテンプレートの ID。テンプレートを変更する際にこのパラメータを指定する必要があります。 |
TemplateName | String | いいえ | トランスコーディングテンプレートの名前。テンプレートを作成する際にこのパラメータを指定する必要があります。 |
TranscodeTemplate パラメータの例
{
"Type":"VideoPackage",
"Video":{
"Codec":"H.264",
"Bitrate":"900",
"Width":"960",
"Remove":"false",
"Fps":"30"
},
"Audio":{
"Codec":"AAC",
"Bitrate":"128",
"Samplerate":"44100"
},
"Container":{
"Format":"m3u8"
},
"MuxConfig":{
"Segment":{
"Duration":"6"
}
},
"EncryptSetting":{
"EncryptType":"AliyunVoDEncryption"
},
"PackageSetting":{
"PackageType":"HLSPackage"
"PackageConfig":{
"BandWidth":"900000"
}
},
"SubtitleUrl": "http://outin-40564284ef058b2163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****-cn.ass",
"CharEncode": "UTF-8",
"WatermarkIds":["USER_DEFAULT_WATERMARK","ddddddddd"],
"Definition":"SD",
"TemplateName":"test"
}
Video:ビデオストリームトランスコーディング設定
特別な要件がない場合は、Codec、Bitrate、Height、Width、Remove=false のみ設定できます。
出力ビデオのアスペクト比がソースビデオと一致するように、Width または Height のいずれか一方のみを設定することをお勧めします。
名前 | 型 | 必須 | 説明 |
Codec | String | はい | ビデオエンコード形式:H.264 または H.265。 |
Remove | String | はい | ビデオストリームを削除するかどうかを示します。有効な値:
デフォルト値:false。 |
Bitrate | String | いいえ | 出力ビデオのターゲットビットレート。このパラメータを指定しない場合、ビットレートは Crf パラメータを使用して計算されます。単位:Kbps。 有効な値:[10,50000]。 |
Height | String | いいえ | 出力ビデオの高さ。値は 2 の倍数である必要があります。このパラメータを指定しない場合、ソースファイルの高さが使用されます。単位:ピクセル。有効な値:[128,4096]。 |
Width | String | いいえ | 出力ビデオの幅。値は 2 の倍数である必要があります。このパラメータを指定しない場合、ソースファイルの幅が使用されます。単位:ピクセル。有効な値:[128,4096]。 |
Fps | String | いいえ | 出力ビデオのフレームレート。このパラメータを指定しない場合、ソースファイルのフレームレートが使用されます。単位:FPS。有効な値:(0,60]。 |
Gop | String | いいえ | 隣接するキーフレーム間の距離。単位:フレーム。有効な値:[1,100000]。 |
LongShortMode | String | いいえ | 自動回転画面を有効にします。出力ビデオの幅はソースの長辺 (ポートレートモードの高さ) に対応します。出力ビデオの高さはソースの短辺 (ポートレートモードの幅) に対応します。有効な値:
デフォルト値:true。この機能はポートレートビデオに最適です。有効にすることをお勧めします。 |
Crf | String | いいえ | ビットレート品質管理係数。このパラメータを指定すると、Bitrate パラメータは無視されます。値が高いほどビデオ品質は低くなり、ファイルサイズは小さくなります。値が低いほどビデオ品質は高くなり、ファイルサイズは大きくなり、トランスコーディング時間は長くなります。有効な値:[0,51]。 デフォルト値:26。この値を変更することはお勧めしません。 |
Profile | String | いいえ | エンコードプロファイル。有効な値:
デフォルト値:high。このパラメータは H.264 エンコードにのみ適用されます。 ベストプラクティス 複数の解像度をサポートする場合、低解像度デバイスでの再生を保証するために、最も低い解像度を baseline に設定します。他の解像度は main または high に設定します。 |
Preset | String | いいえ | プリセットビデオアルゴリズム。有効な値:veryfast、fast、medium、slow、slower。 デフォルト値:medium。このパラメータは H.264 エンコードにのみ適用されます。この値を変更することはお勧めしません。 |
ScanMode | String | いいえ | スキャンモード。有効な値:
|
Bufsize | String | いいえ | バッファーサイズ。単位:KB。有効な値:[1000,128000]。 デフォルト値:6000。 |
Maxrate | String | いいえ | ピークビデオビットレート。単位:Kbps。有効な値:[1000,50000]。 |
PixFmt | String | いいえ | ビデオのピクセルフォーマット。yuv420p や yuvj420p などの標準フォーマットがサポートされています。 デフォルト値:yuv420p または元のピクセルフォーマット。 |
Video パラメータの例
{
"Codec":"H.264",
"Bitrate":"128",
"Remove":"false",
"Width":"640",
"Fps":"30"
}Audio:オーディオストリームトランスコーディング設定
特別な要件がない場合は、Codec、Bitrate、Remove=false のみ設定できます。
名前 | 型 | 必須 | 説明 |
Codec | String | はい | オーディオエンコード形式:AAC または MP3。 |
Bitrate | String | はい | 出力オーディオのターゲットビットレート。単位:Kbps。有効な値:[8,1000]。 |
Remove | String | はい | オーディオストリームを削除するかどうかを示します。有効な値:
デフォルト値:false。 |
Samplerate | String | はい | サンプルレート。単位:Hz。有効な値:22050、32000、44100、48000、96000。 デフォルト値:44100。 コンテナフォーマットが FLV で、オーディオコーデックが MP3 の場合、サンプルレートは 32000、48000、または 96000 にすることはできません。 オーディオコーデックが MP3 の場合、サンプルレートは 96000 にすることはできません。 |
Channels | String | いいえ | オーディオチャンネルの数。デフォルト値:2。
|
Profile | String | いいえ | オーディオコーデックプロファイル。Codec が AAC に設定されている場合、有効な値には aac_low、aac_he、aac_he_v2、aac_ld、aac_eld が含まれます。 |
Volume | いいえ | ボリュームの構成 |
Audio パラメータの例
{
"Codec":"AAC",
"Bitrate":"128",
"Remove":"false",
"Samplerate":"44100"
}Container:コンテナフォーマット
名前 | 型 | 必須 | 説明 |
Format | String | はい | コンテナフォーマット。
|
Container パラメータの例
{
"Format":"mp4"
}MuxConfig:HLS セグメント設定
コンテナフォーマットが m3u8 に設定されている場合、このパラメータを指定する必要があります。
名前 | 型 | 必須 | 説明 |
Segment | はい | セグメント設定フィールドを含む JSON オブジェクト。 |
Segment:セグメント設定の詳細
名前 | 型 | 必須 | 説明 |
Duration | String | はい | 各 TS セグメントの長さ。値は整数である必要があります。有効な値:[1,60]。単位:秒。 例:{"Duration":"10"}。 |
MuxConfig パラメータの例
{
"Segment":{
"Duration":"10"
}
}TransConfig:条件付きトランスコーディング設定
名前 | 型 | 必須 | 説明 |
TransMode | String | いいえ | トランスコーディングモード。有効な値:
デフォルト値:onepass。 |
IsCheckReso | String | いいえ | ソースビデオの解像度をチェックして、トランスコーディングにソース解像度を使用するかどうかを判断します。有効な値:
デフォルト値:false。 |
IsCheckResoFail | String | いいえ | ソースビデオの解像度をチェックして、トランスコーディングが失敗するかどうかを判断します。有効な値:
デフォルト値:false。 |
IsCheckVideoBitrate | String | いいえ | ソースビデオのビットレートをチェックして、トランスコーディングにソースビットレートを使用するかどうかを判断します。有効な値:
デフォルト値:false。 |
IsCheckVideoBitrateFail | String | いいえ | ソースビデオのビットレートをチェックして、トランスコーディングが失敗するかどうかを判断します。有効な値:
デフォルト値:false。この値は IsCheckVideoBitrate よりも優先されます。 |
IsCheckAudioBitrate | String | いいえ | ソースオーディオのビットレートをチェックして、トランスコーディングにソースビットレートを使用するかどうかを判断します。有効な値:
デフォルト値:false。 |
IsCheckAudioBitrateFail | String | いいえ | ソースオーディオのビットレートをチェックして、トランスコーディングが失敗するかどうかを判断します。有効な値:
デフォルト値:false。この値は IsCheckAudioBitrate よりも優先されます。 |
TransConfig パラメータの例
{
"IsCheckReso":"true",
"IsCheckResoFail":"false",
"IsCheckVideoBitrate":"false",
"IsCheckVideoBitrateFail":"false",
"IsCheckAudioBitrate":"false",
"IsCheckAudioBitrateFail":"false"
}Clip:ビデオクロッピング設定
名前 | 型 | 必須 | 説明 |
TimeSpan | はい | ビデオクロッピングの時間関連設定。 |
TimeSpan:ビデオクロッピング設定
名前 | 型 | 必須 | 説明 |
Seek | String | はい | ビデオクリップの開始時刻。
フォーマット 1 を使用することをお勧めします。 |
Duration | String | いいえ | ビデオクリッピングの長さ。
フォーマット 1 を使用することをお勧めします。 説明 Duration または End のいずれかを指定する必要があります。両方を指定した場合、End が優先されます。 |
End | String | いいえ | ビデオクリッピング中に破棄する末尾セグメントの長さ。
フォーマット 1 を使用することをお勧めします。 説明
|
EncryptSetting:トランスコーディング暗号化設定
HLS 標準暗号化を使用するには、まずトランスコーディングテンプレートの EncryptType パラメータを AliyunVoDEncryption に設定する必要があります。次に、メディアトランスコーディングジョブの送信操作を呼び出し、EncryptConfig パラメータを設定します。
名前 | 型 | 必須 | 説明 |
EncryptType | String | はい | 暗号化タイプ。有効な値:
|
EncryptSetting パラメータの例
{
"EncryptType":"AliyunVoDEncryption"
}PackageSetting:トランスコーディングパッケージング設定
抽出されたオーディオおよびビデオストリームをパッケージ化することはできません。
現在、HLS アダプティブビットレートパッケージングのみがサポートされています。
名前 | 型 | 必須 | 説明 |
PackageType | String | はい | パッケージングタイプ。有効な値:HLSPackage (HLS アダプティブビットレートパッケージング)。 |
PackageConfig | いいえ | パッケージング設定。VideoPackage テンプレートの場合、このパラメータを指定する必要があります。 | |
SubtitleExtractConfigList | いいえ | 字幕パッケージング設定。SubtitlePackage テンプレートの場合、このパラメータを指定する必要があります。他のテンプレートタイプでは指定しないでください。 |
PackageConfig:ビデオパッケージング設定
このパラメータは HLS アダプティブビットレートストリーミングパッケージングの場合にのみ設定する必要があります。
名前 | 型 | 必須 | 説明 |
BandWidth | String | はい | 最大帯域幅。HLS パッケージングの場合、このパラメータを指定する必要があります。単位:bps。 このパラメータは VideoPackage テンプレートの場合にのみ指定する必要があります。 |
PackageSetting パラメータの例
VideoPackage template configuration:
{
"PackageType":"HLSPackage",
"PackageConfig":{
"BandWidth":"400000"
}
}
SubtitleExtractConfig:字幕パッケージング設定
名前 | 型 | 必須 | 説明 |
SubtitleUrlList | String[] | はい | 字幕ファイルの URL。HTTP OSS URL のみがサポートされています。HTTP CDN URL および HTTPS URL はサポートされていません。 説明
|
Language | String | はい | 字幕の言語。例:en-US。詳細については RFC 5646 を参照してください。 |
Format | String | はい | 字幕ファイルフォーマット。.vtt ファイルのみがサポートされています。例:subtitle.vtt。 |
Name | String | はい | プレーヤーに表示される字幕トラックの表示名。例:Chinese または English。 |
SubtitlePackage パラメータの例
SubtitlePackage template configuration:
{
"PackageType": "HLSPackage",
"SubtitleExtractConfigList": [
{
"SubtitleUrlList": [
"http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4bff3675-79a5-40fa-8c86-1f98169d****-eng.vtt"
],
"Language": "en-US",
"Format": "vtt",
"Name": "English"
},
{
"SubtitleUrlList": [
"http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/a3f50b08-11c3-4511-94cf-7fd4f7a5****-jpn.vtt"
],
"Language": "ja",
"Format": "vtt",
"Name": "Japanese"
},
{
"SubtitleUrlList": [
"http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4dba87c2-a787-42cd-8328-2369aeb8****-cn.vtt"
],
"Language": "cn",
"Format": "vtt",
"Name": "Chinese"
}
]
}SubtitleConfig:字幕設定
名前 | 型 | 必須 | 説明 |
SubtitleUrl | String | はい | 字幕ファイルの OSS URL。HTTPS URL および純粋な CDN ドメイン名はサポートされていません。サポートされている字幕フォーマット:srt および ass。 説明 字幕ファイルとソースビデオファイルは同じリージョン (例:中国東部 1) および同じバケットにある必要があります。 |
CharEncode | String | はい | 文字エンコード形式。有効な値:
デフォルト値:UTF-8。 |
字幕ファイルのアップロードの詳細については、「CreateUploadAttachedMedia」および「OSS ファイルアップロード」をご参照ください。
SubtitleConfig パラメータの例
{
"SubtitleUrl": "http://outin-40564284ef058b2d300163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****.ass",
"CharEncode": "UTF-8"
}ボリューム:ボリュームの構成
名前 | 型 | 必須 | 説明 |
Method | String | いいえ | 音量調整方法。有効な値:auto、dynamic、linear。 |
IntegratedLoudnessTarget | String | いいえ | ターゲットラウドネスレベル。有効な値:[-70,-5]。Method が dynamic に設定されている場合、必須です。 デフォルト値:-6。 |
TruePeak | String | いいえ | 最大ピークレベル。有効な値:[-9,0]。Method が dynamic に設定されている場合、必須です。 デフォルト値:-1。 |
LoudnessRangeTarget | String | いいえ | ラウドネス範囲。有効な値:[1,20]。Method が dynamic に設定されている場合、必須です。 デフォルト値:8。 |
Volume パラメータの例
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}コンテナフォーマットとオーディオコーデックのサポートされている組み合わせ
コンテナ | オーディオコーデック |
mp3 | MP3 |
mp4 | AAC |
ogg | VORBIS、FLAC |
flac | FLAC |
コンテナフォーマット、オーディオコーデック、およびビデオコーデックのサポートされている組み合わせ
コンテナ | ビデオコーデック | オーディオコーデック |
flv | H.264 | AAC、MP3 |
mp4 | H.264、H.265 | AAC、MP3 |
ts | H.264、H.265 | AAC、MP3 |
m3u8 | H.264、H.265 | AAC、MP3 |
gif | GIF | サポートされていません |
ビデオコーデックとビデオストリーム設定パラメータのサポートされている組み合わせ
ビデオコーデック | H.264 | H.265 | GIF |
Profile | サポートされています | × | × |
Bitrate | サポートされています | サポートされています | × |
Crf | サポートされています | サポートされています | × |
Width | サポートされています | サポートされています | サポートされています |
Height | サポートされています | サポートされています | √ |
Fps | サポートされています | サポートされています | サポートされています |
Gop | サポートされています | サポートされています | × |
Preset | √ | × | × |
ScanMode | サポートされています | サポートされています | サポートされています |
Bufsize | サポートされています | サポートされています | × |
Maxrate | √ | ✓ | × |
PixFmt | サポートされています | √ | bgr8 |
TranscodeSummary:トランスコーディングの概要
名前 | 型 | 説明 |
VideoId | String | ビデオの ID。 |
TranscodeTemplateGroupId | String | トランスコーディングに使用されたトランスコーディングテンプレートグループの ID。 |
TranscodeStatus | String | トランスコーディングステータス。有効な値:
|
TranscodeJobInfoSummaryList | トランスコーディングジョブの概要のリスト。 | |
CreationTime | String | トランスコーディングタスクが作成された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。 |
CompleteTime | String | トランスコーディングタスクが完了した時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。 |
TranscodeJobInfoSummary:トランスコーディングジョブの概要
名前 | 型 | 説明 |
TranscodeTemplateId | String | 使用されたトランスコーディングテンプレートの ID。 |
Width | String | 出力ビデオの幅。単位:ピクセル。 |
Height | String | 出力ビデオの高さ。単位:ピクセル。 |
Duration | String | 出力ビデオの長さ。単位:秒。 |
Filesize | String | 出力ビデオファイルのサイズ。単位:バイト。 |
Bitrate | String | 出力ビデオの平均ビットレート。単位:Kbps。 |
Fps | String | 出力ビデオのフレームレート。単位:1 秒あたりのフレーム数。 |
Format | String | 出力ビデオのコンテナフォーマット。 |
WatermarkIdList | String[] | 出力ビデオに適用されたウォーターマーク ID のリスト。 |
TranscodeProgress | Long | トランスコーディングの進行状況。有効な値:[0,100]。 |
TranscodeJobStatus | String | トランスコーディングジョブのステータス。有効な値:
|
CreationTime | String | トランスコーディングジョブが作成された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。 |
CompleteTime | String | トランスコーディングジョブが完了した時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。 |
ErrorCode | String | トランスコーディングジョブが失敗した場合に返されるエラーコード。 |
ErrorMessage | String | トランスコーディングジョブが失敗した場合に返されるエラーメッセージ。 |
TranscodeTask:トランスコーディングタスクに関する情報
名前 | 型 | 説明 |
TranscodeTaskId | String | トランスコーディングタスクの ID。 |
TranscodeTemplateGroupId | String | トランスコーディングに使用されたトランスコーディングテンプレートグループの ID。 |
VideoId | String | ビデオの ID。 |
TaskStatus | String | トランスコーディングタスクのステータス。有効な値:
|
CreationTime | String | トランスコーディングタスクが作成された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。 |
CompleteTime | String | トランスコーディングタスクが完了した時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。 |
Trigger | String | トリガータイプ。有効な値:
|
TranscodeJobInfoList | トランスコーディングジョブに関する情報。 |
TranscodeJobInfo:トランスコーディングジョブに関する情報
名前 | 型 | 説明 |
TranscodeTaskId | String | トランスコーディングタスクの ID。 |
TranscodeJobId | String | トランスコーディングジョブの ID。 |
VideoId | String | ビデオの ID。 |
TranscodeProgress | Long | トランスコーディングジョブの進行状況。有効な値:[0,100]。 |
TranscodeJobStatus | String | トランスコーディングジョブのステータス。有効な値:
|
Priority | String | トランスコーディングタスクの優先度。 |
Definition | String | 定義です。 説明 この値は、トランスコーディングテンプレートで設定された解像度タグです。出力ビデオの実際の解像度範囲を表すものではありません。 |
TranscodeTemplateId | String | トランスコーディングに使用されたトランスコーディングテンプレートの ID。 |
CreationTime | String | トランスコーディングジョブが作成された時刻。 |
CompleteTime | String | トランスコーディングジョブが完了した時刻。 |
InputFileUrl | String | ソースファイルの OSS URL。 |
OutputFile | 出力ファイルに関する情報。 | |
ErrorCode | String | トランスコーディングジョブが失敗した場合に返されるエラーコード。 |
ErrorMessage | String | トランスコーディングジョブが失敗した場合に返されるエラーメッセージ。 |
OutputFile:トランスコーディング後の出力ファイル
名前 | 型 | 説明 |
OutputFileUrl | String | 出力ファイルの OSS URL。 |
Format | String | 出力ファイルのコンテナフォーマット。 |
Width | String | 出力ファイル内のビデオの幅。単位:ピクセル。 |
Height | String | 出力ファイル内のビデオの高さ。単位:ピクセル。 |
Duration | String | 出力ファイルの長さ。単位:秒。 |
Bitrate | String | 出力ファイルの平均ビットレート。単位:Kbps。 |
Fps | String | 出力ファイルのフレームレート。単位:1 秒あたりのフレーム数。 |
Filesize | Long | 出力ファイルのサイズ。単位:バイト。 |
EncryptType | String | 出力ファイルに使用される暗号化タイプ。値は JSON 文字列です。 |
WatermarkIdList | String | 出力ファイルに適用されたウォーターマーク ID のリスト。 |
VideoStreamList | String | ビデオストリームのリスト。詳細については、「VideoStream:ビデオストリーム情報」をご参照ください。 |
AudioStreamList | String | オーディオストリームのリスト。詳細については、「AudioStream:オーディオストリーム情報」をご参照ください。 |
データ統計
TopPlayVideoStatis:日次トップビデオ再生統計
名前 | 型 | 説明 |
VideoId | String | ビデオの ID。 |
PlayDuration | String | 再生時間 (ミリ秒)。 |
Title | String | ビデオタイトル。 |
VV | String | ビデオビュー数。 |
UV | String | コンテンツを再生しているユーザー数。 |
VideoPlayStatisDetail:特定のビデオの日次再生統計
名前 | 型 | 説明 |
Date | String | yyyyMMdd 形式の日付。 例:20170120。 |
PlayDuration | String | 再生時間 (ミリ秒)。 |
Title | String | ビデオタイトル。 |
VV | String | ビデオビュー数。 |
UV | String | 再生ユーザー数。 |
PlayRange | String | 再生時間の分布。 |
UserPlayStatisTotals:日次ユーザー総再生統計
名前 | 型 | 説明 |
Date | String | yyyyMMdd 形式の日付。 例:20170120。 |
PlayDuration | String | 総再生時間 (ミリ秒)。 |
PlayRange | String | 再生時間の分布。 |
VV | VV | ビデオビューの総数。 |
UV | UV | コンテンツを再生したユーザーの総数。 |
UserPlayStatisAvgs:日次ユーザー平均再生統計
名前 | 型 | 説明 |
Date | String | yyyyMMdd 形式の日付。 例:20170120。 |
AvgPlayDuration | String | 平均再生時間 (ミリ秒)。 |
AvgPlayCount | String | 平均ビデオビュー数。 |
VV 分布
統計は、Alibaba Cloud Video on Demand Player SDK を使用した再生についてのみ収集されます。
名前 | 型 | 説明 |
Android | String | Android 用プレーヤーからのビデオビューの総数。 |
iOS | String | iOS 用プレーヤーからのビデオビューの総数。 |
Flash | String | Flash プレーヤーによる再生セッションの総数。 |
HTML5 | String | HTML5 用プレーヤーからのビデオビューの総数。 |
再生回数 UV 分布
統計は、Alibaba Cloud Video on Demand Player SDK を使用した再生についてのみ収集されます。
名前 | 型 | 説明 |
Android | String | Android 用プレーヤーからのユニークビジターの総数。 |
iOS | String | iOS プレーヤーで再生を実行したユーザーの総数。 |
Flash | String | Flash プレーヤーでの総再生ユーザー数 |
HTML5 | String | HTML5 再生ユーザーの総数。 |
イベント通知
MessageCallback:イベント通知設定
名前 | 型 | 説明 |
CallbackType | String | コールバック方法。有効な値:HTTP および MNS。 |
CallbackURL | String | HTTP コールバックの Webhook アドレス。 |
MnsEndpoint | String | MNS コールバックの MNS キューのパブリックエンドポイント。 |
MnsQueueName | String | MNS コールバックの MNS キューの名前。 |
EventTypeList | String | コールバックイベントタイプ。 |
AuthSwitch | String | HTTP コールバックの認証スイッチ。有効な値:
|
AuthKey | String | HTTP コールバックの認証キー。 |
マルチアプリケーションシステム
AppInfo:アプリケーション情報
名前 | 型 | 説明 |
AppId | String | アプリケーション ID。 |
AppName | String | アプリケーション名。 |
Description | String | アプリケーションの説明。 |
Type | String | アプリケーションタイプ。有効な値:
|
Status | String | アプリケーションステータス。有効な値:
|
CreationTime | String | UTC 作成時刻。 |
ModificationTime | String | UTC 更新時刻。 |
AppPolicy:アプリケーション認証ポリシー情報
名前 | 型 | 説明 |
AppId | String | アプリケーション ID。 |
PolicyType | String | ポリシータイプ。有効な値:
|
PolicyName | String | ポリシー名。 |
CreationTime | String | UTC 作成時刻。 |
Description | String | ポリシーの説明。 |