すべてのプロダクト
Search
ドキュメントセンター

ApsaraVideo VOD:基本データ型

最終更新日:Aug 27, 2026

このトピックでは、ApsaraVideo VOD API の基本データ型について説明します。

基本的なメディアアセット情報

Video:オーディオとビデオの情報

名前

タイプ

説明

VideoId

String

オーディオまたはビデオの ID。

Title

String

オーディオまたはビデオのタイトル。

Description

String

オーディオまたはビデオの説明。

Duration

Float

オーディオまたはビデオの長さ。単位:秒。

CoverURL

String

オーディオまたはビデオのサムネイル URL。

Status

String

オーディオまたはビデオのステータス。詳細については、「Status:オーディオまたはビデオファイルのステータス」をご参照ください。

CreationTime

String

オーディオまたはビデオが作成された時刻。時刻は協定世界時 (UTC) である必要があります。

Size

Long

ソースファイルのサイズ。単位:バイト。

Snapshots

String[]

ビデオスナップショットの URL。

CateId

Long

オーディオまたはビデオのカテゴリ ID。

CateName

String

オーディオまたはビデオのカテゴリ名。

Tags

String

オーディオまたはビデオのタグ。複数のタグはコンマ (,) で区切ります。

TemplateGroupId

String

オーディオまたはビデオファイルのトランスコードに使用されるトランスコードテンプレートグループの ID。

StorageLocation

String

オーディオまたはビデオファイルのストレージアドレス。

AppId

String

アプリケーションの ID。

Status:オーディオとビデオのステータス

説明

備考

Uploading

アップロード中

  • これはオーディオまたはビデオファイルの初期ステータスで、オーディオまたはビデオファイルがアップロード中であることを示します。オーディオまたはビデオファイルが長時間このステータスにある場合は、「メディアアセットのアップロードに関するよくある質問」に記載されている考えられる原因と解決策をご参照ください。

  • このステータスのオーディオまたはビデオファイルに対しては、削除操作のみが許可されます。アップロード中のオーディオまたはビデオファイルに対して、トランスコーディング、ビデオクリップ、メディアアセットレビューなどの他の操作は実行できません

UploadFail

アップロード失敗

  • アップロードは、ネットワークの問題やソースファイルの破損により失敗する可能性があります。アップロードを再試行するか、別のソースファイルを使用してください。

  • 再開可能なアップロードを使用する場合、アップロードが失敗したかどうかを判断できないため、このステータスは表示されません。

  • このステータスのオーディオまたはビデオファイルに対しては、削除操作のみが許可されます。アップロードに失敗したオーディオまたはビデオファイルに対して、トランスコーディング、ビデオクリップ、メディアアセットレビューなどの他の操作は実行できません

UploadSucc

アップロード完了

  • ビジネス設計やその他の理由により、アップロード中にデフォルトのトランスコーディングプロセスがスキップされ、有効な再生ストリームが生成されない場合、または非トランスコーディングテンプレートグループが使用され、ソースファイルが MP4、FLV、M3U8、MP3、または WEBM 形式でない場合、ビデオはアップロード完了とマークされます。その後のトランスコーディングで有効な再生ストリームが生成されると、ビデオは通常ステータスに変わります。

  • このステータスのオーディオまたはビデオファイルに対して、トランスコーディング、ビデオクリップ、メディアアセットレビューなどの操作を実行できます。

Transcoding

トランスコード中

このステータスのメディアファイルはトランスコード中です。ビデオが初期トランスコーディング中の場合、有効な再生ストリームは利用できず、API オペレーションを呼び出して再生 URL を取得することはできません。トランスコーディングのステータスは、「単一解像度トランスコーディング完了」または「トランスコーディング完了」イベント通知を使用して判断できます。

TranscodeFail

トランスコード失敗

トランスコーディングの失敗は、通常、ソースファイルのエラーが原因です。エラーメッセージは、「単一解像度トランスコーディング完了」または「トランスコーディング完了」イベント通知から取得できます。トランスコーディングの失敗のトラブルシューティング方法の詳細については、「トランスコーディングに関するよくある質問」をご参照ください。

Checking

審査中

  • ApsaraVideo VOD コンソール > レビュー管理 > レビュー設定公開前レビューを有効にすると、オーディオまたはビデオファイルはトランスコーディングが成功した後に自動的にレビューフローに入ります。その後、オーディオまたはビデオファイルのステータスは審査中とマークされます。手動レビューを開始する必要があります。そうしないと、オーディオまたはビデオファイルは審査中ステータスのままになります。

  • このステータスのオーディオおよびビデオファイルは、ApsaraVideo VOD コンソールまたはレビューセキュリティ IP アドレスを使用してのみ再生できます。API オペレーションを呼び出したり、SDK を使用してこのステータスのオーディオまたはビデオファイルの再生 URL を取得して再生することはできません。ただし、公開されている有効な再生 URL を使用してこれらのファイルを再生することはできます。

  • このステータスのオーディオまたはビデオファイルに対して、トランスコーディングやビデオクリップなどの操作を実行できます

説明

ここでの審査中ステータスは、オーディオまたはビデオファイルのステータス (ApsaraVideo VOD コンソール > メディアアセット > オーディオ/ビデオステータス列で表示可能) を表します。これは、機械審査の審査中ステータス (ApsaraVideo VOD コンソール > レビュー管理 > ビデオレビューで表示可能) とは異なります。機械審査の審査中ステータスは機械レビューのジョブステータスのみを表し、オーディオまたはビデオファイルの審査中ステータスは機械審査と手動レビューの両方のジョブステータスを表します。

