このトピックでは、ApsaraVideo VOD API の基本的なデータ型について説明します。
メディアアセットの基本情報
Video: オーディオおよびビデオ情報
名前 | タイプ | 説明 |
VideoId | String | オーディオまたはビデオファイルの ID。 |
Title | String | オーディオまたはビデオファイルのタイトル。 |
Description | String | オーディオまたはビデオファイルの説明。 |
Duration | Float | オーディオまたはビデオファイルの再生時間。単位: 秒。 |
CoverURL | String | オーディオまたはビデオファイルのサムネイル URL。 |
String | オーディオまたはビデオファイルのステータス。詳細については、「ステータス: オーディオおよびビデオのステータス」をご参照ください。 | |
CreationTime | String | オーディオまたはビデオファイルが作成された時刻。時刻は UTC です。 |
Size | Long | ソースオーディオまたはビデオファイルのサイズ。単位: バイト。 |
Snapshots | String[] | ビデオスナップショット URL の配列。 |
CateId | Long | オーディオまたはビデオファイルのカテゴリ ID。 |
CateName | String | オーディオまたはビデオファイルのカテゴリ名。 |
Tags | String | オーディオまたはビデオファイルのタグ。複数のタグはカンマ (,) で区切ります。 |
TemplateGroupId | String | オーディオまたはビデオファイルのトランスコーディングに使用されるトランスコーディングテンプレートグループの ID。 |
StorageLocation | String | オーディオまたはビデオファイルのストレージの場所。 |
String | アプリケーション ID。 |
ステータス: オーディオおよびビデオのステータス
値 | 説明 | 注 |
Uploading | アップロード中 |
|
UploadFail | アップロード失敗 |
|
UploadSucc | アップロード済み |
|
Transcoding | トランスコード中 | このステータスのオーディオおよびビデオファイルはトランスコーディング中です。ビデオが初めてトランスコーディングされているときは、有効な再生ストリームは利用できず、API 操作を呼び出して再生 URL を取得することはできません。トランスコーディングのステータスは、「単一解像度トランスコーディング完了」や「全解像度トランスコーディング完了」などのトランスコーディング完了のイベント通知から判断できます。 |
TranscodeFail | トランスコーディング失敗 | トランスコーディングの失敗は、通常、ソースファイルのエラーが原因です。StreamTranscodeComplete または TranscodeComplete イベント通知から ErrorMessage を取得するか、「トランスコーディングに関するよくある質問」を参照して失敗のトラブルシューティングを行うことができます。 |
Checking | レビュー中 |
説明 メディアアセットの [レビュー中] ステータス ([ApsaraVideo VOD コンソール] >[メディアファイル] >[オーディオ/ビデオ] の [ステータス] 列で表示) は、機械支援モデレーションジョブの [レビュー中] ステータス ([ApsaraVideo VOD コンソール] > [レビュー管理] > [Content Moderation] の [機械支援モデレーションステータス] 列で表示) とは異なることに注意してください。機械支援モデレーションジョブの [レビュー中] ステータスはそのジョブのステータスのみを記述しますが、メディアアセットの [レビュー中] ステータスは機械支援レビューと手動レビューの両方のジョブのステータスを記述します。 |
Blocked | ブロック済み |
|
Normal | 通常 |
|
ProduceFail | 制作失敗 | オンライン編集によるビデオの制作に失敗しました。ApsaraVideo VOD のオンライン編集機能を使用してビデオを制作する場合、制作に使用されるすべてのメディアアセットが通常ステータスであることを確認してください。そうしないと、ビデオ制作が失敗する可能性があります。 |
ImageInfo: イメージ情報
名前 | タイプ | 説明 |
ImageId | String | イメージの ID。 |
URL | String | イメージの URL。高速化ドメイン名が設定されている場合は CDN URL が返され、そうでない場合は OSS URL が返されます。 |
Title | String | イメージのタイトル。 |
Tags | String | イメージのタグ。 |
ImageType | String | イメージのタイプ。 |
CateId | Long | カテゴリ ID。 |
CateName | String | カテゴリ名。 |
Description | String | 説明。 |
StorageLocation | String | ファイルのストレージの場所。 |
Mezzanine | イメージのソース情報。 | |
CreationTime | String | イメージが作成された時刻。時刻は UTC です。 |
String | イメージのステータス。詳細については、「ステータス: イメージのステータス」をご参照ください。 | |
String | アプリケーション ID。 |
ステータス: イメージのステータス
値 | 説明 | 注 |
Uploading | アップロード中 | これはイメージの初期ステータスです。イメージがアップロード中であることを示します。イメージが長時間アップロード中のステータスのままである場合は、「アップロードしたファイルが常にアップロード中のステータスになるのはなぜですか?」をご参照ください。 |
UploadFail | アップロード失敗 | アップロードは、ネットワークの問題やソースファイルの破損が原因で失敗することがあります。アップロードを再試行するか、別のソースファイルをアップロードすることをお勧めします。 |
Normal | 通常 | イメージはアップロード済みです。 |
AttachedMediaInfo: 補助メディアアセット情報
名前 | タイプ | 説明 |
MediaId | String | 補助メディアアセットの ID。 |
URL | String | 補助メディアアセットの URL。高速化ドメイン名が設定されている場合は CDN URL が返され、そうでない場合は OSS URL が返されます。 |
Title | String | タイトル。 |
Tags | String | タグ。 |
Type | String | 補助メディアアセットのタイプ。 |
Categories | Category[] | カテゴリのリスト。 |
Description | String | 説明。 |
StorageLocation | String | ファイルのストレージの場所。 |
CreationTime | String | 補助メディアアセットが作成された時刻。時刻は UTC です。 |
ModificationTime | String | 補助メディアアセットが最後に更新された時刻。時刻は UTC です。 |
String | 補助メディアアセットのステータス。詳細については、「ステータス: 補助メディアアセットのステータス」をご参照ください。 | |
String | アプリケーション ID。 |
ステータス: 補助メディアアセットのステータス
値 | 説明 | 注 |
Uploading | アップロード中 | 初期ステータス。補助メディアアセットがアップロード中であることを示します。 |
Normal | 通常 | 補助メディアアセットはアップロード済みです。 |
UploadFail | 失敗した | 補助メディアアセットのアップロードに失敗しました。 |
メディアリソースファイル情報
Mezzanine: オーディオおよびビデオソースファイル情報
名前 | タイプ | 説明 |
VideoId | String | ビデオ ID。 |
FileName | String | ファイルの名前。 |
Duration | String | ファイルの再生時間。単位: 秒。 |
Status | String | ソースファイルのステータス。詳細については、「ステータス: オーディオおよびビデオソースファイルのステータス」をご参照ください。 |
CreationTime | String | ファイルが作成された時刻。時刻は UTC です。 |
Height | Long | ファイルの高さ。単位: ピクセル。 |
Width | Long | ファイルの幅。単位: ピクセル。 |
Fps | String | ファイルのフレームレート (1 秒あたりのフレーム数)。 |
FileURL | String | ファイルの URL。 |
Bitrate | String | ファイルのビットレート。単位: Kbit/s。 |
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 | サンプルアスペクト比 (SAR)。 |
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 | 言語。 |
ステータス: オーディオおよびビデオソースファイルのステータス
値 | 説明 | 備考 |
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 アップロードジョブのステータス。詳細については、「ステータス: URL アップロードジョブのステータス」をご参照ください。 | |
CreationTime | String | ジョブが作成された時刻。 |
CompleteTime | Long | ジョブが完了した時刻。 |
UserData | String | ユーザー定義フィールド。 |
ErrorCode | String | エラーコード。 |
ErrorMessage | String | エラーメッセージ。 |
ステータス: 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 | メディアファイルのタイプ。有効な値:
|
デフォルトでは、再生操作は高速化された CDN URL を返します。ドメイン名が設定されていない場合、再生操作は OSS のオリジンサーバーの URL を返します。この場合、MP4 ファイルの URL のみが再生に使用できます。
PlayInfo: ビデオ再生情報
名前 | タイプ | 説明 |
Bitrate | String | ビデオストリームのビットレート。単位: Kbit/s。 |
Definition | String | ビデオストリームの解像度。有効な値:
|
Specification | String | オーディオおよびビデオトランスコーディングの出力仕様。詳細については、「出力仕様」をご参照ください。 |
Duration | String | ビデオストリームの長さ。単位: 秒。 |
Encrypt | Long | ビデオストリームが暗号化されているかどうかを示します。有効な値:
|
EncryptType | String | ビデオストリームの暗号化タイプ。有効な値:
|
PlayURL | String | ビデオストリームの再生 URL。 |
Format | String | ビデオストリームのフォーマット。 メディアファイルがビデオの場合、有効な値は次のとおりです:
メディアファイルがオーディオのみの場合、有効な値は mp3 です。 |
Fps | String | ビデオストリームのフレームレート (1 秒あたりのフレーム数)。 |
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 | カテゴリのレベル。レベル 1 カテゴリはレベル 0 です。 |
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 | オンライン編集プロジェクトが作成された時刻。時刻は UTC で、yyyy-MM-ddTHH:mm:ssZ 形式に従います。 たとえば、2017-01-11T12:00:00Z は 2017 年 1 月 11 日 20:00:00 (UTC+8) に対応します。 |
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 はコンソールのトランスコーディング設定で表示できます。 |
TemplateId | String | ビデオ制作に使用される制作テンプレートの ID。これによりメディアアセットのソースファイルが生成されます。このパラメーターはオプションです。空のままにすると、組み込みのオンライン編集テンプレートが制作に使用されます。 制作対象がビデオファイルの場合、組み込みテンプレートは H.264 エンコーディング形式と MP4 コンテナフォーマットを使用します。 他の要件があり、制作パラメーター (アニメーション GIF 制作、インテリジェント字幕、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。 このパラメーターはオプションです。デフォルト値は、タイムラインで使用される素材のソースファイルのビットレートによって異なります。最大のビットレートが使用されます。 たとえば、ソースファイルのビットレートが 400 Kbit/s、600 Kbit/s、800 Kbit/s の 3 つの素材がタイムラインで使用されている場合、最終的に制作されるビデオのビットレートは 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 コンソールで、[設定管理] > [メディアアセット管理設定] > [カテゴリ管理] を選択してカテゴリ ID を編集または表示します。 |
Tags | String | 制作されたビデオのタグ。1 つのタグは最大 32 バイトの長さです。最大 16 個のタグを追加できます。複数のタグはカンマ (,) で区切ります。値は UTF-8 である必要があります。 |
オンライン編集 - タイムライン (新しいエディター用)
オンライン編集機能は特定のリージョンではサポートされていません。この機能を使用する前に、ApsaraVideo VOD が有効化されているリージョンでサポートされていることを確認してください。詳細については、「リージョン」をご参照ください。古いエディターのオンライン編集データ型に関する詳細については、「オンライン編集データ型 - 古いエディター」をご参照ください。
Timeline: タイムライン情報
タイムラインは、ビデオコンセプトに基づいて素材を配置し、エフェクトをデザインした成果物です。タイムラインは主にトラック、素材、エフェクトで構成されます。
名前 | タイプ | 必須 | 説明 |
VideoTracks | いいえ。ビデオトラックとオーディオトラックの両方を空にすることはできません。 | ビデオトラックのリスト。トラックは配列要素と同じ順序でレイヤー化されます。たとえば、最初の要素に対応するトラックが最下層にあり、2 番目の要素のトラックがその上にレイヤー化され、以下同様です。 | |
AudioTracks | いいえ。オーディオトラックとビデオトラックの両方を空にすることはできません。 | オーディオトラックのリスト。 | |
SubtitleTracks | No | 字幕トラックのリスト。 | |
EffectTracks | No | エフェクトトラックのリスト。 |
VideoTrack: ビデオトラック情報
VideoTrack は、ビデオやイメージなどの視覚素材を配置するために使用されます。
名前 | タイプ | 必須 | 説明 |
Type | String | No | デフォルトは通常のビデオトラックです。 Type=Effect の場合、現在のトラックはエフェクトトラックとして使用できます。VideoTrackClips に EffectTrackItem を入力できます。 |
MainTrack | Boolean | No | 現在のトラックがメイン トラックであるかどうかを指定します。デフォルト値は False です。 |
VideoTrackClips | Yes | ビデオトラック上の素材クリップのリスト。 |
AudioTrack: オーディオトラック情報
AudioTrack は、オーディオのみの素材やオーディオストリームを含むビデオ素材など、オーディオ素材を配置するために使用されます。
名前 | タイプ | 必須 | 説明 |
MainTrack | Boolean | No | 現在のトラックがメイン トラックであるかどうかを指定します。デフォルト値は False です。 |
AudioTrackClips | Yes | オーディオトラック上の素材クリップのリスト。 |
SubtitleTrack: 字幕トラック情報
SubtitleTrack は、バナーテキストや外部字幕などの字幕を配置するために使用されます。
名前 | タイプ | 必須 | 説明 |
SubtitleTrackClips | Yes | 字幕トラック上の素材クリップのリスト。 |
EffectTrack: エフェクトトラック情報
EffectTrack は、ビデオ全体にエフェクトを追加するために使用されます。フィルターと VFX がサポートされています。
名前 | タイプ | 必須 | 説明 |
EffectTrackItems | Yes | エフェクトトラッククリップのリスト。 |
VideoTrackClip: ビデオトラック素材情報
VideoTrackClip 素材には、ビデオ素材とイメージ素材が含まれます。
In、Out、TimelineIn、TimelineOut パラメーターは、素材のトリミングポイントとタイムライン上の位置を指定します。たとえば、ビデオの 5 秒から 10 秒のセグメントをタイムラインの 15 秒から 20 秒の位置に配置するには、In=5、Out=10、TimelineIn=15、TimelineOut=20 と設定します。
名前 | タイプ | 必須 | 説明 |
MediaId | String | No | ビデオトラック素材クリップのメディア ID。場合によっては、メディア ID はオーディオ/ビデオ ID (VideoId) またはイメージ ID (ImageId) とも呼ばれます。 |
Type | String | No | 素材クリップのタイプ。デフォルト値は Video です。 有効な値:
|
X | Float | No | イメージまたはビデオの左上隅から出力ビデオの左上隅までの水平距離。注: パーセンテージとピクセル値の両方がサポートされています。0 から 0.9999 の値は出力ビデオの幅のパーセンテージを表します。2 以上の整数値は絶対ピクセル値を表します。 |
Y | Float | No | イメージまたはビデオの左上隅から出力ビデオの左上隅までの垂直距離。注: パーセンテージとピクセル値の両方がサポートされています。0 から 0.9999 の値は出力ビデオの高さのパーセンテージを表します。2 以上の整数値は絶対ピクセル値を表します。 |
Width | Float | No | 出力ビデオ内のイメージの幅。注: パーセンテージとピクセル値の両方がサポートされています。0 から 0.9999 の値は出力ビデオの幅のパーセンテージを表します。2 以上の整数値は絶対ピクセル値を表します。 |
Height | Float | No | 出力ビデオ内のイメージの高さ。注: パーセンテージとピクセル値の両方がサポートされています。0 から 0.9999 の値は出力ビデオの高さのパーセンテージを表します。2 以上の整数値は絶対ピクセル値を表します。 |
AdaptMode | String | No | ビデオサイズのアダプティブスケーリングモード。デフォルト値は Fill です。このモードは、ビデオトラックの Width と Height の両方を設定した場合にのみ有効になります。この場合、Width と Height はターゲット領域を定義し、ビデオはこの領域内でアダプティブにスケーリングされます。
|
In | Float | No | 素材に対する素材クリップのインポイント。これは、素材がオーディオまたはビデオファイルの場合に使用されます。単位: 秒。値は小数点以下 4 桁まで正確です。In を指定しない場合、デフォルト値は 0 です。 |
Out | Float | No | 素材に対する素材クリップのアウトポイント。これは、素材がオーディオまたはビデオファイルの場合に使用されます。単位: 秒。値は小数点以下 4 桁まで正確です。Out を指定しない場合、素材の再生時間がデフォルト値として使用されます。 |
MaxOut | Float | No | 素材に対する素材クリップの最大アウトポイント。このパラメーターを設定すると、クリップのアウトポイントは素材の再生時間とこのパラメーターの値の小さい方に設定されます。このパラメーターはオーディオおよびビデオ素材に使用されます。単位: 秒。値は小数点以下 4 桁まで正確です。Out パラメーターを設定すると、MaxOut パラメーターは無効になります。 |
Duration | Float | No | 素材クリップの再生時間。これは通常、素材がイメージの場合に使用されます。単位: 秒。値は小数点以下 4 桁まで正確です。 |
DyncFrames | Int | No | アニメーションイメージのフレームレート。素材がアニメーションイメージの場合に使用されます。 |
TimelineIn | Float | No | タイムラインに対する素材クリップのインポイント。単位: 秒。値は小数点以下 4 桁まで正確です。TimelineIn を指定しない場合、値は素材クリップの順序に基づいて自動的に計算されます。 |
TimelineOut | Float | No | タイムラインに対する素材クリップのアウトポイント。単位: 秒。値は小数点以下 4 桁まで正確です。TimelineOut を指定しない場合、値は素材クリップの順序に基づいて自動的に計算されます。 |
Speed | Float | No | ビデオ素材の速度。値の範囲は 0.1 から 100 です。たとえば、Speed=2 の場合、ビデオは 2 倍速で処理され、クリップの再生時間は半分になり、最終的なビデオに制作されます。 |
MaskVideoUrl | String | No | マスクビデオの URL。これは通常、元のビデオに透明効果を追加するために使用されるアルファチャンネル付きのビデオです。 パブリック OSS URL のみがサポートされています。 |
Effects | Effect[] | No | 素材クリップのエフェクトのリスト。 |
AudioTrackClip: オーディオトラック素材情報
AudioTrackClip 素材には、オーディオのみの素材と、オーディオストリームを持つビデオ素材が含まれます。
In、Out、TimelineIn、TimelineOut パラメーターは、素材のトリミングポイントとタイムライン上の位置を指定します。たとえば、ビデオの 5 秒から 10 秒のセグメントをタイムラインの 15 秒から 20 秒の位置に配置するには、In=5、Out=10、TimelineIn=15、TimelineOut=20 と設定します。
名前 | タイプ | 必須 | 説明 |
MediaId | String | No | オーディオトラック素材クリップのメディア ID。 |
In | Float | No | 素材に対する素材クリップのインポイント。単位: 秒。値は小数点以下 4 桁まで正確です。In を指定しない場合、デフォルト値は 0 です。 |
Out | Float | No | 素材に対する素材クリップのアウトポイント。単位: 秒。値は小数点以下 4 桁まで正確です。Out を指定しない場合、素材の再生時間がデフォルト値として使用されます。 |
TimelineIn | Float | No | タイムラインに対する素材クリップのインポイント。単位: 秒。値は小数点以下 4 桁まで正確です。TimelineIn を指定しない場合、値は素材クリップの順序に基づいて自動的に計算されます。 |
TimelineOut | Float | No | タイムラインに対する素材クリップのアウトポイント。単位: 秒。値は小数点以下 4 桁まで正確です。TimelineOut を指定しない場合、値は素材クリップの順序に基づいて自動的に計算されます。 |
Speed | Float | No | オーディオ素材の速度。値の範囲は 0.1 から 100 です。たとえば、Speed=2 の場合、オーディオは 2 倍速で処理され、クリップの再生時間は半分になり、最終的なビデオに制作されます。 |
Effects | Effect[] | No | 素材クリップのエフェクトのリスト。 |
LoopMode | Boolean | No | タイムライン上の素材クリップのループ再生エフェクト。True: ループ再生。False (デフォルト): ループなしの通常再生。 例: オーディオのループ再生 |
SubtitleTrackClip: 字幕トラック素材情報
SubtitleTrackClip は字幕素材を表します。
名前 | タイプ | 必須 | 説明 |
タイプ | String | はい | 字幕素材のタイプ。有効な値:
|
SubType | 文字列 | いいえ | 字幕素材のサブタイプ。有効な値:
字幕素材のタイプがバナーテキストの場合は、このパラメーターを無視できます。 |
FileURL | 文字列 | いいえ | 字幕ファイルの OSS アドレスです。字幕タイプが外部字幕の場合、このパラメーターは必須です。フォーマットは次のとおりです。 https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.srt 説明 FileURL は、パブリック OSS URL のみをサポートします。アクセラレーションされた OSS URL、CDN URL、またはその他の HTTP URL はサポートされていません。 |
X | Float | いいえ | 字幕タイプがバナーテキストの場合、これは、テキストの左上隅から出力ビデオの左上隅までの水平距離を示します。 注: パーセンテージとピクセル値の両方がサポートされています。 0 から 0.9999 までの値は、出力ビデオの幅に対するパーセンテージを表します。 2 以上の整数値は、絶対ピクセル値を表します。 |
Y | Float | いいえ | 字幕タイプがバナーテキストの場合、テキストの左上隅から出力ビデオの左上隅までの垂直距離を示します。注: パーセンテージと画素値の両方がサポートされています。0 から 0.9999 までの値は、出力ビデオの高さのパーセンテージを表します。2 以上の整数値は、絶対的な画素値を表します。 |
TimelineIn | Float | いいえ | 字幕タイプがバナーテキストの場合、これはタイムライン上のテキストの開始位置を示します。単位は秒です。値は小数点以下 4 桁まで正確です。TimelineIn を指定しない場合、値は素材の順序に基づいて自動的に計算されます。 |
TimelineOut | Float | いいえ | 字幕タイプがバナーテキストの場合、これはタイムライン上のテキストの終了位置を示します。単位: 秒。値は小数点以下 4 桁まで正確です。TimelineOut を指定しない場合、値は素材のシーケンシャルオーダーに基づいて自動的に計算されます。 |
内容 | 文字列 | いいえ | 字幕タイプがバナーテキストの場合、このパラメーターは必須です。テキストの内容を示します。 |
フォント | 文字列 | いいえ | テキストのフォント。このパラメーターは、Type を Text に設定した場合に有効になります。デフォルト値: SimSun。サポートされているフォントの詳細については、「フォント」をご参照ください。 |
FontSize | Int | いいえ | 字幕タイプがバナーテキストの場合、フォントサイズを示します。 |
FontColor | String | いいえ | 字幕タイプが banner text の場合、テキストの色を指定します。# の後に 16 進数値を続けるフォーマットです (例: #ffffff)。 |
FontColorOpacity | String | いいえ | 字幕タイプがバナーテキストの場合、テキストの透明度を示します。値の範囲は 0 から 1 です。デフォルト値は 1 です。1 は不透明、0 は完全な透明です。 |
FontFace | いいえ | 字幕タイプがバナーテキストの場合、フォントの外観を示します。 | |
文字間隔 | Int | いいえ | 字幕タイプがバナーテキストの場合、バナーテキストの文字間隔を示します。単位: pixel。デフォルトは 0 です。 |
角度 | Float | いいえ | 字幕タイプがバナーテキストの場合、バナーテキストの反時計回りの回転角度を示します。単位: 度。デフォルトは 0 です。 |
BorderStyle | Int | いいえ | バナーテキストの罫線と影のフォーマットを設定します。有効な値は 1 または 3 です。1=罫線+影、3=不透明な背景ボックス。デフォルト値は 1 です。 |
アウトライン | Int | いいえ | 字幕タイプがバナーテキストの場合、これはバナーテキストのアウトラインの幅を示します。単位: ピクセル。デフォルトは 0 です。 |
OutlineColour | 文字列 | いいえ | 字幕タイプがバナーテキストの場合、バナーテキストの輪郭の色を示します。形式は # の後に 16 進数が続きます。例: #ffffff。 |
シャドウ | Int | いいえ | 字幕タイプがバナーテキストの場合、バナーテキストの影の深さを示します。単位はピクセルです。デフォルトは 0 です。 |
BackColour | 文字列 | いいえ | 字幕タイプがバナーテキストの場合、バナーテキストの影の色を示します。# の後に 16 進数値が続くフォーマットです。例: #ffffff。 |
配置 | 文字列 | いいえ | 字幕タイプが banner text の場合、配置を設定します。デフォルトは TopLeft です。有効な値:
|
AdaptMode | 文字列 | いいえ | バナーテキストがビデオの幅または指定された TextWidth を超えた場合に、テキストを自動的に折り返すか、スケーリングします。有効な値:
|
TextWidth | 整数 | いいえ | 字幕テキストボックスの幅。このパラメーターは、AdaptMode がセットされている場合に効果があります。テキストボックスの幅は、自動折り返しまたはスケーリングのためにこの値にセットされます。指定しない場合、動画の幅が自動折り返しまたはスケーリングのために使用されます。単位: ピクセル。 |
FontUrl | 文字列 | いいえ | 字幕タイプがバナーテキストの場合、OSS バケット内のフォントファイルのパスを使用して字幕を生成できます。 TTF、OTF、および WOFF フォントファイル形式がサポートされています。 例: https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf |
EffectColorStyle | String | いいえ | 字幕タイプがバナーテキストの場合、これはバナーテキストのワードアートのスタイルタイプを示します。 詳細については、「ワードアート効果の例」をご参照ください。 |
AaiMotionInEffect | String | いいえ | 字幕タイプがバナーテキストの場合、これはバナーテキストのエントランス効果タイプを示します。 詳細については、「エントランス効果」をご参照ください。 |
AaiMotionIn | Float | いいえ | 字幕タイプがバナーテキストの場合、これは開始エフェクトの期間を示します。単位: 秒。値は小数点以下 4 桁まで正確です。AaiMotionIn が指定されていない場合、デフォルトは 0.5 秒です。テキストの期間が 0.5 秒未満の場合、値は全期間から終了期間を引いたものになります。 |
AaiMotionOutEffect | 文字列 | いいえ | バナーテキスト字幕の入場効果タイプを指定します。 詳細については、「入場効果」をご参照ください。 |
AaiMotionOut | Float | いいえ | 字幕タイプがバナーテキストの場合、これは終了エフェクトの時間を示します。単位: 秒。値は小数点以下 4 桁まで正確です。AaiMotionOut が指定されていない場合、デフォルトは 0.5s です。テキストの表示時間が 0.5s 未満の場合、値はテキストの合計表示時間です。 |
AaiMotionLoopEffect | 文字列 | いいえ | 字幕タイプがバナーテキストの場合、これはバナーテキストのループ効果タイプを示します。入場または退場効果と同時に有効にすることはできません。 ループ効果の詳細については、「ループ効果」をご参照ください。 |
比率 | Float | いいえ | 字幕タイプがバナーテキストの場合、これはループ効果の再生速度を示します。値は小数点以下 4 桁まで正確です。指定しない場合、デフォルトは 1 です。1 より大きい値はより速いループを意味し、1 より小さい値はより遅いループを意味します。 |
EffectTrackItem:エフェクトトラックのクリップ情報
EffectTrackItem のタイプには VFX とフィルターが含まれます。
名前 | タイプ | 必須 | 説明 |
Type | String | はい | エフェクトトラッククリップのタイプ。サポートされている値: VFX、Filter。 |
SubType | String | はい | エフェクトトラックセグメントのサブタイプ。サポートされているエフェクトの詳細については、「エフェクトの例」および「フィルターエフェクトの例」をご参照ください。 |
TimelineIn | Float | いいえ | タイムライン上のエフェクトクリップの開始位置。単位: 秒。値は小数点以下 4 桁まで正確です。TimelineIn を指定しない場合、デフォルトは 0 です。 |
TimelineOut | Float | いいえ | タイムライン上のエフェクトクリップの終了位置。単位: 秒。値は小数点以下 4 桁まで正確です。TimelineOut を指定しない場合、デフォルトは動画の終了時間です。 |
Duration | Float | いいえ | タイムライン上のエフェクトクリップのデュレーション。単位: 秒。値は小数点以下 4 桁まで正確です。Duration を指定しない場合、デフォルトは動画のデュレーションです。 説明 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:フォントスタイル
名前 | タイプ | 必須 | 説明 |
太字 | ブール値 | いいえ | 太字。 |
斜体 | ブール値 | いいえ | 斜体。 |
下線 | ブール値 | いいえ | 下線。 |
効果:効果情報
効果の種類ごとに、共通のプロパティのセットに加えて、設定できる固有のプロパティがあります。
効果パラメーターの詳細については、「効果の構成」をご参照ください。
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 | いいえ | ウォーターマークファイルの URL。URL は OSS または 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}。トランスコーディング中、{MediaId} はビデオ ID (例: 8ff5cc93f6da4079a47a77bf71d) に置き換えられ、{PlayDefinition} は定義マーカー (例: fd) に置き換えられます。 出力例 8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4。ファイル拡張子 (.mp4、.m3u8、.flv など) は自動的に追加されます。 |
Clip | いいえ | ビデオトリミング設定。値は JSON 文字列です。 たとえば、このパラメーターを設定して、ビデオから 5 秒のクリップを抽出して新しいビデオを生成します。 | |
Rotate | String | いいえ | ビデオの回転角度 (度単位)。有効な値: [0, 360]。 たとえば、値 180 はビデオを上下逆にします。 |
EncryptSetting | いいえ | トランスコーディングの暗号化設定。 | |
PackageSetting | いいえ | パッケージング設定。HLS アダプティブビットレートストリームパッケージングと DASH パッケージングのみがサポートされています。値は JSON 文字列です。 | |
SubtitleList | いいえ | 字幕設定。値は JSON 文字列です。 | |
WatermarkIds | String[] | いいえ | 出力ビデオに関連付けるウォーターマークの ID。最大 4 つのウォーターマークを関連付けることができます。キーワード `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 | いいえ | 出力ビデオのターゲットビットレート (Kbps)。指定しない場合、ビットレートは Crf 値によって決まります。 値の範囲: 10 ~ 50,000。 |
Height | String | いいえ | 出力ビデオの高さ (ピクセル単位)。値は 128 ~ 4096 の範囲の 2 の倍数である必要があります。このパラメーターが指定されていない場合は、ソースファイルの高さが使用されます。 |
Width | String | いいえ | 出力ビデオの幅 (ピクセル単位)。値は [128, 4096] の範囲の 2 の倍数である必要があります。指定しない場合、ソースビデオの幅が使用されます。 |
Fps | String | いいえ | このパラメーターを指定しない場合、ソースファイルのフレームレートが使用されます。値は 0 より大きく、60 FPS 以下である必要があります。 |
Gop | String | いいえ | 隣接するキーフレーム間の間隔 (フレーム単位)。有効範囲は 1 ~ 100,000 です。 |
LongShortMode | String | いいえ | 横向きおよび縦向きのビデオの自動回転を有効にします (長辺/短辺パターン)。トランスコードされた出力の幅は入力ビデオの長辺 (縦向きビデオの高さ) に一致し、高さは短辺 (縦向きビデオの幅) に一致します。値:
デフォルト: true。この設定は縦向きのビデオに推奨されます。 |
Crf | String | いいえ | このパラメーターは、ビットレート品質制御係数を指定し、`Bitrate` パラメーターをオーバーライドします。値が大きいほど、ビデオ品質は低くなり、ファイルサイズは小さくなります。逆に、値が低いほど、ビデオ品質は高くなり、ファイルサイズは大きくなりますが、トランスコーディング時間は長くなります。値の範囲は 0 ~ 51 です。 デフォルト: 26。この値を変更することはお勧めしません。 |
Profile | String | いいえ | エンコードプロファイル。有効な値は次のとおりです:
デフォルト: high。 ベストプラクティス 異なる定義で複数の出力を作成する場合は、最も低い定義のプロファイルを baseline に設定します。これにより、古いデバイスとの互換性が確保されます。他の定義には main または high を使用します。 |
Preset | String | いいえ | 有効な値: veryfast、fast、medium、slow、slower。 デフォルト: medium。この値を変更することはお勧めしません。 |
ScanMode | String | いいえ | スキャンモード。有効な値:
|
Bufsize | String | いいえ | バッファーサイズ (KB)。値は 1000 ~ 128000 である必要があります。 デフォルト: 6,000。 |
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"
}クリップ: 動画の切り抜き設定
名前 | タイプ | 必須 | 説明 |
TimeSpan | はい | 動画のトリミングに使用される時間パラメーター。 |
TimeSpan:ビデオクロップ設定
名前 | タイプ | 必須 | 説明 |
Seek | String | はい | 動画のトリミングの開始時刻。
フォーマット 1 を使用します。 |
Duration | String | いいえ | 動画のトリミングのデュレーション。
フォーマット 1 を使用します。 説明 Duration パラメーターまたは End パラメーターのいずれかを設定します。両方を設定した場合、End が優先されます。 |
End | String | いいえ | 動画の末尾からトリミングするデュレーション。
フォーマット 1 を使用します。 説明
|
EncryptSetting: トランスコードの暗号化構成
HLS 暗号化を使用するには、トランスコーディングテンプレートで EncryptType パラメーターを AliyunVoDEncryption に設定します。次に、SubmitTranscodeJobs 操作を呼び出すときに、EncryptConfig パラメーターを設定します。
名前 | タイプ | 必須 | 説明 |
EncryptType | String | はい | 暗号化タイプ。有効な値:
|
EncryptSetting パラメーターの例
{
"EncryptType":"AliyunVoDEncryption"
}PackageSetting: トランスコーディングとパッケージングの設定
抽出後の音声およびビデオストリームのパッケージングはサポートされていません。
HLS アダプティブビットレートパッケージングのみがサポートされています。
名前 | タイプ | 必須 | 説明 |
PackageType | String | はい | パッケージングタイプ。HLS アダプティブビットレートパッケージングの場合は、値を HLSPackage に設定します。 |
PackageConfig | いいえ | パッケージング構成。このパラメーターは VideoPackage テンプレートに必須です。 | |
SubtitleExtractConfigList | いいえ | 字幕パッケージング構成。このパラメーターは SubtitlePackage テンプレートに必須です。他のテンプレートタイプにはこのパラメーターを指定しないでください。 |
PackageConfig: ビデオパッケージング構成
このパラメーターは、HLS アダプティブストリームのパッケージングの場合にのみ必要です。
名前 | タイプ | 必須 | 説明 |
BandWidth | String | はい | 最大帯域幅。このパラメーターは HLS パッケージングに必須です。単位: bit/s。 このパラメーターは VideoPackage のみに設定します。 |
PackageSetting パラメーターの例
ビデオストリームのパッケージングテンプレートを設定するサンプルコード:
{
"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 | はい | プレーヤーでの字幕トラックの表示名 (中国語や英語など)。 |
SubtitlePackage パラメーターの例
字幕パッケージングテンプレートを設定するためのサンプルコード:
{
"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。 説明 字幕ファイルとビデオソースファイルは、中国 (上海) リージョンなど、同じリージョン内の同じバケットに保存する必要があります。 |
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 and 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 |
プロファイル | √ | × | × |
ビットレート | √ | √ | × |
Crf | ✓ | サポート済み | × |
幅 | ✓ | √ | √ |
高さ | √ | √ | はい |
Fps | √ | ✓ | ✓ |
Gop | サポート済み | √ | × |
プリセット | √ | × | × |
スキャンモード | ✓ | √ | √ |
Bufsize | √ | √ | × |
Maxrate | ✓ | サポート済み | × |
PixFmt | √ | √ | bgr8 |
TranscodeSummary: トランスコードのまとめ
名前 | タイプ | 説明 |
VideoId | String | オーディオまたはビデオファイルの ID。 |
TranscodeTemplateGroupId | String | トランスコーディングテンプレートグループの ID。 |
TranscodeStatus | String | トランスコーディングタスクのステータス。有効な値:
|
TranscodeJobInfoSummaryList | トランスコーディングジョブの概要。 | |
CreationTime | String | トランスコーディングジョブの作成時間。時間は UTC です。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。 |
CompleteTime | String | トランスコーディングジョブが完了した時間。時間は UTC で、ISO 8601 標準に準拠しており、フォーマットは yyyy-MM-ddTHH:mm:ssZ です。 |
TranscodeJobInfoSummary: トランスコーディングジョブの概要
名前 | タイプ | 説明 |
TranscodeTemplateId | String | トランスコーディングテンプレートの ID。 |
Width | String | 出力ビデオの幅。単位: px。 |
Height | String | 出力ビデオの高さ。単位: px。 |
Duration | String | 出力ビデオの長さ。単位: 秒。 |
Filesize | String | 出力ビデオファイルのサイズ。単位: バイト。 |
Bitrate | String | 出力ビデオの平均ビットレート。単位: kbps。 |
Fps | String | 出力ビデオのフレームレート。単位: 1 秒あたりのフレーム数。 |
Format | String | 出力ビデオのコンテナフォーマット。 |
WatermarkIdList | String[] | トランスコーディングに使用されるウォーターマーク ID のリスト。 |
TranscodeProgress | Long | トランスコーディングの進行状況。有効値は 0~100 です。 |
TranscodeJobStatus | String | トランスコーディングジョブのステータス。有効な値:
|
CreationTime | String | トランスコーディングジョブが作成された時刻。時刻は UTC で、yyyy-MM-ddTHH:mm:ssZ 形式を使用します。 |
CompleteTime | String | トランスコーディングジョブが完了した時刻。時刻は UTC で、yyyy-MM-ddTHH:mm:ssZ 形式を使用します。 |
ErrorCode | String | トランスコーディングジョブが失敗した場合に返されるエラーコード。 |
ErrorMessage | String | トランスコーディングジョブが失敗した場合に返されるエラーメッセージ。 |
TranscodeTask: トランスコーディングジョブ情報
名前 | タイプ | 説明 |
TranscodeTaskId | String | トランスコーディングタスクの ID。 |
TranscodeTemplateGroupId | String | トランスコーディングテンプレートグループの ID。 |
VideoId | String | ビデオの ID。 |
TaskStatus | String | トランスコーディングタスクのステータス。有効な値:
|
CreationTime | String | トランスコーディングタスクが作成された時間。時間は UTC で、yyyy-MM-ddTHH:mm:ssZ 形式に従います。 |
CompleteTime | String | トランスコーディングタスクが完了した時間。時間は UTC で、yyyy-MM-ddTHH:mm:ssZ 形式に従います。 |
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 | 文字列 | 出力ファイルの OSS URL。 |
Format | 文字列 | 出力ファイルのコンテナフォーマット。 |
Width | 文字列 | 出力ファイルのイメージの幅。単位: ピクセル。 |
Height | 文字列 | 出力ファイルのイメージの高さ。単位: ピクセル。 |
Duration | 文字列 | 出力ファイルの長さ。単位: 秒。 |
Bitrate | 文字列 | 出力ファイルの平均ビットレート。単位: kbps。 |
Fps | 文字列 | 出力ファイルのフレームレート。単位: 1 秒あたりのフレーム数。 |
Filesize | Long | 出力ファイルのサイズ。単位: バイト。 |
EncryptType | 文字列 | 出力ファイルの暗号化タイプ。値は JSON 文字列です。 |
WatermarkIdList | 文字列 | 出力ファイルに適用されるウォーターマーク ID のリスト。 |
VideoStreamList | 文字列 | ビデオストリームのリスト。詳細については、「VideoStream: ビデオストリーム情報」をご参照ください。 |
AudioStreamList | 文字列 | オーディオストリームのリスト。詳細については、「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: 1 日あたりの総再生数の統計
名前 | タイプ | 説明 |
Date | String | yyyyMMdd 形式の日付。 例: 20170120。 |
PlayDuration | String | 総再生時間。 単位: ミリ秒。 |
PlayRange | String | 再生時間の分布。 |
VV | VV | ビデオの総視聴回数。 |
UV | UV | ユニークビジターの総数。 |
UserPlayStatisAvgs: ユーザーあたりの 1 日の平均再生数の統計
名前 | タイプ | 説明 |
Date | String | yyyyMMdd 形式の日付。 例: 20170120。 |
AvgPlayDuration | String | ビデオの平均再生時間。 単位: ミリ秒。 |
AvgPlayCount | String | ビデオの平均視聴回数。 |
再生回数 VV 分布
ApsaraVideo Player SDK を使用するビデオ再生の統計のみがサポートされています。
名前 | タイプ | 説明 |
Android | String | Android プレーヤーでの総再生回数。 |
iOS | String | iOS プレーヤーからの総再生回数。 |
Flash | String | Flash プレーヤーからの総再生回数。 |
HTML5 | String | HTML5 プレーヤーからの総再生回数。 |
再生回数別の UV 分布
ApsaraVideo Player SDK を使用するビデオ再生の統計のみがサポートされています。
名前 | タイプ | 説明 |
Android | String | ApsaraVideo Player SDK for Android を使用するユニークビジターの総数。 |
iOS | String | ApsaraVideo Player SDK for iOS を使用した再生のユニークユーザーの総数。 |
Flash | String | Flash Player 再生のユーザー総数。 |
HTML5 | String | ApsaraVideo Player SDK for HTML5 を使用するユニークビジターの総数。 |
通知
MessageCallback: イベント通知の構成
名前 | タイプ | 説明 |
CallbackType | String | コールバックメソッド。有効な値: HTTP および MNS。 |
CallbackURL | String | HTTP コールバック用の Webhook アドレス。 |
MnsEndpoint | String | 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 | ポリシーの説明。 |