Blocked

ブロック済み

  • この状態のオーディオまたはビデオは、ApsaraVideo VOD コンソールまたはレビュー用のホワイトリストに登録された IP アドレスからのみ再生できます。API または SDK を使用してオーディオまたはビデオの再生 URL を取得することはできません。ただし、すでに公開されている有効な再生 URL は通常通り再生できます。

  • このステータスのオーディオまたはビデオファイルに対しては、削除操作のみが許可されます。ブロックされたオーディオまたはビデオファイルに対して、トランスコーディング、ビデオクリップ、メディアアセットレビューなどの他の操作は実行できません。

Normal

通常

  • オーディオまたはビデオファイルに少なくとも 1 つの有効な再生ストリームが存在する場合、そのファイルは通常ステータスになります。

  • このステータスのオーディオまたはビデオファイルに対して、トランスコーディング、ビデオクリップ、メディアアセットレビュー、再生など、すべての操作を実行できます。

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

Mezzanine

画像に関するソース情報。

CreationTime

String

画像が作成された時刻。時刻は協定世界時 (UTC) です。

Status

String

画像のステータス。詳細については、「Status:画像のステータス」をご参照ください。

AppId

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) である必要があります。

Status

String

補助メディアアセットのステータス。詳細については、「Status:補助メディアアセットのステータス」をご参照ください。

AppId

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

出力ファイルのタイプ。有効な値:

  • oss:オリジンサーバーの URL。

  • cdn:高速化 URL。

VideoStreamList

VideoStream[]

ビデオストリーム情報のリスト。

AudioStreamList

AudioStream[]

オーディオストリーム情報のリスト。

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

アップロードするファイルのサイズ。単位:バイト。

Status

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

ビデオサムネイル。

Status

String

ビデオまたはオーディオファイルのステータス。

CreationTime

String

ビデオまたはオーディオファイルが作成された時刻。時刻は協定世界時 (UTC) です。

MediaType

MediaType

メディアファイルのタイプ。有効な値:

  • Video。

  • audio:オーディオのみのファイル。

説明

デフォルトでは、再生 API オペレーションは CDN 高速化 URL を返します。ドメイン名が設定されていない場合、API オペレーションは OSS オリジン URL を返します。この場合、MP4 ファイルの URL のみが再生に使用できます。

PlayInfo:メディアストリームの再生情報

名前

タイプ

説明

Bitrate

String

メディアストリームのビットレート (Kbps)。

Definition

String

メディアストリームの定義。有効な値:

  • FD:低解像度

  • LD:標準解像度

  • SD:高解像度

  • 高解像度 (HD)。

  • OD:オリジナル品質

  • 2K:2K

  • 4K:4K

Specification

String

ビデオおよびオーディオのトランスコーディングの出力仕様。詳細については、「出力仕様」をご参照ください。

Duration

String

メディアストリームの長さ (秒)。

Encrypt

Long

メディアストリームが暗号化されているかどうかを示します。有効な値:

  • 0:いいえ。

  • 1:はい。

EncryptType

String

メディアストリームの暗号化タイプ。有効な値:

  • AliyunVoDEncryption:Alibaba Cloud ビデオ暗号化 (プライベート暗号化)。

  • HLSEncryption:HLS 暗号化。

PlayURL

String

メディアストリームの再生 URL。

Format

String

メディアストリームのフォーマット。

メディアファイルがビデオの場合、有効な値は次のとおりです:

  • mp4

  • m3u8

メディアファイルがオーディオのみの場合、有効な値は mp3 です。

Fps

String

メディアストリームのフレームレート (fps)。

Size

Long

メディアストリームのサイズ (バイト)。

Width

Long

メディアストリームの幅 (ピクセル単位)。

Height

Long

メディアストリームの高さ (ピクセル単位)。

StreamType

String

メディアストリームのタイプ。

  • メディアストリームがビデオの場合、値は video です。

  • メディアストリームがオーディオのみの場合、値は audio です。

JobId

String

メディアストリームのトランスコードジョブの ID。この ID はメディアストリームの一意の識別子です。

WatermarkId

String

メディアストリームに関連付けられているウォーターマークの ID。

Status

String

メディアストリームのステータス。有効な値:

  • Normal:各解像度とフォーマットの最新の完了したトランスコーディングストリームのステータス。

  • Invisible:冗長なストリームのステータス。同じ解像度とフォーマットで複数のストリームがトランスコードされる場合、最新のストリームは Normal とマークされ、その他は Invisible とマークされます。

NarrowBandType

String

ナローバンド HD のタイプ。有効な値:

  • 0:通常

  • 1.0:ナローバンド HD 1.0

  • 2.0:ナローバンド HD 2.0

このパラメーターは、組み込みのナローバンド HD 1.0 トランスコーディングテンプレートの解像度が設定されている場合にのみ有効です。詳細については、「TranscodeTemplate:トランスコーディングテンプレート設定」をご参照ください。

CreationTime

String

ストリームが作成された時刻。時刻は協定世界時 (UTC) です。

ModificationTime

String

ストリームが最後に更新された時刻。時刻は協定世界時 (UTC) です。

VideoMeta:ビデオメタデータ

名前

タイプ

説明

VideoId

String

ビデオの ID。

Title

String

ビデオのタイトル。

Duration

Float

ビデオの長さ (秒)。

CoverURL

String

ビデオサムネイル。

Status

String

ビデオのステータス。

メディアアセットのクエリ

Media:メディアアセットに関する情報

名前

タイプ

説明

MediaId

String

メディアアセットの ID。

CreationTime

String

メディアアセットが作成された時刻。時刻は協定世界時 (UTC) である必要があります。

MediaType

String

メディアアセットのタイプ。有効な値:

  • video:ビデオ

  • audio:オーディオ

  • Image:画像。

  • attached:補助メディアアセット

Video

Video

ビデオに関する情報。

Audio

Audio

オーディオに関する情報。

Image

Image

画像に関する情報。

AttachedMedia

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

VideoTrack[]

いいえ。VideoTracks が空の場合、AudioTracks は空であってはなりません。

ビデオトラックのリスト。複数のトラックの重ね順は、配列要素の順序に従います。たとえば、最初の配列要素のレイヤーが一番下に表示され、2 番目の要素のレイヤーがその上に表示され、以下同様です。

AudioTracks

AudioTrack[]

いいえ。AudioTracks が空の場合、VideoTracks は空であってはなりません。

オーディオトラックのリスト。

SubtitleTracks

SubtitleTrack[]

いいえ

字幕トラックのリスト。

EffectTracks

EffectTrack[]

いいえ

エフェクトトラックのリスト。

VideoTrack:ビデオトラック情報

VideoTrack は、ビデオや画像素材を含む画像ベースのメディアアセットを配置します。

名前

タイプ

必須

説明

Type

String

いいえ

デフォルトは標準ビデオトラックです。

Type=Effect の場合、現在のトラックはエフェクトトラックとして機能します。この場合、VideoTrackClips には EffectTrackItem を含めることができます。

MainTrack

Boolean

いいえ

現在のトラックがメイントラックであるかどうかを指定します。デフォルトは False です。

VideoTrackClips

VideoTrackClip[]

はい

ビデオトラックメディアクリップのリスト。

AudioTrack:オーディオトラック情報

AudioTrack は、オーディオのみのファイルやオーディオストリームを含むビデオなど、オーディオベースのメディアアセットを配置します。

名前

タイプ

必須

説明

MainTrack

Boolean

いいえ

現在のトラックがメイントラックであるかどうかを指定します。デフォルトは False です。

AudioTrackClips

AudioTrackClip[]

はい

オーディオトラックメディアクリップのリスト。

SubtitleTrack:字幕トラック情報

SubtitleTrack は、バナーテキストや外部字幕ファイルなどの字幕を配置します。

名前

タイプ

必須

説明

SubtitleTrackClips

SubtitleTrackClip[]

はい

字幕トラックメディアクリップのリスト。

EffectTrack:エフェクトトラック情報

EffectTrack は、ビデオ全体にグローバルエフェクトを追加し、フィルターと VFX をサポートします。

名前

タイプ

必須

説明

EffectTrackItems

EffectTrackItem[]

はい

エフェクトトラックアイテムのリスト。

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 です。

有効な値:

  • Video

  • Image

  • GlobalImage (グローバル画像。長さはデフォルトで最長のビデオトラックの長さになります。)

例:ビデオトラックで GlobalImage を使用する

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 はターゲット領域のディメンションを定義し、ビデオはその領域内で適応的にスケーリングされます。

  • Contain:アスペクト比を維持しながら、コンテンツをターゲット領域に合わせてスケーリングします。

  • Cover:アスペクト比を維持しながら、ターゲット領域全体を埋めます。アスペクト比が一致しない場合、コンテンツがトリミングされることがあります。

  • Fill:コンテンツをターゲット領域に正確に埋めるように引き伸ばします。アスペクト比は維持されません。

In

Float

いいえ

ソースメディアに対するクリップの開始時刻。オーディオ/ビデオソースにのみ適用されます。単位:秒、小数点以下 4 桁まで正確。指定しない場合はデフォルトで 0 になります。

Out

Float

いいえ

ソースメディアに対するクリップの終了時刻。オーディオ/ビデオソースにのみ適用されます。単位:秒、小数点以下 4 桁まで正確。指定しない場合はソースの全長がデフォルトになります。

MaxOut

Float

いいえ

ソースメディアに対するクリップの最大終了時刻。設定した場合、実際の Out ポイントはソースの長さまたは MaxOut の小さい方になります。オーディオ/ビデオソースにのみ適用されます。単位:秒、小数点以下 4 桁まで正確。Out が指定されている場合、MaxOut は無視されます。

例:ビデオトラックで MaxOut を設定する

Duration

Float

いいえ

クリップの長さ。通常、画像ソースに使用されます。単位:秒、小数点以下 4 桁まで正確。

DyncFrames

Int

いいえ

アニメーション画像のフレームレート。ソースがアニメーション画像の場合にのみ適用されます。

例:GIF ステッカーを使用する

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

はい

字幕メディアのタイプ。有効な値:

  • Subtitle:外部字幕ファイル

  • Text:バナーテキスト

SubType

String

いいえ

字幕メディアのサブタイプ。有効な値:

  • srt:外部 SRT 字幕

  • ass:外部 ASS 字幕

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

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 です。有効な値:

  • TopLeft:ビデオの左上隅

  • TopCenter:垂直軸に沿った上部中央

  • TopRight:ビデオの右上隅

  • CenterLeft:ビデオの水平中央軸の左側

  • CenterCenter:ビデオの中央

  • CenterRight:水平軸に沿った右中央

  • BottomLeft:ビデオの左下隅

  • BottomCenter:垂直軸に沿った下部中央

  • BottomRight:ビデオの右下隅

AdaptMode

String

いいえ

バナーテキストがビデオの幅または指定された TextWidth を超えた場合にどのように適応するかを指定します。有効な値:

  • AutoWrap:自動的に行を折り返します

  • AutoScale:Auto Scaling

  • AutoWrapAtSpaces:スペース文字でのみ折り返します (英語のみの字幕に最適)

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 構成リファレンス」をご参照ください。

共通の Effect プロパティは次のとおりです:

名前

タイプ

必須

説明

Type

String

はい

エフェクトタイプ。有効な値:

  • Text:ビデオトラッククリップのバナーテキスト。

  • DeWatermark:ビデオトラッククリップのウォーターマーク除去。

  • Crop:ビデオトラッククリップのクロッピング。

  • Scale:ビデオトラッククリップのスケーリング。

  • Pad:ビデオトラッククリップのスナップ

  • Background:ビデオトラッククリップの背景設定。

  • Transition:ビデオトラッククリップのトランジションエフェクト。

  • VFX:ビデオトラッククリップの視覚効果。

  • Filter:ビデオトラッククリップのフィルター。

  • Volume:オーディオトラッククリップの音量調整。

  • AFade:オーディオトラッククリップのオーディオフェードインおよびフェードアウト。

  • Rotate:ビデオトラッククリップの回転。

  • Clip:ランダムクリッピング。

  • Flip:反転。

  • KenBurns:Ken Burns エフェクト (パンとズーム)。

  • Zoom:ズーム。

SubType

String

いいえ

エフェクトのサブタイプ。

  • Type が Transition の場合、これはトランジションのサブタイプを指定します。有効な値については、「トランジションエフェクトの例」をご参照ください。

  • Type が VFX の場合、これは視覚効果のサブタイプを指定します。有効な値については、「特殊効果の例」をご参照ください。

  • Type が Filter の場合、これはフィルターのサブタイプを指定します。有効な値については、「フィルター効果の例」をご参照ください。

ビデオスナップショットと動的画像

SnapshotJob:スナップショットジョブ情報

名前

タイプ

説明

JobId

String

ジョブ ID。

VodTemplateInfo:スナップショットテンプレート情報

名前

タイプ

説明

Name

String

テンプレート名。

VodTemplateId

String

テンプレート ID。

TemplateType

String

テンプレートタイプ。有効な値:

  • Snapshot:スナップショット。

  • DynamicImage:動的画像。

IsDefault

String

これがデフォルトのウォーターマークであるかどうかを示します。有効な値:

  • Default:ウォーターマークはデフォルトのものです。

  • NotDefault:ウォーターマークはデフォルトのものではありません。

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

はい

ウォーターマークがデフォルトであるかどうかを示します。有効な値:

  • Default:デフォルトのウォーターマーク。

  • NotDefault:デフォルト以外のウォーターマーク。

Type

String

はい

ウォーターマークのタイプ。有効な値:

  • Image:画像。

  • Text:テキスト。

WatermarkId

String

はい

ウォーターマークの ID。

FileUrl

String

いいえ

ウォーターマークファイルの OSS URL または CDN URL。このパラメーターはテキストウォーターマークには適用されません。

WatermarkConfig

WatermarkConfig

はい

テキストまたは画像ウォーターマークの位置と効果の設定。値は JSON 文字列である必要があります。

オーディオとビデオのトランスコーディング

TranscodeJob:トランスコーディングジョブに関する情報

名前

タイプ

説明

JobId

String

トランスコーディングジョブの ID。

TranscodeTemplateGroup:トランスコードテンプレートグループに関する情報

名前

タイプ

必須

説明

Name

String

はい

テンプレートグループの名前。

TranscodeTemplateGroupId

String

はい

トランスコードテンプレートグループの ID。

IsDefault

String

はい

これがデフォルトのテンプレートグループであるかどうかを示します。有効な値:

  • Default:デフォルトのテンプレートグループ。

  • NotDefault:デフォルト以外のテンプレートグループ。

CreationTime

String

はい

テンプレートグループが作成された時刻。

ModifyTime

String

はい

テンプレートグループが最後に変更された時刻。

TranscodeTemplateList

TranscodeTemplate[]

はい

トランスコーディングテンプレート設定のリスト。

TranscodeTemplate:トランスコーディングテンプレート設定

名前

タイプ

必須

説明

Type

String

いいえ

テンプレートタイプ。有効な値:

  • Normal:通常のトランスコーディングテンプレート。

    このテンプレートタイプでは PackageSetting パラメーターを設定できません。

  • VideoPackage:ビデオストリームパッケージングテンプレート。

    このテンプレートは、まずビデオをトランスコードし、次にアダプティブビットレートストリームを構築します。PackageSetting パラメーターを設定する必要があります。

  • SubtitlePackage:字幕パッケージングテンプレート。

    このテンプレートタイプはトランスコーディングを実行しません。代わりに、対応するキャプション情報をアダプティブビットレート出力ファイルに埋め込みます。PackageSetting パラメーターを設定する必要があります。ただし、このテンプレートタイプはテンプレートグループ内で独立して存在することはできません。VideoPackage テンプレートと一緒に設定する必要があり、テンプレートグループ内でこのようなテンプレートを 1 つだけ設定できます。

デフォルト値:Normal。

Video

Video

はい

ビデオストリームのトランスコーディング設定。値は JSON 文字列である必要があります。

Audio

Audio

はい

オーディオストリームのトランスコーディング設定。値は JSON 文字列である必要があります。

Definition

String

はい

通常のトランスコーディングテンプレートの解像度。有効な値:

  • LD:低解像度。

  • SD:標準解像度。

  • HD:高解像度。

  • FHD:超高解像度。

  • OD:オリジナル品質。この値はコンテナ形式変換に使用されます。

  • 2K

  • 4K

  • SQ:標準音質。

  • HQ:高音質。

説明
  • この定義は、トランスコーディングテンプレート内の単なるタグです。これは、出力動画の実際の解像度範囲を示すものではありません。テンプレートの定義と出力動画の解像度のマッピングについては、「仕様」をご参照ください。

  • この解像度はトランスコーディング料金に影響しません。トランスコーディング料金の詳細については、「ApsaraVideo VOD のトランスコーディングプラン」をご参照ください。

ナローバンド HD™ 1.0 トランスコーディングテンプレートの解像度。有効な値:

  • LD-NBV1:低解像度。

  • SD-NBV1:標準解像度。

  • HD-NBV1:高解像度。

  • FHD-NBV1:超高解像度。

  • 2K-NBV1

  • 4K-NBV

説明
  • トランスコーディングテンプレートの解像度は変更できません。

  • ナローバンド HD™ 1.0 トランスコーディングテンプレートは、ビデオ解像度、オーディオ解像度、ビットレートなどのシステム定義パラメーターを使用します。これらのパラメーターは変更できません。詳細については、「ナローバンド HD™ 1.0」をご参照ください。

  • ナローバンド HD 1.0 トランスコーディングテンプレートは、FLV、M3U8 (HLS)、MP4 出力形式に対してのみ作成できます。

Container

Container

はい

オーディオおよびビデオストリームをカプセル化するために使用されるコンテナ形式。値は JSON 文字列である必要があります。

MuxConfig

MuxConfig

いいえ

トランスコーディングのセグメント設定。コンテナ形式が HLS の場合は、このパラメーターを指定する必要があります。値は JSON 文字列である必要があります。

TransConfig

TransConfig

いいえ

条件付きトランスコーディング設定。このパラメーターを使用して、トランスコードされたビデオを生成する前に、ソースビデオのビットレートと解像度に基づいて基本的なロジックを適用します。値は JSON 文字列である必要があります。

TranscodeFileRegular

String

いいえ

出力ファイルを保存するためのカスタムパス。

説明
  • サポートされているワイルドカード:{MediaId} (ビデオ ID)、{JobId} (トランスコーディングジョブ ID)、および {PlayDefinition} (GetPlayInfo オペレーションによって返される解像度)。

  • 数字、英字、中括弧 {}、スラッシュ (/)、ハイフン (-)、アンダースコア (_) のみが許可されます。最大長は 128 文字です。

  • パスは {MediaId} で始まる必要があります。

設定例

{MediaId}/watermark-{PlayDefinition}:トランスコーディング中に、ApsaraVideo VOD は {MediaId} をビデオ ID (例:8ff5cc93f6da4079a47a77bf71d) に、{PlayDefinition} を解像度 (例:fd) に置き換えます。

出力例

8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4 (ApsaraVideo VOD は自動的にファイル拡張子、たとえば .mp4、.m3u8、または .flv を追加します)。

Clip

Clip

いいえ

ビデオのクロッピング設定。値は JSON 文字列である必要があります。

たとえば、このパラメーターを設定して、ビデオから 5 秒のコンテンツを抽出して新しいビデオを生成します。

Rotate

String

いいえ

ビデオの回転角度。有効な値:[0,360]。

たとえば、このパラメーターを 180 に設定すると、ビデオ画像が上下逆になります。

EncryptSetting

EncryptSetting

いいえ

トランスコーディングの暗号化設定。

PackageSetting

PackageSetting

いいえ

パッケージング設定。HLS アダプティブビットレートパッケージングと DASH パッケージングのみがサポートされています。値は JSON 文字列である必要があります。

SubtitleList

SubtitleConfig

いいえ

字幕設定。値は 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

はい

ビデオストリームを削除するかどうかを示します。有効な値:

  • true:出力ファイルからビデオストリームを削除します。

  • false:出力ファイルにビデオストリームを保持します。

デフォルト値: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:有効。

  • false:機能は無効です。

デフォルト値:true。この機能は縦向きビデオに最適です。有効にすることをお勧めします。

Crf

String

いいえ

ビットレート品質管理係数。このパラメーターを指定すると、Bitrate パラメーターは無視されます。値が高いほどビデオ品質は低くなり、ファイルサイズは小さくなります。値が低いほどビデオ品質は高くなり、ファイルサイズは大きくなり、トランスコーディング時間は長くなります。有効な値:[0,51]。

デフォルト値:26。この値を変更することはお勧めしません。

Profile

String

いいえ

エンコードプロファイル。有効な値:

  • baseline:モバイルデバイスに適しています。

  • main:標準解像度デバイスに適しています。

  • high:高解像度デバイスに適しています。

デフォルト値:high。このパラメーターは H.264 エンコーディングにのみ適用されます。

ベストプラクティス

複数の解像度をサポートする場合は、ローエンドデバイスでの再生を保証するために、最低解像度を baseline に設定します。他の解像度は main または high に設定します。

Preset

String

いいえ

プリセットビデオアルゴリズム。有効な値:veryfast、fast、medium、slow、slower。

デフォルト値:medium。このパラメーターは H.264 エンコーディングにのみ適用されます。この値を変更することはお勧めしません。

ScanMode

String

いいえ

スキャンモード。有効な値:

  • interlaced:インターレーススキャン。

  • progressive:プログレッシブスキャン。

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

はい

オーディオストリームを削除するかどうかを示します。有効な値:

  • true:出力ファイルからオーディオストリームを削除します。

  • false:出力ファイルにオーディオストリームを保持します。

デフォルト値:false。

Samplerate

String

はい

サンプルレート。単位:Hz。有効な値:22050、32000、44100、48000、96000。

デフォルト値:44100。

コンテナ形式が FLV でオーディオコーデックが MP3 の場合、サンプルレートは 32000、48000、または 96000 にはできません。

オーディオコーデックが MP3 の場合、サンプルレートは 96000 にはできません。

Channels

String

いいえ

オーディオチャンネルの数。デフォルト値:2。

  • Codec が MP3 に設定されている場合、有効な値は 1 または 2 です。

  • Codec が AAC に設定されている場合、有効な値は 1、2、4、5、6、または 8 です。

Profile

String

いいえ

オーディオコーデックプロファイル。Codec が AAC に設定されている場合、有効な値には aac_low、aac_he、aac_he_v2、aac_ld、および aac_eld が含まれます。

Volume

Volume

いいえ

ボリュームの構成。

Audio パラメーターの例

{
        "Codec":"AAC",
        "Bitrate":"128",
        "Remove":"false",
        "Samplerate":"44100"
}

Container:コンテナ形式

名前

タイプ

必須

説明

Format

String

はい

コンテナ形式。

  • ビデオトランスコーディングは FLV、MP4、および HLS (M3U8+TS) をサポートします。

  • オーディオトランスコーディングは MP3 と MP4 をサポートします。

  • コンテナ形式が FLV の場合、ビデオコーデックを H.265 に設定することはできません。

Container パラメーターの例

{
        "Format":"mp4"
}

MuxConfig:HLS セグメント設定

説明

コンテナ形式が m3u8 に設定されている場合は、このパラメーターを指定する必要があります。

名前

タイプ

必須

説明

Segment

Segment

はい

セグメント設定フィールドを含む JSON オブジェクト。

Segment:セグメント設定の詳細

名前

タイプ

必須

説明

Duration

String

はい

各 TS セグメントの長さ。値は整数である必要があります。有効な値:[1,60]。単位:秒。

例:{"Duration":"10"}。

MuxConfig パラメーターの例

{
        "Segment":{
                "Duration":"10"
        }
}

TransConfig:条件付きトランスコーディング設定

名前

タイプ

必須

説明

TransMode

String

いいえ

トランスコーディングモード。有効な値:

  • onepass:平均ビットレート (ABR) モード。エンコーディングは twopass よりも高速です。Alibaba Cloud はデフォルトで onepass を使用します。

  • twopass:可変ビットレート (VBR) モード。エンコーダーは 2 回実行され、ビットレートを正確に割り当て、より高品質でより小さいファイルを生成します。Twopass は onepass よりも時間がかかり、ライブストリーミングやリアルタイム通信などの遅延に敏感なシナリオには適していません。入力ビデオが高度に圧縮されている場合、twopass はブロッキングアーティファクトを引き起こす可能性があります。

  • CBR:固定ビットレートモード。ファイルは全体を通して同じビットレートを使用します。CBR ファイルは VBR または ABR ファイルよりも大きく、品質の大幅な向上はありません。

デフォルト値:onepass。

IsCheckReso

String

いいえ

ソースビデオの解像度をチェックして、トランスコーディングにソース解像度を使用するかどうかを決定します。有効な値:

  • true:解像度をチェックします。出力解像度がソース解像度 (幅または高さに基づく) を超える場合、出力解像度はソース解像度に設定されます。

  • false:チェックをスキップします。

デフォルト値:false。

IsCheckResoFail

String

いいえ

ソースビデオの解像度をチェックして、トランスコーディングが失敗するかどうかを決定します。有効な値:

  • true:解像度をチェックします。出力解像度がソース解像度 (幅または高さに基づく) を超える場合、トランスコーディングは失敗します。

  • false:チェックをスキップします。

デフォルト値:false。

IsCheckVideoBitrate

String

いいえ

ソースビデオのビットレートをチェックして、トランスコーディングにソースビットレートを使用するかどうかを決定します。有効な値:

  • true:ビットレートをチェックします。出力ビットレートがソースビットレートを超える場合、出力ビットレートはソースビットレートに設定されます。

  • false:チェックをスキップします。

デフォルト値:false。

IsCheckVideoBitrateFail

String

いいえ

ソースビデオのビットレートをチェックして、トランスコーディングが失敗するかどうかを決定します。有効な値:

  • true:ビットレートをチェックします。出力ビットレートがソースビットレートを超える場合、トランスコーディングは行われません。

  • false:チェックをスキップします。

デフォルト値:false。この値は IsCheckVideoBitrate よりも優先されます。

IsCheckAudioBitrate

String

いいえ

ソースオーディオのビットレートをチェックして、トランスコーディングにソースビットレートを使用するかどうかを決定します。有効な値:

  • true:ビットレートをチェックします。出力ビットレートがソースビットレートを超える場合、出力ビットレートはソースビットレートに設定されます。

  • false:チェックをスキップします。

デフォルト値:false。

IsCheckAudioBitrateFail

String

いいえ

ソースオーディオのビットレートをチェックして、トランスコーディングが失敗するかどうかを決定します。有効な値:

  • true:ビットレートをチェックします。出力ビットレートがソースビットレートを超える場合、トランスコーディングは行われません。

  • false:チェックをスキップします。

デフォルト値:false。この値は IsCheckAudioBitrate よりも優先されます。

TransConfig パラメーターの例

{
        "IsCheckReso":"true",
        "IsCheckResoFail":"false",
        "IsCheckVideoBitrate":"false",
        "IsCheckVideoBitrateFail":"false",
        "IsCheckAudioBitrate":"false",
        "IsCheckAudioBitrateFail":"false"
}

Clip:ビデオクロッピング設定

名前

タイプ

必須

説明

TimeSpan

TimeSpan

はい

ビデオクロッピングの時間関連の設定。

TimeSpan:ビデオクロッピング設定

名前

タイプ

必須

説明

Seek

String

はい

ビデオクリップの開始時刻。

  • フォーマット 1:sssss[.SSS]。有効な値:[0.000,86399.999]。

    例:12000.55。

  • フォーマット 2:hh:mm:ss[.SSS]。有効な値:[00:00:00.000,23:59:59.999]。例:00:00:05.003。

フォーマット 1 の使用を推奨します。

Duration

String

いいえ

ビデオクリッピングの長さ。

  • フォーマット 1:sssss[.SSS]。有効な値:[0.000,86399.999]。

    例:12000.55。

  • フォーマット 2:hh:mm:ss[.SSS]。有効な値:[00:00:00.000,23:59:59.999]。例:00:00:05.003。

フォーマット 1 の使用を推奨します。

説明

Duration または End のいずれかを指定する必要があります。両方を指定した場合、End が有効になります。

End

String

いいえ

ビデオクリッピング中に破棄する末尾セグメントの長さ。

  • フォーマット 1:sssss[.SSS]。有効な値:[0.000,86399.999]。

    例:12000.55。

  • フォーマット 2:hh:mm:ss[.SSS]。有効な値:[00:00:00.000,23:59:59.999]。例:00:00:05.003。

フォーマット 1 の使用を推奨します。

説明
  • Duration または End のいずれかを指定する必要があります。両方を指定した場合、End が有効になります。

  • 開始時刻と終了時刻の間の長さは、ビデオの総長さを超えてはなりません。

EncryptSetting:トランスコーディング暗号化設定

説明

HLS 標準暗号化を使用するには、まずトランスコーディングテンプレートで EncryptType パラメーターを AliyunVoDEncryption に設定する必要があります。 次に、メディアトランスコーディングジョブを送信する操作を呼び出し、EncryptConfig パラメーターを設定できます。

名前

タイプ

必須

説明

EncryptType

String

はい

暗号化タイプ。有効な値:

  • AliyunVoDEncryption:M3U8 (HLS) ビデオのプライベート暗号化または HLS 標準暗号化。

  • AliyunVoDLicenseEncryption:MP4 ビデオのプライベート暗号化。

EncryptSetting パラメーターの例

{
        "EncryptType":"AliyunVoDEncryption"
}

PackageSetting:トランスコーディングパッケージング設定

説明
  • 抽出されたオーディオおよびビデオストリームをパッケージ化することはできません。

  • 現在、HLS アダプティブビットレートパッケージングのみがサポートされています。

名前

タイプ

必須

説明

PackageType

String

はい

パッケージングタイプ。有効な値:HLSPackage (HLS アダプティブビットレートパッケージング)。

PackageConfig

PackageConfig

いいえ

パッケージング設定。VideoPackage テンプレートにはこのパラメーターを指定する必要があります。

SubtitleExtractConfigList

SubtitleExtractConfig[]

いいえ

字幕パッケージング設定。SubtitlePackage テンプレートにはこのパラメーターを指定する必要があります。他のテンプレートタイプには指定しないでください。

PackageConfig:ビデオパッケージング設定

説明

このパラメーターは、HLS アダプティブビットレートストリーミングパッケージングに対してのみ設定する必要があります。

名前

タイプ

必須

説明

BandWidth

String

はい

最大帯域幅。HLS パッケージングにはこのパラメーターを指定する必要があります。単位:bps。

このパラメーターは VideoPackage テンプレートに対してのみ指定する必要があります。

PackageSetting パラメーターの例

VideoPackage テンプレート設定:
{
        "PackageType":"HLSPackage",
        "PackageConfig":{
                "BandWidth":"400000"
        }
}
                        

SubtitleExtractConfig:字幕パッケージング設定

名前

タイプ

必須

説明

SubtitleUrlList

String[]

はい

字幕ファイルの URL。HTTP OSS URL のみがサポートされています。HTTP CDN URL および HTTPS URL はサポートされていません。

説明
  • HTTP URL は 1 つのみサポートされています。

  • 字幕ファイルは ApsaraVideo VOD によって割り当てられたバケットに保存する必要があります。

Language

String

はい

字幕の言語。たとえば、en-US。詳細については、RFC 5646 をご参照ください。

Format

String

はい

字幕ファイル形式。.vtt ファイルのみがサポートされています。例:subtitle.vtt。

Name

String

はい

プレーヤーでの字幕トラックの表示名。たとえば、中国語または英語。

SubtitlePackage パラメーターの例

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。

説明

字幕ファイルとソースビデオファイルは同じリージョン (たとえば、中国東部 1) と同じバケットにある必要があります。

CharEncode

String

はい

文字エンコード形式。有効な値:

  • auto:自動検出。

  • UTF-8

  • GBK

  • BIG5

デフォルト値: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

トランスコーディングのステータス。有効な値:

  • Processing:進行中。

  • Partial:一部のトランスコーディングジョブが完了しました。

  • CompleteAllSucc:すべてのトランスコーディングジョブが成功しました。

  • CompleteAllFail:すべてのトランスコーディングジョブが失敗しました。ソースビデオに問題がある場合、トランスコーディングジョブは開始されず、タスク全体が失敗します。

  • CompletePartialSucc:すべてのトランスコーディングジョブが完了しましたが、一部のみが成功しました。

TranscodeJobInfoSummaryList

TranscodeJobInfoSummary[]

トランスコーディングジョブの概要のリスト。

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

トランスコーディングジョブのステータス。有効な値:

  • Transcoding:ジョブは実行中です。

  • TranscodeSuccess:ジョブは成功しました。

  • TranscodeFail:トランスコーディングに失敗しました。

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

トランスコーディングタスクのステータス。有効な値:

  • Processing:進行中。

  • Partial:一部のトランスコーディングジョブが完了しました。

  • CompleteAllSucc:すべてのトランスコーディングタスクが正常に完了しました。

  • CompleteAllFail:すべてのトランスコーディングジョブが失敗しました。ソースビデオに問題がある場合、トランスコーディングジョブは開始されず、タスク全体が失敗します。

  • CompletePartialSucc:すべてのトランスコーディングジョブが完了しましたが、一部のみが成功しました。

CreationTime

String

トランスコーディングタスクが作成された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は協定世界時 (UTC) で表示されます。

CompleteTime

String

トランスコーディングタスクが完了した時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は協定世界時 (UTC) で表示されます。

Trigger

String

トリガータイプ。有効な値:

  • Auto:ビデオのアップロード後にトランスコーディングが自動的にトリガーされます。

  • Manual:SubmitTranscodeJobs オペレーションを呼び出すことによってトランスコーディングがトリガーされます。

TranscodeJobInfoList

TranscodeJobInfo

トランスコーディングジョブに関する情報。

TranscodeJobInfo:トランスコーディングジョブに関する情報

名前

タイプ

説明

TranscodeTaskId

String

トランスコーディングタスクの ID。

TranscodeJobId

String

トランスコーディングジョブの ID。

VideoId

String

ビデオの ID。

TranscodeProgress

Long

トランスコーディングジョブの進捗状況。有効な値:[0,100]。

TranscodeJobStatus

String

トランスコーディングジョブのステータス。有効な値:

  • Transcoding:ジョブは実行中です。

  • TranscodeSuccess:ジョブは成功しました。

  • TranscodeFail:ジョブは失敗しました。

Priority

String

トランスコーディングタスクの優先度。

Definition

String

定義。

説明

この値はトランスコーディングテンプレートで設定された解像度タグです。出力ビデオの実際の解像度範囲を表すものではありません。

TranscodeTemplateId

String

トランスコーディングに使用されるトランスコーディングテンプレートの ID。

CreationTime

String

トランスコーディングジョブが作成された時刻。

CompleteTime

String

トランスコーディングジョブが完了した時刻。

InputFileUrl

String

ソースファイルの OSS URL。

OutputFile

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 コールバックの認証スイッチ。有効な値:

  • On:有効。

  • off:無効。

AuthKey

String

HTTP コールバックの認証キー。

マルチアプリケーションシステム

AppInfo:アプリケーション情報

名前

タイプ

説明

AppId

String

アプリケーション ID。

AppName

String

アプリケーション名。

Description

String

アプリケーションの説明。

Type

String

アプリケーションタイプ。有効な値:

  • システムはデフォルトに設定されています。

  • Custom:ユーザー作成。

Status

String

アプリケーションのステータス。有効な値:

  • Normal:通常。

  • Disable:アプリケーションは無効です。

CreationTime

String

協定世界時 (UTC) の作成時刻。

ModificationTime

String

協定世界時 (UTC) の更新時刻。

AppPolicy:アプリケーション権限付与ポリシー情報

名前

タイプ

説明

AppId

String

アプリケーション ID。

PolicyType

String

ポリシータイプ。有効な値:

  • System:システムポリシー。

  • Custom:ユーザー定義ポリシー。

PolicyName

String

ポリシー名。

CreationTime

String

協定世界時 (UTC) の作成時刻。

Description

String

ポリシーの説明。