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

:基本データ型

最終更新日:Feb 13, 2025

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

メディアアセットに関する基本情報

ビデオ: オーディオまたはビデオファイルに関する情報

パラメーター

タイプ

説明

VideoId

String

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

タイトル

String

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

説明

String

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

有効期間

浮く

オーディオまたはビデオの持続時間。 単位は秒です。

CoverURL

String

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

ステータス

String

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

CreationTime

String

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

Size

Long

ソースファイルのサイズ。 単位はバイトです。

スナップショット

String[]

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

CateId

Long

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

CateName

String

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

タグ

String

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

TemplateGroupId

String

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

StorageLocation

String

オーディオまたはビデオの保存場所。

AppId

String

アプリケーションの ID

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

説明

補足

アップロード

オーディオまたはビデオファイルがアップロード中です。

  • これは、オーディオまたはビデオファイルの初期ステータスです。 オーディオまたはビデオファイルがアップロードされていることを示します。 オーディオファイルまたはビデオファイルが長期間この状態にある場合は、「メディアアセットのアップロードに関するFAQ」で説明されている考えられる原因と解決策を確認してください。

  • 削除操作は、アップロードステータスのオーディオファイルまたはビデオファイルに対してのみ実行できます。 このステータスのオーディオファイルまたはビデオファイルでは、トランスコーディング、スナップショットキャプチャ、レビューなどの操作を実行できません

アップロード失敗

イメージのアップロードに失敗しました。

  • アップロードの失敗は、ネットワークの中断やソースファイルの損傷などのエラーが原因で発生する可能性があります。 オーディオファイルまたはビデオファイルを再アップロードするか、別のソースファイルをアップロードすることを推奨します。

  • 再開可能アップロードを使用してオーディオまたはビデオファイルをアップロードする場合、ApsaraVideo VODは再開可能アップロードタスクが失敗するかどうかを判断できないため、この値は使用されません。

  • 削除操作は、このステータスにあるオーディオファイルまたはビデオファイルに対してのみ実行できます。 このステータスのオーディオファイルまたはビデオファイルでは、トランスコーディング、スナップショットキャプチャ、レビューなどの操作を実行できません

UploadSucc

オーディオまたはビデオファイルがアップロードされます。

  • オーディオまたはビデオファイルがアップロードされてもトランスコードされていない場合、有効なビデオストリームは生成されません。 この場合、オーディオまたはビデオファイルはUploadedステータスです。 オーディオファイルまたはビデオファイルをトランスコードすると、有効なストリームが生成され、オーディオファイルまたはビデオファイルは [正常] ステータスになります。

  • この状態のオーディオファイルとビデオファイルに対して、トランスコーディング、スナップショットキャプチャ、レビューなどの操作を実行できます。

トランスコード

オーディオまたはビデオファイルがトランスコードされています。

この状態のオーディオおよびビデオファイルはトランスコードされています。 オーディオまたはビデオファイルがトランスコードされていない場合、有効なストリームは使用できません。 この場合、APIを呼び出して再生URLを取得することはできません。 コード変換の結果は、StreamTranscodeCompleteまたはTranscodeCompleteイベント通知から取得できます。

トランスコード失敗

オーディオファイルまたはビデオファイルのトランスコードに失敗しました。

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

チェック中

オーディオまたはビデオファイルがレビュー中です。

  • 公開する前にオーディオファイルまたはビデオファイルを確認する場合は、次の手順を実行します。ApsaraVideo VODコンソールにログインします。 左側のナビゲーションウィンドウで、[レビュー] > [設定] を選択します。 表示されるページで、[プロセスを公開前に確認] を設定します。 次に、オーディオファイルまたはビデオファイルがトランスコードされた後、ファイルのステータスが [レビュー] に変わります。 この場合、オーディオファイルまたはビデオファイルに対して自動レビューまたは手動レビューを実行する必要があります。 それ以外の場合、ファイルは [レビュー] ステータスのままになります。

  • ApsaraVideo VODコンソールまたはセキュリティIPアドレスプレビューに記載されているレビューセキュリティグループのIPアドレスを使用してのみ、[レビュー] ステータスのオーディオおよびビデオファイルを再生できます。 APIを呼び出したり、SDKを使用して、[更新中] ステータスのオーディオファイルまたはビデオファイルの再生URLを取得することはできません。 これらのファイルは、パブリックアクセス可能な有効な再生URLを使用して再生できます。

  • この状態のオーディオおよびビデオファイルに対して、トランスコーディングやスナップショットキャプチャなどの操作を実行できます。

説明

この表の [レビュー] ステータスは、オーディオファイルまたはビデオファイルに対して自動レビューまたは手動レビューが実行されていることを示します。 ファイルのステータスを表示するには、次の手順を実行します。ApsaraVideo VODコンソールにログインします。 左側のナビゲーションウィンドウで、[メディアファイル] > [オーディオ /ビデオ] を選択します。 [ビデオとオーディオ] ページで、[ステータス] 列にファイルのステータスを表示します。 自動レビューステータス列のレビューステータスは、オーディオファイルまたはビデオファイルに対して自動レビューが実行されていることを示します。 ファイルの自動レビューステータスを表示するには、次の手順を実行します。ApsaraVideo VODコンソールにログインします。 左側のナビゲーションウィンドウで、[レビュー管理]> [コンテンツモデレーション] を選択します。 表示される [コンテンツモデレーション] ページで、[自動レビューステータス] 列のファイルの自動レビューステータスを表示します。

ブロックされました

オーディオまたはビデオファイルがブロックされています。

  • このステータスのオーディオファイルまたはビデオファイルは、ApsaraVideo VODコンソールまたはセキュリティIPアドレスプレビューに記載されているレビューセキュリティグループのIPアドレスを使用してのみ再生できます。 再生用APIまたはSDKを使用してオーディオまたはビデオの再生URLを取得することはできません。 ただし、これらのファイルは、パブリックにアクセスできる有効な再生URLを使用して再生できます。

  • 削除操作は、ブロック状態のオーディオファイルまたはビデオファイルに対してのみ実行できます。 このステータスのオーディオファイルまたはビデオファイルでは、トランスコーディング、スナップショットキャプチャ、レビューなどの操作を実行できません

正常

オーディオまたはビデオファイルを再生できます。

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

  • Normalステータスのオーディオファイルまたはビデオファイルに対して、トランスコード、スナップショットキャプチャ、レビュー、再生などのすべての操作を実行できます。

ProduceFail

オーディオファイルまたはビデオファイルの作成に失敗しました。

オーディオファイルまたはビデオファイルがこの状態の場合、ファイルの作成に失敗します。 ApsaraVideo VODのオンライン編集機能を使用してビデオを作成する場合、使用するメディアアセットは [通常] ステータスである必要があります。 そうしないと、ビデオの制作に失敗する可能性があります。

ImageInfo: イメージに関する情報

パラメーター

タイプ

説明

ImageId

String

イメージの ID です。

URL

String

画像のURL。 CDNのドメイン名が指定されている場合、CDN URLが返されます。 それ以外の場合、Object Storage Service (OSS) URLが返されます。

タイトル

String

画像のタイトル。

タグ

String

画像のタグ。

ImageType

String

イメージのタイプ。

CateId

Long

画像が属するカテゴリのID。

CateName

String

カテゴリ名を示します。

説明

String

イメージの説明。

StorageLocation

String

イメージの保存場所。

メザニン

メザニン

イメージに関するソース情報。

CreationTime

String

イメージが作成された時刻。 時刻は UTC である必要があります。

ステータス

String

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

AppId

String

アプリケーションの ID

ステータス: イメージのステータス

説明

補足

アップロード

画像はアップロード中です。

これが画像の初期状態である。 画像がアップロードされていることを示します。 画像が長期間このステータスになっている場合は、「メディアアセットのアップロードに関するFAQ」に記載されている考えられる原因と解決策を確認してください。

アップロード失敗

イメージのアップロードに失敗しました。

アップロードの失敗は、ネットワークの中断やソースファイルの損傷などのエラーが原因で発生する可能性があります。 画像を再アップロードするか、別のソースファイルをアップロードすることを推奨します。

正常

画像がアップロードされます。

画像がこのステータスの場合、画像はアップロードされます。

AttachedMediaInfo: 補助メディア資産に関する情報

パラメーター

タイプ

説明

MediaId

String

補助メディアアセットのID。

URL

String

補助メディアアセットのURL。 CDNのドメイン名が指定されている場合、CDN URLが返されます。 それ以外の場合は、OSS URLが返されます。

タイトル

String

補助メディアアセットのタイトル。

タグ

String

補助メディアアセットのタグ。

タイプ

String

補助メディアアセットのタイプ。

Categories

カテゴリ []

カテゴリ。

説明

String

補助メディアアセットの説明。

StorageLocation

String

補助メディアアセットの保存場所。

CreationTime

String

補助メディアアセットが作成された時刻。 時刻は UTC である必要があります。

ModificationTime

String

補助メディアアセットが最後に変更された時刻。 時刻は UTC である必要があります。

ステータス

String

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

AppId

String

アプリケーションの ID

ステータス: 補助メディア資産のステータス

説明

補足

アップロード

補助メディア資産はアップロード中です。

これは、補助メディア資産の初期状態である。 これは、補助メディア資産がアップロードされていることを示す。

正常

補助メディア資産がアップロードされる。

なし。

アップロード失敗

補助メディア資産のアップロードに失敗しました。

なし。

ソースファイル情報

メザニン: ソースファイルに関する情報

パラメーター

タイプ

説明

VideoId

String

ソースファイルのID。

FileName

String

ソースファイルの名前。

有効期間

String

ソースファイルの長さ。 単位は秒です。

Status

String

ソースファイルのステータス。 詳細については、「ステータス: ソースファイルのステータス」をご参照ください。

CreationTime

String

ソースファイルが作成された時刻。 時刻は UTC である必要があります。

Height

Long

ソースファイルの高さ。 単位: ピクセル。

Long

ソースファイルの幅。 単位: ピクセル。

FPS

String

ソースファイルのフレームレート。 単位: FPS。

FileURL

String

ソースファイルのURL。

ビットレート

String

ソースファイルのビットレート。 単位:Kbit/秒

Size

Long

ソースファイルのサイズ。 単位はバイトです。

OutputType

String

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

  • oss: OSS URL

  • cdn: CDN URL

VideoStreamList

VideoStream []

各ビデオストリームに関する情報。

AudioStreamList

AudioStream []

各オーディオストリームに関する情報。

VideoStream: ビデオストリームに関する情報

パラメーター

タイプ

説明

Index

String

ビデオストリームのシーケンス番号。 値は、すべてのビデオストリームにおけるビデオストリームの位置を示します。

CodecName

String

エンコード形式の短い名前。

CodecLongName

String

エンコード形式のフルネーム。

Profile

String

コーデックプロファイル。

CodecTimeBase

String

コーデックのタイムベース。

CodecTagString

String

エンコード形式のタグ文字列。

CodecTag

String

エンコード形式のタグ。

Long

ビデオの幅 (ピクセル単位) 。

Height

Long

ビデオの高さ (ピクセル単位) 。

HasBFrames

String

ビデオストリームに双方向フレーム (Bフレーム) が含まれているかどうかを示します。

サー

String

サンプルアスペクト比 (SAR) 。

ダール

String

ディスプレイアスペクト比 (DAR) 。

PixFmt

String

ピクセル形式。

Level

String

コーデックのレベル。

FPS

String

出力ファイルのフレームレート。

AvgFPS

String

平均フレームレート。

タイムベース

String

タイムベース。

StartTime

String

ビデオが再生を開始する時間。

有効期間

String

ビデオの長さ。

NumFrames

String

フレームの総数。

Lang

String

言語。

Rotate

String

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

AudioStream: オーディオストリームに関する情報

パラメーター

タイプ

説明

Index

String

オーディオストリームのシーケンス番号。 値は、すべてのオーディオストリームにおけるオーディオストリームの位置を示します。

CodecName

String

エンコード形式の短い名前。

CodecLongName

String

エンコード形式のフルネーム。

CodecTimeBase

String

コーデックのタイムベース。

CodecTagString

String

エンコード形式のタグ文字列。

CodecTag

String

エンコード形式のタグ。

SampleFmt

String

サンプリング形式。

サンプルレート

String

サンプリングレート。

Channels

String

オーディオチャンネルの数。

ChannelLayout

String

オーディオチャンネルの出力レイアウト。

タイムベース

String

タイムベース。

StartTime

String

オーディオの再生を開始する時刻。

有効期間

String

オーディオの長さ。

ビットレート

String

ビットレート。

NumFrames

String

フレームの総数。

Lang

String

言語。

ステータス: ソースファイルのステータス

説明

補足

アップロード

ファイルはアップロード中です。

これは、ソースファイルの初期ステータスです。 ファイルがアップロード中であることを示します。

正常

ファイルがアップロードされます。

なし。

アップロード失敗

ファイルのアップロードに失敗しました。

なし。

削除済み

ファイルが削除されます。

なし。

メザニン: ソースイメージファイルに関する情報

パラメーター

タイプ

説明

FileURL

String

ソースイメージファイルのOSS URL。

OriginalFileName

String

ソースイメージファイルの名前。

FileSize

Long

ソースイメージファイルのサイズ。 単位はバイトです。

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

ジョブが失敗したときに返されるエラーコード。

エラーメッセージ

String

ジョブが失敗したときに返されるエラーメッセージ。

ステータス: URLベースのアップロードジョブのステータス

説明

保留中

アップロードジョブが送信され、処理されるのを待っています。

処理

アップロードジョブが処理中です。

ダウンロード

ファイルはダウンロード中です。

DOWNLOAD_SUCCESS

ファイルがダウンロードされます。

DOWNLOAD_FAIL

ファイルのダウンロードに失敗しました。

アップロード

ファイルはアップロード中です。

UPLOAD_SUCCESS

ファイルがアップロードされます。

UPLOAD_FAIL

ファイルのアップロードに失敗しました。

SUCCESS

アップロードジョブは成功し、コールバックは完了です。

オーディオとビデオの再生

VideoBase: オーディオまたはビデオファイルに関する基本情報

パラメーター

タイプ

説明

VideoId

String

オーディオファイルまたはビデオファイルのID。

タイトル

String

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

有効期間

String

オーディオまたはビデオファイルの長さ。 単位は秒です。

CoverURL

String

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

ステータス

String

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

CreationTime

String

オーディオまたはビデオファイルが作成された時刻。 時刻は UTC である必要があります。

MediaType

MediaType

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

  • video

  • audio

説明

デフォルトでは、再生操作はCDN URLを返します。 高速化ドメイン名が指定されていない場合、再生操作はOSS URLを返します。 この場合、MP4ファイルのURLのみを再生に使用できます。

PlayInfo: メディアストリームに関する再生情報

パラメーター

タイプ

説明

ビットレート

String

メディアストリームのビットレート。 単位:Kbit/秒

定義

String

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

  • FD: 低い定義

  • LD: 標準定義

  • SD: 高い定义

  • HD: 超高い定义

  • OD: 元の質

  • 2K: 2K解像度

  • 4K: 4K解像度

仕様

String

トランスコードされたメディアストリームの出力仕様。 詳細については、「メディアアセットのパラメーター」をご参照ください。

有効期間

String

メディアストリームの期間。 単位は秒です。

Encrypt

Long

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

  • 0: メディアストリームは暗号化されています。

  • 1: メディアストリームは暗号化されていません。

暗号化タイプ

String

メディアストリームで実行された暗号化の種類。 有効な値:

  • AliyunVoDCryption: Alibaba Cloud独自の暗号化

  • HLSEncryption: HTTPライブストリーミング (HLS) 暗号化

PlayURL

String

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

Format

String

メディアストリームの形式。

ファイルがビデオストリームの場合、次の値がサポートされます。

  • mp4

  • m3u8

ファイルがオーディオのみのストリームの場合、有効な値はmp3です。

FPS

String

メディアストリームのフレームレート。 単位: FPS。

Size

Long

メディアストリームのサイズ。 単位はバイトです。

Long

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

Height

Long

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

StreamType

String

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

  • ストリームがビデオストリームである場合、有効な値はビデオである。

  • ストリームがオーディオのみのストリームである場合、有効な値はオーディオである。

JobId

String

メディアストリームのトランスコードに使用されたジョブのID。 このIDは、メディアストリームを一意に識別する。

WatermarkId

String

メディアストリームに関連付けられている透かしのID。

Status

String

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

  • Normal: 各品質とフォーマットの最新のトランスコードされたストリームは、Normalステータスです。

  • Invisible: 複数のストリームが同じ品質と形式でトランスコードされている場合、最新のトランスコードされたストリームは [Normal] ステータスで、他のストリームは [Invisible] ステータスです。

NarrowBandType

String

Narrowband HDトランスコーディングのタイプ。 有効な値:

  • 0: 通常のトランスコード

  • 1.0: 狭帯域HD 1.0

  • 2.0: 狭帯域HD 2.0

このパラメーターは、組み込みのNarrowband HD 1.0コード変換テンプレートで使用できる定義を指定した場合にのみ有効になります。 詳細については、「TranscodeTemplate: トランスコードテンプレートの設定」をご参照ください。

CreationTime

String

メディアストリームが作成された時刻。 時刻は UTC である必要があります。

ModificationTime

String

メディアストリームが更新された時刻。 時刻は UTC である必要があります。

VideoMeta: オーディオまたはビデオファイルのメタデータ

パラメーター

タイプ

説明

VideoId

String

オーディオファイルまたはビデオファイルのID。

タイトル

String

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

有効期間

浮く

ビデオの長さ。 単位は秒です。

CoverURL

String

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

ステータス

String

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

メディア資産の照会

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

パラメーター

タイプ

説明

MediaId

String

メディアアセットのID。

CreationTime

String

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

MediaType

String

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

  • ビデオ: video

  • audio: audio

  • image:イメージ

  • 添付: 補助メディア資産

ビデオ

ビデオ

ビデオに関する情報。

オーディオ

Audio

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

[イメージ]

イメージ

イメージに関する情報。

AttachedMedia

AttachedMedia

補助メディアアセットに関する情報。

メディア資産カテゴリ

カテゴリ: メディアアセットに関するカテゴリ情報

パラメーター

データ型

説明

CateId

Long

カテゴリ ID を示します。

CateName

String

カテゴリ名を示します。 値の長さは最大64バイトで、UTF-8形式でエンコードする必要があります。

ParentId

Long

親カテゴリの ID。 レベル1カテゴリの親カテゴリIDは-1です。

レベル

Long

カテゴリのレベル。 値0はレベル1のカテゴリを示します。

VODに生きる

LiveRecordVideo: ライブto VODに関する情報

パラメーター

データ型

説明

StreamName

String

live-to-VODファイルの名前。

DomainName

String

エンドポイント。

AppName

String

アプリケーションの名前。

PlaylistId

String

プレイリストのID。

RecordStartTime

String

録音が開始される時刻。

RecordEndTime

String

録画が終了した時刻。

ビデオ

ビデオ

live-to-VODファイルに関する情報。

オンライン編集

EditingProject: オンライン編集プロジェクトに関する情報

パラメーター

データ型

説明

ProjectId

String

オンライン編集プロジェクトのID。

タイトル

String

オンライン編集プロジェクトのタイトル。

CreationTime

String

オンライン編集プロジェクトが作成された時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

たとえば、値2017-01-11T12:00:00Zは、2017年1月11日の20:00:00を示します。

ModifiedTime

String

オンライン編集プロジェクトが最後に変更された時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

たとえば、値2017-01-11T12:00:00Zは、2017年1月11日の20:00:00を示します。

Status

String

オンライン編集プロジェクトのステータス。

説明

String

オンライン編集プロジェクトの説明。

タイムライン

String

オンライン編集プロジェクトのタイムライン。 値はJSON文字列です。

有効期間

String

オンライン編集プロジェクトの期間。 期間はタイムラインの期間と同じでなければなりません。

CoverURL

String

オンライン編集プロジェクトのサムネイルURL。

ProjectStatus: オンライン編集プロジェクトのステータス

説明

補足

正常

オンライン編集プロジェクトがドラフトステータスになっています。

これは、オンライン編集プロジェクトの初期ステータスです。

制作

ビデオ制作が行われています。

なし。

生産

ビデオ制作は成功しています。

なし。

生産失敗

オーディオファイルまたはビデオファイルの作成に失敗しました。

なし。

素材: オンライン編集プロジェクトの素材に関する情報

説明

オンライン編集プロジェクトの資料は、メディアライブラリ内のメディアアセットまたはビデオの資料です。

パラメーター

タイプ

説明

MaterialId

String

マテリアルのID。

タイトル

String

素材のタイトル。

説明

String

材料の説明。

有効期間

浮く

材料の持続時間。 単位は秒です。 値は小数点以下4桁まで正確です。

CoverURL

String

マテリアルのサムネイルURL。

Status

String

マテリアルのステータス。

CreationTime

String

マテリアルが作成された時刻。 時刻は UTC で表示されます。

Size

Long

ソースファイルのサイズ。 単位はバイトです。

CateId

Long

マテリアルのカテゴリID。

CateName

String

マテリアルのカテゴリ名。

タグ

String

材料のタグ。 複数のタグはコンマ (,) で区切ります。

スナップショット

String[]

マテリアルスナップショットのURL。 値は配列です。

スプライト

String[]

マテリアルスプライトのスナップショットのURL。 値は配列です。

ProduceConfig: 構成のビデオ制作

パラメーター

タイプ

説明

TemplateGroupId

String

生成されたビデオのトランスコードに使用されるトランスコードテンプレートグループのID。 生成されたビデオファイルは、トランスコードのソースファイルとして使用されます。 コード変換プロセスは、ファイルがアップロードされた後に実行されるプロセスと同様です。

このパラメーターはオプションです。 このパラメーターを空のままにすると、デフォルトのテンプレートグループがトランスコードに使用されます。 このパラメーターを指定すると、指定されたテンプレートグループがトランスコードに使用されます。 テンプレートグループIDを表示するには、ApsaraVideo VODコンソールの [トランスコードテンプレートグループ] ページに移動します。

TemplateId

String

ビデオ制作に使用されるテンプレートのID。 生成されたメディアファイルは、メディアリソースのソースファイルとして使用される。 このパラメーターはオプションです。 このパラメーターを空のままにすると、ApsaraVideo VODはビデオ制作に組み込みのオンライン編集テンプレートを使用します。

ビデオファイルを作成する場合、組み込みテンプレートのエンコード形式はH.264、コンテナ形式はMP4です。

ビデオ制作用のカスタムパラメータを作成する場合は、チケットを起票して。 たとえば、アニメーションステッカーを作成したり、字幕をインテリジェントに作成したり、M3U8プレイリストに基づいてビデオを編集したり、カスタム制作パラメータを使用したりする場合は、チケットを起票して特定のテンプレートを申請してください。

Integer

生成されたビデオの幅。 単位: ピクセル。

このパラメーターはオプションです。 デフォルトの幅は、タイムラインで使用されるビデオクリップのソースファイルの最大幅です。

たとえば、タイムラインでは3つのビデオクリップが使用されます。 ソースファイルの解像度は、1280 × 720ピクセル、1920 × 1080ピクセル、720 × 1280ピクセルです。 この場合、生成される映像の出力解像度は1920 × 1280画素となる。

Height

Integer

制作されたビデオの高さ。 単位: ピクセル。

このパラメーターはオプションです。 デフォルトの幅は、タイムラインで使用されるビデオクリップのソースファイルの最大幅です。

たとえば、タイムラインでは3つのビデオクリップが使用されます。 ソースファイルの解像度は、1280 × 720ピクセル、1920 × 1080ピクセル、720 × 1280ピクセルです。 この場合、生成される映像の出力解像度は1920 × 1280画素となる。

ビットレート

Integer

生成されたビデオのビットレート。 単位:Kbit/秒

このパラメーターはオプションです。 デフォルト値は、タイムラインで指定したソースファイルの最大ビットレートです。

たとえば、タイムラインに3つのマテリアルを指定し、ソースファイルのビットレートを400、600、および800 Kbit/sとします。 この場合、生成されるビデオのデフォルトビットレートは800 Kbit/sである。

StorageLocation

String

生成されたファイルの格納アドレス。 このパラメータは、生成されたファイルが中国 (上海) 以外のリージョンに格納されている場合に必要です。

MediaMetadata: メディアリソースのメタデータ

パラメーター

タイプ

説明

タイトル

String

制作されたビデオのタイトル。 値の長さは最大128バイトで、UTF-8でエンコードする必要があります。

説明

String

作成されたビデオの説明。 値の長さは最大1,024バイトで、UTF-8でエンコードする必要があります。

CoverURL

String

作成されたビデオのカスタムサムネイルのURL。

CateId

String

作成されたビデオのカテゴリID。 カテゴリIDを変更または表示するには、次の操作を実行します。ApsaraVideo VODコンソールにログインします。 左側のナビゲーションウィンドウで、[設定管理] > [メディア管理] > [カテゴリ] を選択します。

タグ

String

制作されたビデオのタグ。 各タグ名の長さは最大32バイトです。 最大16個のタグを指定できます。 複数入力する場合は、コンマ (,) で区切ります。 文字列はUTF-8形式でエンコードする必要があります。

オンライン編集 (新しいエディタ)

説明

オンライン編集機能は、特定のリージョンではサポートされていません。 機能を使用する前に、ApsaraVideo VODがアクティブ化されているリージョンで機能がサポートされていることを確認してください。 詳しくは、「リージョンとゾーン」をご参照ください。 古いエディターのオンライン編集データ型の詳細については、「オンライン編集データ型-古いエディター」をご参照ください。

タイムライン: オンライン編集プロジェクトのタイムラインに関する情報

マテリアルを追加し、特殊効果を設定してビデオを作成すると、タイムラインが作成されます。 タイムラインは、トラック、マテリアル、エフェクトで构成されます。

パラメーター

タイプ

必須

説明

VideoTracks

VideoTrack []

いいえ。 ビデオトラックとオーディオトラックを同時に空にすることはできません。

ビデオトラック。 ビデオトラックは、MediaId配列要素のシーケンスに基づいてオーバーレイされます。 例えば、第1のMediaId配列要素に対応するトラックは、第2のMediaId配列要素に対応するトラックの下に配置される。

AudioTracks

AudioTrack []

いいえ。 ビデオトラックとオーディオトラックを同時に空にすることはできません。

オーディオトラック。

SubtitleTracks

SubtitleTrack []

選択可能

字幕トラック。

EffectTracks

EffectTrack []

選択可能

エフェクトトラック。

VideoTrack: ビデオトラックに関する情報

VideoTrackは、ビデオと画像の素材を配置するために使用されます。

パラメーター

タイプ

必須

説明

タイプ

String

任意

ビデオトラックのタイプ。 デフォルトでは、通常のビデオトラックが使用されます。

Type=Effectを指定すると、ビデオトラックを特殊効果に使用できます。 特殊効果にビデオトラックを使用する場合は、VideoTrackClipsをEffectTrackItemに設定します。

メイントラック

ブール値

選択可能

現在のオーディオトラックがプライマリトラックかどうかを示します。 デフォルト値:False。

VideoTrackClips

VideoTrackClip []

必須

ビデオトラックのマテリアル。

AudioTrack: オーディオトラックに関する情報

AudioTrackは、オーディオのみの素材とオーディオを含むビデオ素材を配置するために使用されます。

パラメーター

タイプ

必須

説明

メイントラック

ブール値

選択可能

現在のオーディオトラックがプライマリトラックかどうかを示します。 デフォルト値:False。

AudioTrackClips

AudioTrackClip []

必須

オーディオトラックのマテリアル。

SubtitleTrack: 字幕トラックに関する情報

SubtitleTrackは、バナーテキストや外部字幕などの字幕を配置するために使用されます。

パラメーター

タイプ

必須

説明

SubtitleTrackClips

SubtitleTrackClip []

必須

字幕トラックのマテリアル。

EffectTrack: エフェクトトラックに関する情報

EffectTrackは、ビデオに特殊効果を追加するために使用されます。 エフェクトトラックにフィルターと視覚効果を追加できます。

パラメーター

タイプ

必須

説明

EffectTrackItems

EffectTrackItem []

必須

特殊効果トラックに追加されるフィルターとエフェクト。

VideoTrackClip: ビデオトラックのマテリアルに関する情報

ビデオと画像をビデオトラックに追加できます。

In、Out、TimelineIn、およびTimelineOutを使用して、マテリアルをカットしてタイムラインに追加する位置を指定できます。 たとえば、Inを5、Outを10、TimelineInを15、TimelineOutを20に設定した場合、5秒から10秒までの素材は、タイムラインの15秒から20秒までカットされて再生されます。

パラメーター

タイプ

必須

説明

MediaId

String

任意

マテリアルがカットされるソースファイルのID。 メディアIDは、ビデオID (VideoID) と画像ID (ImageId) とを含む。

タイプ

String

任意

マテリアルのタイプ。 デフォルト値: Video。

有効な値:

  • ビデオ

  • イメージ

  • GlobalImage: グローバルイメージのデュレーションは、ビデオトラックのデュレーションと同じです。

GlobalImageの詳細については、「ビデオ全体への画像の追加」をご参照ください。

X

浮く

選択可能

マテリアルの左上隅と出力ビデオの左上隅の間の水平距離。 値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数である場合、値はピクセルの数を示す。

Y

浮く

選択可能

マテリアルの左上隅と出力ビデオの左上隅の間の垂直距離。 値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数である場合、値はピクセルの数を示す。

浮く

選択可能

出力ビデオのマテリアルの幅。 値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数である場合、値はピクセルの数を示す。

Height

浮く

選択可能

出力ビデオのマテリアルの高さ。 値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数である場合、値はピクセルの数を示す。

AdaptMode

String

任意

マテリアルが自動的にサイズ変更されるモード。 このパラメーターは、ビューの幅と高さを指定した場合にのみ有効です。 マテリアルは、ビューの幅と高さに基づいてスケーリングされます。 有効な値:

  • Contain: マテリアルの元のアスペクト比に基づいてマテリアルのサイズを変更します。

  • カバー: 元のアスペクト比に基づいてマテリアルのサイズを変更し、ビューを埋めてオーバーフローをトリミングします。

  • 塗りつぶし (デフォルト): 元のアスペクト比に基づいてマテリアルのサイズを変更し、マテリアルをストレッチしてビューに塗りつぶします。

この場合、顧客 ID、つまり MD5 (customer-id) のハッシュ値を計算し、ファイル名のプレフィックスとして数文字のハッシュプレフィックスを組み合わせることができます。

浮く

選択可能

ソースファイル内のマテリアルの開始時刻。 ソースファイルは、オーディオファイルまたはビデオファイルである必要があります。 単位は秒です。 値は小数点以下4桁まで正確です。 Inを指定しない場合、デフォルトでは0が使用されます。

アウト

浮く

選択可能

ソースファイル内のマテリアルの終了時刻。 ソースファイルは、オーディオファイルまたはビデオファイルである必要があります。 単位は秒です。 値は小数点以下4桁まで正確です。 Outを指定しない場合、ソースファイルの終了時にマテリアルが終了します。

MaxOut

浮く

選択可能

材料の最大終了時間。 このパラメーターを指定した場合、マテリアルの終了時刻は、ソースファイルの長さとMaxOutの値の間の小さい値になります。 このパラメーターは、ソースファイルがオーディオファイルまたはビデオファイルの場合にのみ有効になります。 単位は秒です。 値は小数点以下4桁まで正確です。 Outを指定すると、MaxOutは無効になります。

詳細については、「ビデオトラックのMaxOutの設定」をご参照ください。

有効期間

浮く

選択可能

材料の持続時間。 ほとんどの場合、このパラメータは画像に使用されます。 単位は秒です。 値は小数点以下4桁まで正確です。

DyncFrames

Int

選択可能

アニメーションステッカーのフレームレート。 このパラメーターは、ソースファイルが動的イメージの場合にのみ有効です。

詳細については、「GIFステッカーの使用」をご参照ください。

TimelineIn

浮く

選択可能

タイムラインでのマテリアルの開始時刻。 単位は秒です。 値は小数点以下4桁まで正確です。 TimelineInを指定しない場合、タイムラインの前のマテリアルの表示が終了したときにマテリアルが表示されます。

TimelineOut

浮く

選択可能

タイムラインでのマテリアルの終了時刻。 単位は秒です。 値は小数点以下4桁まで正確です。 TimelineInを指定しない場合、タイムラインで次のマテリアルの表示が開始されると、マテリアルの表示が停止します。

速度

浮く

選択可能

マテリアルの再生速度。 有効な値: 0.1〜100。 たとえば、このパラメータを2に設定すると、出力ビデオでは元の速度の2倍の速度でマテリアルが再生されます。 この場合、材料の持続時間は半分に短縮されます。

詳細については、「速度ランピングの設定」をご参照ください。

MaskVideoUrl

String

任意

マスクファイルのURL。 ほとんどの場合、マスクファイルはアルファチャンネルを含むビデオです。 アルファチャンネルを使用して、元のビデオに透明度情報を追加できます。

このパラメーターはOSS URLにのみ設定できます。

効果

効果 []

選択可能

マテリアルに使用される特殊効果。

AudioTrackClip: オーディオトラックの素材に関する情報

オーディオを含むオーディオのみのマテリアルやビデオをオーディオトラックに追加できます。

In、Out、TimelineIn、およびTimelineOutパラメーターを使用して、マテリアルをカットしてタイムラインに追加する位置を指定できます。 たとえば、Inを5、Outを10、TimelineInを15、TimelineOutを20に設定した場合、5秒から10秒までのマテリアルは、タイムラインの15秒から20秒までのループでカットされて再生されます。

パラメーター

タイプ

必須

説明

MediaId

String

任意

マテリアルがカットされるソースファイルのID。

この場合、顧客 ID、つまり MD5 (customer-id) のハッシュ値を計算し、ファイル名のプレフィックスとして数文字のハッシュプレフィックスを組み合わせることができます。

浮く

選択可能

ソースファイル内のマテリアルの開始時刻。 単位は秒です。 値は小数点以下4桁まで正確です。 Inを指定しない場合、デフォルトでは0が使用されます。

アウト

浮く

選択可能

ソースファイル内のマテリアルの終了時刻。 単位は秒です。 値は小数点以下4桁まで正確です。 Outを指定しない場合、ソースファイルの終了時にマテリアルが終了します。

TimelineIn

浮く

選択可能

タイムラインでのマテリアルの開始時刻。 単位は秒です。 値は小数点以下4桁まで正確です。 TimelineInを指定しない場合、タイムラインの前のマテリアルの表示が終了したときにマテリアルが表示されます。

TimelineOut

浮く

選択可能

タイムラインでのマテリアルの終了時刻。 単位は秒です。 値は小数点以下4桁まで正確です。 TimelineInを指定しない場合、タイムラインで次のマテリアルの表示が開始されると、マテリアルの表示が停止します。

速度

浮く

選択可能

マテリアルの再生速度。 有効な値: 0.1〜100。 たとえば、このパラメータを2に設定すると、出力ビデオでは元の速度の2倍の速度でマテリアルが再生されます。 この場合、材料の持続時間は半分に短縮されます。

詳細については、「速度ランピングの設定」をご参照ください。

効果

効果 []

選択可能

マテリアルに使用される特殊効果。

LoopMode

ブール値

選択可能

タイムライン内のマテリアルのループ効果。 Trueはマテリアルがループで再生されることを示し、Falseはマテリアルにループ効果が設定されていないことを示します。 デフォルト値:False。

詳細については、「オーディオループ再生の設定」をご参照ください。

SubtitleTrackClip: 字幕トラックのマテリアルに関する情報

字幕トラックに字幕素材を追加できます。

パラメーター

タイプ

必須

説明

タイプ

String

必須

字幕素材のタイプ。 有効な値:

  • 字幕: 外部字幕

  • テキスト: バナーテキスト

サブタイプ

String

任意

字幕素材のサブタイプ。 有効な値:

  • srt: SRT形式の外部字幕

  • ass: ASS形式の外部字幕

TypeをTextに設定した場合は、このパラメーターを無視します。

FileURL

String

任意

字幕ファイルのOSS URL。 このパラメーターは、TypeをSubtitleに設定した場合に必要です。 このパラメーターを次の形式で指定します。

https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.srt

詳細については、「ビデオ編集での字幕ファイルの使用」をご参照ください。

説明

このパラメーターには、パブリックOSS URLのみを指定できます。 HTTPS URL、高速化OSS URL、およびCDN URLはサポートされていません。

X

浮く

選択可能

テキストと出力ビデオの左上隅の間の水平距離。 このパラメーターは、タイプをテキストに設定した場合に有効になります。 値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数の場合、値はピクセルの数を示します。

Y

浮く

選択可能

テキストと出力ビデオの左上隅の間の垂直距離。 このパラメーターは、タイプをテキストに設定した場合に有効になります。 値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数の場合、値はピクセルの数を示します。

TimelineIn

浮く

選択可能

タイムライン内のテキストの開始時刻。 このパラメーターは、タイプをテキストに設定した場合に有効になります。 単位は秒です。 値は小数点以下4桁まで正確です。 TimelineInを指定しない場合、タイムラインの前のテキストの表示が終了したときにテキストが表示されます。

TimelineOut

浮く

選択可能

タイムライン内のテキストの終了時刻。 このパラメーターは、タイプをテキストに設定した場合に有効になります。 単位は秒です。 値は小数点以下4桁まで正確です。 TimelineOutを指定しない場合、タイムラインの次のテキストの表示が開始されると、テキストの表示が停止します。

Content

String

任意

テキスト。 このパラメーターは、タイプをテキストに設定した場合に必要です。

フォント

String

任意

テキストのフォント。 このパラメーターは、タイプをテキストに設定した場合に有効になります。 デフォルト値: SimSun。 サポートされているフォントの詳細については、「フォント」をご参照ください。

FontSize

Int

選択可能

テキストのサイズ。 このパラメーターは、タイプをテキストに設定した場合に有効になります。

FontColor

String

任意

テキストの色。 値は、数字記号 (#) と16進値の形式です。 このパラメーターは、タイプをテキストに設定した場合に有効になります。 例: #ffffff.

FontColorOpacity

String

任意

フォントの透明度。 有効な値は 0~1 です。 デフォルト値は 1 です。 1はフォントが透明でないことを示し、0はフォントが完全に透明であることを示します。 このパラメータは、タイプをテキストに設定したときに有効になります。

フォントフェイス

FontFace

選択可能

フォントの外観。 このパラメータは、タイプをテキストに設定したときに有効になります。

パディング

Int

選択可能

テキストの単語間隔。 このパラメータは、タイプをテキストに設定したときに有効になります。 単位: ピクセル。 デフォルト値:0

角度

浮く

選択可能

テキストの反時計回りの回転角度。 このパラメータは、タイプをテキストに設定したときに有効になります。 単位は度で、 デフォルト値:0

BorderStyle

Int

選択可能

テキストの境界線のスタイル。 有効な値: 1と3。 1はテキストに境界と影があることを示し、3はテキストに背景があることを示します。 デフォルト値は 1 です。

概要

Int

選択可能

テキストのストローク幅。 このパラメータは、タイプをテキストに設定したときに有効になります。 単位: ピクセル。 デフォルト値:0

OutlineColour

String

任意

16進形式のテキストの線の色。 値は数字記号 (#) で始まります。 このパラメータは、タイプをテキストに設定したときに有効になります。 例: #ffffff.

Int

選択可能

テキストの影のサイズ。 単位: ピクセル。 デフォルト値:0 このパラメータは、タイプをテキストに設定したときに有効になります。

バックカラー

String

任意

16進形式のテキストの影の色。 値は数字記号 (#) で始まります。 このパラメータは、タイプをテキストに設定したときに有効になります。 例: #ffffff.

整列

String

任意

テキストの配置。The text alignment. デフォルト値: TopLeft。 このパラメータは、タイプをテキストに設定したときに有効になります。 有効な値:

  • トップ左

  • TopCenter

  • TopRight

  • センター左

  • CenterCenter

  • センターライト

  • BottomLeft

  • BottomCenter

  • BottomRight

AdaptMode

String

任意

テキストがビデオの幅または指定したTextWidthを超えた場合に、自動改行または自動スケーリングを有効にするかどうかを示します。 有効な値:

  • AutoWrap: 自動改行を有効にします

  • AutoScale: 自動スケーリングを有効にする

  • AutoWrapAtSpaces: テキストが英語で表示されている場合にのみ、空白を使用してテキストを自動的にラップします。

テキスト幅

Integer

選択可能

テキストボックスの幅。 このパラメーターは、AdaptModeを指定すると有効になります。 このパラメーターは、自動改行または自動スケーリングを有効にするときに使用されます。 このパラメーターを指定しない場合、ビデオ幅は自動改行または自動スケーリングに使用されます。 単位: ピクセル。

FontUrl

String

任意

OSS内のフォントファイルのURL。 フォントファイルの形式は、ttf、otf、woffです。 このパラメータは、タイプをテキストに設定したときに有効になります。 例: https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf.

EffectColorStyle

String

任意

テキストのワードアート効果。 このパラメータは、タイプをテキストに設定したときに有効になります。

ワードアート効果の詳細については、「ワードアート効果の例」をご参照ください。

AaiMotionInEffect

String

任意

テキストの入り口効果。 このパラメータは、タイプをテキストに設定したときに有効になります。

エントランスエフェクトの詳細については、「エントランスエフェクト」をご参照ください。

AaiMotionIn

浮く

選択可能

入り口効果の持続時間。 単位は秒です。 値は小数点以下4桁まで正確です。 AaiMotionInを指定しない場合、このパラメーターのデフォルト値は0.5秒です。 テキストが0.5秒未満表示される場合、入口効果の持続時間は、テキストの合計持続時間から出口効果の持続時間を引いたものになります。 このパラメータは、タイプをテキストに設定したときに有効になります。

AaiMotionOutEffect

String

任意

テキストの終了効果。 このパラメータは、タイプをテキストに設定したときに有効になります。

終了効果の詳細については、「終了効果」をご参照ください。

AaiMotionOut

浮く

選択可能

終了効果の持続時間。 単位は秒です。 値は小数点以下4桁まで正確です。 AaiMotionOutを指定しない場合、このパラメーターのデフォルト値は0.5秒です。 テキストの表示時間が0.5秒未満の場合、終了効果の時間はテキストの合計時間になります。 このパラメータは、タイプをテキストに設定したときに有効になります。

AaiMotionLoopEffect

String

任意

テキストのループ効果。 ループ効果は、入口効果または出口効果とともに有効になります。 このパラメータは、タイプをテキストに設定したときに有効になります。

ループ効果の詳細については、「ループ効果」をご参照ください。

比率

浮く

選択可能

ループ効果の速度。 値は小数点以下4桁まで正確です。 このパラメーターを指定しない場合、デフォルトで1が使用されます。 1より大きい値は、より高いループ速度を示し、1より小さい値は、より遅いループ速度を示す。 このパラメータは、タイプをテキストに設定したときに有効になります。

EffectTrackItem: エフェクトトラックに関する情報

エフェクトトラックに視覚効果とフィルターを追加できます。

パラメーター

タイプ

必須

説明

タイプ

String

必須

特殊効果のタイプ。 有効な値: VFXとフィルター。

サブタイプ

String

必須

特殊効果のサブタイプ。 サポートされている特殊効果の詳細については、「特殊効果の例」および「フィルター効果の例」をご参照ください。

TimelineIn

浮く

選択可能

タイムラインでの特殊効果の開始時刻。 単位は秒です。 値は小数点以下4桁まで正確です。 TimelineInを指定しない場合、デフォルトでは0が使用されます。

TimelineOut

浮く

選択可能

タイムラインでの特殊効果の終了時刻。 単位は秒です。 値は小数点以下4桁まで正確です。 TimelineOutを指定しない場合、特殊効果はビデオの終了時に終了します。

有効期間

浮く

選択可能

タイムラインでの特殊効果の持続時間。 単位は秒です。 値は小数点以下4桁まで正確です。 Durationを指定しない場合、ビデオのデュレーションが使用されます。

説明

DurationまたはTimelineOutのいずれかを指定できます。

X

浮く

選択可能

このパラメーターは、SubTypeがmosaic_rect/blurに設定されている場合にのみ有効です。 エフェクトエリアの左上隅と出力ビデオの左上隅の間の水平距離。

値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数である場合、値はピクセルの数を示す。

Y

浮く

選択可能

このパラメーターは、SubTypeがmosaic_rect/blurに設定されている場合にのみ有効です。

エフェクトエリアの左上隅と出力ビデオの左上隅の間の垂直距離。 値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数である場合、値はピクセルの数を示す。

浮く

選択可能

このパラメーターは、SubTypeがmosaic_rect/blurに設定されている場合にのみ有効です。 出力ビデオのエフェクト領域の幅。 値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数である場合、値はピクセルの数を示す。

Height

浮く

選択可能

このパラメーターは、SubTypeがmosaic_rect/blurに設定されている場合にのみ有効です。 出力ビデオのエフェクト領域の高さ。 値をパーセンテージまたはピクセル数に設定できます。 値の範囲が0から0.9999の場合、値はパーセンテージを示します。 値が2以上の整数である場合、値はピクセルの数を示す。

FontFace: フォントスタイル

パラメーター

タイプ

必須

説明

太さ

ブール値

選択可能

フォントが太字かどうかを示します。

イタリック

ブール値

選択可能

フォントが斜体かどうかを示します。

下線

ブール値

選択可能

フォントに下線が付いているかどうかを示します。

エフェクト: エフェクトに関する情報

異なる効果は異なるパラメータを有する。 特定のパラメータは複数の効果に使用されます。

エフェクトパラメーターの詳細については、「エフェクト設定」をご参照ください。

次の表に、エフェクトの一般的なパラメーターを示します。

パラメーター

タイプ

必須

説明

タイプ

String

必須

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

  • テキスト: ビデオトラックの素材にバナーテキストを追加します。

  • DeWatermark: ビデオトラックの素材の透かしをぼかします。

  • トリミング: ビデオトラックのマテリアルをトリミングします。

  • スケール: ビデオトラックのマテリアルをスケーリングします。

  • パッド: ビデオトラックの素材にパディングを追加します。

  • 背景: ビデオトラックの素材に背景を追加します。

  • トランジション: ビデオトラックのマテリアルにトランジション効果を追加します。

  • VFX: ビデオトラックのマテリアルに視覚効果を追加します。

  • フィルター: ビデオトラックの素材にフィルターを追加します。

  • ボリューム: オーディオトラックの素材の音量を調整します。

  • AFade: オーディオトラック内のマテリアルのオーディオフェードインとフェードアウトを設定します。

  • 回転: ビデオトラック内のマテリアルの回転を設定します。

  • クリップ: 素材のランダムな部分をカットします。

  • フリップ: 素材を反転させます。

  • KenBurns: カメラを調整します。

  • ズーム: マテリアルのズームを設定します。

サブタイプ

String

任意

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

  • [タイプ] を [トランジション] に設定した場合、このパラメーターはトランジション効果のサブタイプを示します。 このパラメーターの詳細については、「トランジション効果の例」をご参照ください。

  • タイプをVFXに設定した場合、このパラメーターは視覚効果のサブタイプを示します。 このパラメーターの詳細については、「特殊効果の例」をご参照ください。

  • [タイプ] を [フィルター] に設定した場合、このパラメーターはフィルター効果のサブタイプを示します。 このパラメーターの詳細については、「フィルター効果の例」をご参照ください。

スナップショットとアニメーションステッカー

SnapshotJob: スナップショットジョブに関する情報

パラメーター

タイプ

説明

JobId

String

コード変換ジョブのID。

VodTemplateInfo: スナップショットテンプレートに関する情報

パラメーター

タイプ

説明

名前

String

テンプレートの名前を設定します。

VodTemplateId

String

テンプレートのID。

TemplateType

String

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

  • Snapshot: スナップショットテンプレート

  • DynamicImage: アニメーションステッカーテンプレート

IsDefault

String

デフォルトテンプレートを使用するかどうかを示します。 有効な値:

  • デフォルト

  • NotDefault

TemplateConfig

JSON

テンプレートの詳細な設定。 値はJSON文字列です。

CreationTime

String

テンプレートが作成された時刻。 時刻は UTC で表示されます。

ModifyTime

String

テンプレートが最後に変更された時刻。 時刻はUTCで表示されます。

MediaSnapshot: メディアスナップショットデータ

パラメーター

タイプ

説明

JobId

String

スナップショットジョブのID。

CreationTime

String

スナップショットジョブが作成された時刻。 時刻は UTC で表示されます。

Total

Long

スナップショットの総数。

レギュラー

String

スナップショットURLの生成に使用されるルール。

スナップショット

スナップショット []

スナップショットデータ。

スナップショット: スナップショットに関する情報

パラメーター

タイプ

説明

インデックス

文字列

スナップショットのインデックス。

Url

String

スナップショットのURL。

DynamicImage: アニメーションステッカーに関する情報

パラメーター

タイプ

説明

VideoId

String

オーディオファイルまたはビデオファイルのID。

DynamicImageId

String

アニメーションステッカーのID。

FileURL

String

アニメーションステッカーファイルのURL。

String

アニメーションステッカーの幅。

Height

文字列

アニメーションステッカーの高さ。

有効期間

文字列

アニメーションステッカーの長さ。

Format

文字列

アニメーションステッカーの形式。 有効な値: gifとwebp。

FileSize

String

アニメーションのステッカーファイルのサイズ。

FPS

String

アニメーションステッカーのフレームレート。

透かし加工

WatermarkInfo: 透かしに関する情報

パラメーター

タイプ

必須

説明

CreationTime

文字列

はい

ウォーターマークが追加された時刻。

名前

文字列

はい

透かしの名前。

IsDefault

String

必須

デフォルトの透かしが使用されるかどうかを示します。 有効な値:

  • デフォルト

  • NotDefault

タイプ

String

必須

透かしのタイプ。 有効な値:

  • イメージ

  • テキスト

WatermarkId

String

必須

透かしのID。

FileUrl

String

いいえ

透かしファイルのOSS URLまたはCDN URL。 このパラメーターは、テキスト透かしには適用されません。

WatermarkConfig

WatermarkConfig

必須

テキスト透かしや画像透かしの位置や効果などの設定。 値はJSON文字列である必要があります。

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

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

パラメーター

タイプ

説明

JobId

String

コード変換ジョブのID。

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

パラメーター

タイプ

必須

説明

名前

String

必須

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

TranscodeTemplateGroupId

String

必須

コード変換テンプレートグループのID。

IsDefault

String

必須

デフォルトのトランスコードテンプレートグループを使用するかどうかを示します。

  • デフォルト

  • NotDefault

CreationTime

String

必須

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

ModifyTime

String

必須

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

TranscodeTemplateList

TranscodeTemplate []

必須

コード変換テンプレートに関する情報。

TranscodeTemplate: トランスコードテンプレートの設定

パラメーター

タイプ

必須

説明

タイプ

String

任意

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

  • Normal: 通常のトランスコードテンプレート

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

  • VideoPackage: ビデオストリーム包装テンプレート

    このタイプのテンプレートを使用すると、ApsaraVideo VODはビデオを異なるビットレートのビデオストリームにトランスコードし、マルチビットレートビデオパッケージを作成します。 このタイプのテンプレートには、PackageSettingパラメーターを設定する必要があります。

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

    このタイプのテンプレートを使用する場合、ApsaraVideo VODは、対応するビデオのマルチビットレートビデオストリームをパッケージ化することによって生成される出力ファイルに字幕情報を追加します。 字幕パッケージテンプレートにPackageSettingパラメーターを設定し、字幕パッケージテンプレートをビデオストリームパッケージテンプレートに関連付ける必要があります。 テンプレートグループに設定できる字幕パッケージテンプレートは1つだけです。

デフォルト値: Normal。

ビデオ

ビデオ

必須

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

Audio

オーディオ

必須

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

定義

String

必須

トランスコードテンプレートの定義。 通常のトランスコードテンプレートの定義に有効な値:

  • LD: 低い定義。

  • SD: 標準定義。

  • HD: 高い定義。

  • FHD: 超高い定义

  • OD: 元の質。 この値は、コンテナー形式の変換に使用されます。

  • 2K

  • 4K

  • SQ: 標準的な音質

  • HQ: 高い音質

説明
  • このパラメーターは、トランスコードテンプレートに設定されている定義を示しますが、トランスコードされたビデオの実際の解像度範囲は示しません。 テンプレート定義と出力ビデオ解像度のマッピングの詳細については、「仕様」をご参照ください。

  • テンプレートの定義は、トランスコード料金には影響しません。 コード変換料金の詳細については、「ApsaraVideo VODのコード変換プラン」をご参照ください。

Narrowband HD 1.0トランスコードテンプレートの定義に有効な値:

  • LD-NBV1: 低い定义

  • SD-NBV1: 標準定義

  • HD-NBV1: 高い定义

  • FHD-NBV1: 超高い定义

  • 2K-NBV1

  • 4K-NBV

説明
  • トランスコードテンプレートの定義は変更できません。

  • Narrowband HDのシステムパラメータを変更することはできません™ビデオ解像度、オーディオ解像度、ビットレートなどのコード変換テンプレートを1.0します。 パラメーターの詳細については、「Narrowband HD TM 1.0」をご参照ください。

  • FLV、M3U8 (HLS) 、およびMP4出力形式をサポートするNarrowband HD 1.0コード変換テンプレートのみを作成できます。

Container

コンテナ

必須

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

MuxConfig

MuxConfig

選択可能

コード変換セグメントの設定。 FormatパラメーターがHLSに設定されている場合は、このパラメーターを設定する必要があります。 値はJSON文字列です。

TransConfig

TransConfig

選択可能

条件付きトランスコード設定。 トランスコードされたビデオが生成される前に、ソースファイルのビットレートと解像度に基づいて基本ロジックを決定する必要がある場合は、このパラメーターを指定できます。 値はJSON文字列です。

TranscodeFileRegular

String

任意

出力ファイルの格納に使用されるカスタムパス。

説明
  • 次のワイルドカードがサポートされています: {MediaId} 、{JobId} 、および {PlayDefinition} 。 MediaIdパラメーターは、ビデオIDを示します。 JobIdパラメーターは、トランスコードジョブIDを示します。 PlayDefinitionパラメーターは、GetPlayInfo操作に対する応答で返される定義を示します。

  • 値には、数字、文字、中かっこ {}、スラッシュ (/) 、ハイフン (-) 、およびアンダースコア (_) のみを使用できます。 値の長さは、最大 128 文字です。

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

{MediaId}/watermark-{PlayDefinition}: トランスコーディング中、ApsaraVideo VODは {MediaId} をビデオIDに、{PlayDefinition} を定義に置き換えます。 例えば、ビデオIDは8ff5cc93f6da4079a47a77bf71dとすることができ、定義はfdとすることができる。

出力パス

8ff5cc93f6da4079a47a77bf7 1d/watermark-fd.mp4: ApsaraVideo VODは、などのファイル名拡張子を自動的に追加します。mp4, . m3u8、または. flv。

クリップ

クリップ

選択可能

ビデオのトリミング設定。 値はJSON文字列である必要があります。

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

Rotate

String

任意

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

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

暗号化設定

EncryptSetting

選択可能

トランスコードの暗号化設定。

PackageSetting

PackageSetting

選択可能

パッケージング構成。 HLSパッケージとDynamic Adaptive Streaming over HTTP (DASH) パッケージのみがサポートされています。 値はJSON文字列です。

SubtitleList

SubtitleConfig

選択可能

字幕の設定。 値はJSON文字列です。

WatermarkId

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"
}
                        

ビデオ: ビデオストリームのトランスコード設定

説明
  • ほとんどの場合、Codec、Bitrate、Height、およびWidthパラメーターを設定し、Removeパラメーターをfalseに設定するだけで済みます。

  • 出力ビデオファイルの幅または高さパラメーターを設定することを推奨します。 これにより、出力ビデオファイルのアスペクト比がソースファイルのアスペクト比と同じになります。

パラメーター

タイプ

必須

説明

Codec

String

必須

ビデオのエンコード形式。 有効な値: H.264およびH.265。

削除

String

必須

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

  • true: トランスコードされたビデオファイルからビデオストリームを削除します。

  • false: トランスコードされたビデオファイルのビデオストリームを保持します。

デフォルト値:false

ビットレート

String

任意

出力ビデオファイルのビットレート。 このパラメーターを空のままにすると、ビットレートはCrfパラメーターの値に基づいて指定されます。 単位:Kbit/秒

有効な値: [10,50000] 。

Height

String

任意

出力ビデオファイルの画像の高さ。 値は2の倍数でなければなりません。 このパラメータを空のままにすると、ソースファイルの画像の高さが使用されます。 単位: ピクセル。 有効な値: [128,4096] 。

String

任意

出力ビデオファイルの画像幅。 値は2の倍数でなければなりません。 このパラメータを空のままにすると、ソースファイルの画像幅が使用されます。 単位: ピクセル。 有効な値: [128,4096] 。

FPS

String

任意

出力ビデオファイルのフレームレート。 このパラメーターを空のままにすると、ソースファイルのフレームレートが使用されます。 単位: FPS。 有効な値: (0,60) 。

ゴップ

String

任意

ピクチャグループ (GOP) のサイズ。 単位: フレーム。 有効な値: [1,100000] 。

LongShortMode

String

任意

自動回転画面を有効にするかどうかを示します。 出力ビデオファイルの画像幅は、ソースファイルの長辺またはポートレートモードのソースファイルの画像高さに対応します。 出力ビデオファイルの画像高さは、ソースファイルの短辺またはポートレートモードのソースファイルの画像幅に対応します。 有効な値:

  • true: 画面の自動回転が有効です。

  • false: 自動回転画面は無効です。

デフォルト値:true この機能は、ポートレートモードのビデオに適用できます。 この機能を有効にすることを推奨します。

Crf

String

任意

ビットレート品質制御係数。 このパラメーターを指定すると、Bitrateパラメーターは無効になります。 値が大きいほど画質が悪く、出力ビデオファイルのサイズが小さいことを示します。 値が小さいほど、出力ビデオファイルの画質が良く、サイズが大きく、トランスコード期間が長いことを示します。 有効な値: [0,51] 。

デフォルト値: 26。 このパラメーターは変更しないことを推奨します。

Profile

String

任意

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

  • baseline: モバイルデバイスに適用されます。

  • メイン: 标准定义デバイスに适用されます。

  • high: 高精细デバイスに适用されます。

デフォルト値: high。 このパラメーターは、H.264エンコードが実行されている場合にのみ有効です。

ベストプラクティス

複数の定義が存在する場合は、このパラメーターをベースラインに設定して、ローエンドのデバイスで正常に再生できるようにすることを推奨します。 他の定義では、このパラメーターをmainまたはhighに設定します。

プリセット

String

任意

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

デフォルト値: medium。 このパラメーターは、H.264エンコードが実行されている場合にのみ有効です。 このパラメーターは変更しないことを推奨します。

ScanMode

String

任意

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

  • インターレース: インターレース走査

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

バフサイズ

String

任意

バッファーサイズ。 (単位:KB) 有効な値: [1000,128000] 。

デフォルト値: 6000

Maxrate

String

任意

最大ビデオビットレート。 単位:Kbit/秒 有効な値: [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。

ビットレート

String

必須

出力オーディオファイルのビットレート。 単位:Kbit/秒 有効な値: [8,1000] 。

削除

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が含まれます。

ボリューム

ボリューム

選択可能

ボリューム。

Audioパラメーターの例

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

コンテナー: コンテナー形式

パラメーター

タイプ

必須

説明

Format

String

必須

コンテナー形式。

  • FLV、MP4、およびHLS (M3U8) は、ビデオトランスコーディングでサポートされています。

  • MP3とMP4はオーディオトランスコーディングでサポートされています。

  • このパラメーターがFLVに設定されている場合、VideoテーブルのCodecパラメーターをH.265に設定することはできません。

Containerパラメーターの例

{
        "Format":"mp4"
}

MuxConfig: HLSのセグメント構成

説明

コンテナー形式がM3U8の場合、このパラメーターを指定する必要があります。

パラメーター

タイプ

必須

説明

セグメント

セグメント

必須

セグメント構成。 値はJSONオブジェクトである必要があります。

セグメント: セグメントの構成

パラメーター

タイプ

必須

説明

有効期間

String

必須

TSセグメントの期間。 値は整数でなければなりません。 有効な値: [1,60] 。 単位は秒です。

例: {"Duration":"10"}

MuxConfigパラメーターの例

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

TransConfig: 条件付きトランスコード設定

パラメーター

タイプ

必須

説明

TransMode

String

任意

コード変換モード。 有効な値:

  • onepass (デフォルト): 平均ビットレート (ABR) モード。 このモードの符号化速度は、2パスモードの符号化速度より速い。 デフォルトでは、Alibaba Cloudはワンパスを使用します。

  • twopass: 可変ビットレート (VBR) モード。 このモードでは、エンコーダは2回実行され、ビットレートを正確に割り当てて、サイズが小さく高品質の出力ファイルを生成します。 このモードはワンパスよりも低いエンコード速度を提供し、ライブストリーミングやリアルタイム通信などの時間に敏感なシナリオでは使用できません。 入力ビデオの圧縮率が高い場合は、2パスモードを使用しないことをお勧めします。 そうでなければ、ブロッキングアーチファクトが発生し得る。

  • CBR: 一定ビットレート (CBR) モード。 このモードでは、エンコーダは一定のビットレートで動作します。 CBR圧縮ファイルは、VBR圧縮ファイルやABR圧縮ファイルよりもサイズが大きく、品質の向上はあまりありません。

デフォルト値: onepass。

IsCheckReso

String

任意

ソースファイルの解像度を確認するかどうかを示します。 次に、ApsaraVideo VODは、チェック結果に基づいて、トランスコードにソースファイルの解像度を使用するかどうかを決定します。 有効な値:

  • true: ソースファイルの解像度を確認します。 ApsaraVideo VODが、幅または高さに基づいて出力ファイルの解像度がソースファイルの解像度よりも高いと判断した場合、ソースファイルの解像度はトランスコード後も保持されます。

  • false: ソースファイルの解像度をチェックしないでください。

デフォルト値:false

IsCheckResoFail

String

任意

トランスコードの失敗についてソースファイルの解像度を確認するかどうかを示します。 有効な値:

  • true: ソースファイルの解像度を確認します。 ApsaraVideo VODが、幅または高さに基づいて出力ファイルの解像度がソースファイルの解像度よりも高いと判断した場合、トランスコードの失敗を示すエラーが返されます。

  • false: ソースファイルの解像度をチェックしないでください。

デフォルト値:false

IsCheckVideoBitrate

String

任意

ソースファイルのビデオストリームのビットレートを確認するかどうかを示します。 次に、ApsaraVideo VODは、チェック結果に基づいて、ソースファイルのビデオストリームビットレートをトランスコーディングに使用するかどうかを決定します。 有効な値:

  • true: ソースファイルのビデオストリームのビットレートをチェックします。 ApsaraVideo VODが、出力ファイルのビデオストリームのビットレートがソースファイルのビデオストリームのビットレートよりも大きいと判断した場合、ソースファイルのビデオストリームのビットレートはトランスコード後も保持されます。

  • false: ソースファイルの解像度をチェックしないでください。

デフォルト値:false

IsCheckVideoBitrateFail

String

任意

ソースファイルのビデオストリームのビットレートでトランスコードの失敗を確認するかどうかを示します。 有効な値:

  • true: ソースファイルのビデオストリームのビットレートをチェックします。 ApsaraVideo VODが、出力ファイルのビデオストリームのビットレートがソースファイルのビデオストリームのビットレートよりも大きいと判断した場合、トランスコーディングは実行されません。

  • false: ソースファイルの解像度をチェックしないでください。

デフォルト値:false IsCheckVideoBitrateパラメーターが指定されている場合、IsCheckVideoBitrateの値が優先されます。

IsCheckAudioBitrate

String

任意

ソースファイルのオーディオストリームのビットレートを確認するかどうかを示します。 次に、ApsaraVideo VODは、チェック結果に基づいて、ソースファイルのオーディオストリームのビットレートをトランスコーディングに使用するかどうかを決定します。 有効な値:

  • true: ソースファイルのオーディオストリームのビットレートを確認します。 ApsaraVideo VODが、出力ファイルのオーディオストリームのビットレートがソースファイルのオーディオストリームのビットレートよりも大きいと判断した場合、ソースファイルのオーディオストリームのビットレートはトランスコード後も保持されます。

  • false: ソースファイルの解像度をチェックしないでください。

デフォルト値:false

IsCheckAudioBitrateFail

String

任意

ソースファイルのオーディオストリームのビットレートでトランスコードの失敗を確認するかどうかを示します。 有効な値:

  • true: ソースファイルのオーディオストリームのビットレートを確認します。 ApsaraVideo VODが、出力ファイルのオーディオストリームのビットレートがソースファイルのオーディオストリームのビットレートよりも大きいと判断した場合、トランスコーディングは実行されません。

  • false: ソースファイルの解像度をチェックしないでください。

デフォルト値:false IsCheckVideoBitrateパラメーターが指定されている場合、IsCheckVideoBitrateの値が優先されます。

TransConfigパラメーターの例

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

クリップ: ビデオのトリミング設定

パラメーター

タイプ

必須

説明

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の使用を推奨します。

有効期間

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のいずれかを指定する必要があります。 Durationと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のいずれかを指定する必要があります。 DurationとEndの両方を指定すると、Endが有効になります。

  • 開始時間と終了時間との間の持続時間は、ビデオの全持続時間より大きくすることはできない。

EncryptSetting: トランスコードの暗号化設定

説明

HLS暗号化を開始するには、EncryptTypeパラメーターをAliyunVoDCencryptionに設定し、SubmitTranscodeJobs操作を呼び出します。 SubmitTranscodeJobs操作を呼び出すときに、EncryptConfigパラメーターを設定します。

パラメーター

タイプ

必須

説明

暗号化タイプ

String

必須

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

  • AliyunVoDCryption: このオプションはM3U8 (HLS) ビデオに対してのみ有効です。

  • AliyunVoDLicenseEncryption: このオプションはMP4ビデオにのみ有効です。

EncryptSettingパラメーターの例

{
        "EncryptType":"AliyunVoDEncryption"
}

PackageSetting: トランスコードのパッケージ設定

説明
  • ビデオとオーディオストリームをファイルから抽出した後は、パッケージ化できません。

  • HLSパッケージのみがサポートされています。

パラメーター

タイプ

必須

説明

PackageType

String

必須

包装タイプ。 値をHLSPackageに設定します。

PackageConfig

PackageConfig

選択可能

パッケージング構成。 ビデオストリームパッケージテンプレートをトランスコーディングに使用する場合は、このパラメーターを指定する必要があります。

SubtitleExtractConfigList

SubtitleExtractConfig []

選択可能

サブタイトルのパッケージ構成。 このパラメーターは、トランスコーディングに字幕パッケージテンプレートを使用する場合にのみ指定できます。

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

説明

このパラメーターは、PackageTypeがHLSPackageに設定されている場合にのみ設定できます。

パラメーター

タイプ

必須

説明

BandWidth

String

必須

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

このパラメーターを指定できるのは、ビデオストリームのパッケージ化テンプレートがトランスコーディングに使用されている場合のみです。

PackageSettingパラメーターの例

Sample code for configuring a video stream packaging template:
{
        "PackageType":"HLSPackage",
        "PackageConfig":{
                "BandWidth":"400000"
        }
}
                        

SubtitleExtractConfig: サブタイトルパッケージ設定

パラメーター

タイプ

必須

説明

SubtitleUrlList

String[]

必須

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

説明
  • 指定できるHTTP URLは1つだけです。

  • 字幕ファイルは、ApsaraVideo VODによって割り当てられたバケットにのみ保存できます。

言語

String

必須

en-USなどの字幕言語。 詳細については、「RFC 5646」をご参照ください。

Format

String

必須

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

名前

String

必須

中国語や英語など、プレーヤー内の字幕の表示名。

SubtitlePackageパラメーターの例

Sample code for configuring a subtitle packaging template:
 {
      "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 URLはサポートされていません。 サポートされている字幕形式: srtとass。

説明

字幕ファイルとソースビデオファイルは、中国 (上海) リージョンなど、同じリージョンの同じバケットに保存する必要があります。

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"
}

ボリューム: ボリューム設定

パラメーター

タイプ

必須

説明

方式

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

ヴォービスと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

対応

×

×

ビットレート

対応

対応

×

Crf

対応

対応

×

対応

対応

対応

Height

対応

対応

対応

FPS

対応

対応

対応

ゴップ

対応

対応

×

プリセット

対応

×

×

ScanMode

対応

対応

対応

バフサイズ

対応

対応

×

Maxrate

対応

対応

×

PixFmt

対応

対応

bgr8

TranscodeSummary: トランスコードの概要

パラメーター

タイプ

説明

VideoId

String

オーディオファイルまたはビデオファイルのID。

TranscodeTemplateGroupId

String

コード変換テンプレートグループのID。

TranscodeStatus

String

トランスコードのステータス。 有効な値:

  • 処理: トランスコーディングが進行中です。

  • 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。

String

出力ビデオの画像幅。 単位: ピクセル。

Height

String

出力ビデオの画像の高さ。 単位: ピクセル。

有効期間

String

出力ビデオの長さ。 単位は秒です。

ファイルサイズ

String

出力ビデオファイルのサイズ。 単位はバイトです。

ビットレート

String

出力ビデオの平均ビットレート。 単位:Kbit/秒

FPS

String

出力ビデオのフレームレート。 単位: フレーム /秒。

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

コード変換ジョブが失敗したときに返されるエラーコード。

エラーメッセージ

String

トランスコードジョブが失敗した場合に返されるエラーメッセージ。

TranscodeTask: トランスコードタスクに関する情報

パラメーター

タイプ

説明

TranscodeTaskId

String

コード変換タスクのID。

TranscodeTemplateGroupId

String

コード変換テンプレートグループのID。

VideoId

String

オーディオファイルまたはビデオファイルのID。

TaskStatus

String

コード変換タスクのステータス。 有効な値:

  • 処理: トランスコーディングが進行中です。

  • 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

トリガーの種類。 有効な値:

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

  • マニュアル: トランスコーディングは、SubmitTranscodeJobs操作を呼び出すことによってトリガーされます。

TranscodeJobInfoList

TranscodeJobInfo

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

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

パラメーター

タイプ

説明

TranscodeTaskId

String

コード変換タスクのID。

TranscodeJobId

String

コード変換ジョブのID。

VideoId

String

オーディオファイルまたはビデオファイルのID。

TranscodeProgress

Long

コード変換ジョブの進行状況。 有効な値: [0,100] 。

TranscodeJobStatus

String

コード変換ジョブのステータス。 有効な値:

  • Transcoding: トランスコードジョブが実行中です。

  • TranscodeSuccess: トランスコードジョブが成功しました。

  • TranscodeFail: トランスコードジョブが失敗しました。

優先度

String

コード変換タスクの優先度。

定義

String

定義。

説明

このパラメーターは、トランスコードテンプレートで設定された定義を示し、出力ビデオの実際の解像度を示すものではありません。

TranscodeTemplateId

String

コード変換テンプレートのID。

CreationTime

String

コード変換ジョブが作成された時刻。

CompleteTime

String

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

InputFileUrl

String

ソースファイルのOSS URL。

OutputFile

OutputFile

出力ファイルに関する情報。

ErrorCode

String

コード変換ジョブが失敗したときに返されるエラーコード。

エラーメッセージ

String

トランスコードジョブが失敗した場合に返されるエラーメッセージ。

OutputFile: トランスコード後の出力ファイルに関する情報

パラメーター

タイプ

説明

OutputFileUrl

String

出力ファイルのOSS URL。

Format

String

出力ファイルのコンテナー形式。

String

出力ファイルのイメージの幅。 単位: ピクセル。

Height

String

出力ファイルのイメージの高さ。 単位: ピクセル。

有効期間

String

出力ファイルの長さ。 単位は秒です。

ビットレート

String

出力ファイルの平均ビットレート。 単位:Kbit/秒

FPS

String

出力ファイルのフレームレート。 単位: フレーム /秒。

ファイルサイズ

Long

出力ファイルのサイズ。 単位はバイトです。

暗号化タイプ

String

出力ファイルに使用される暗号化タイプ。 値はJSON文字列です。

WatermarkIdList

String

出力ファイルに適用される透かしのID。

VideoStreamList

String

ビデオストリーム。 詳細については、「VideoStream: ビデオストリームに関する情報」をご参照ください。

AudioStreamList

String

オーディオストリーム。 詳細については、「AudioStream: オーディオストリームに関する情報」をご参照ください。

データ統計

TopPlayVideoStatis: トップビデオの1つの毎日の再生統計

パラメーター

タイプ

説明

VideoId

String

オーディオファイルまたはビデオファイルのID。

PlayDuration

String

ビデオの再生時間。 単位:ミリ秒。

タイトル

String

ビデオのタイトル。

VV

String

ビデオビューの数。

UV

String

ユニークな訪問者の数。

VideoPlayStatisticDetail: 特定のビデオの毎日の再生統計

パラメーター

タイプ

説明

日付

String

yyyyMMdd形式の日付。

例: 20170120。

PlayDuration

String

ビデオの再生時間。 単位:ミリ秒。

タイトル

String

ビデオのタイトル。

VV

String

ビデオビューの数。

UV

String

ユニークな訪問者の数。

PlayRange

String

再生時間の分布。

UserPlayStatistTotals: 1日あたりの再生回数の合計に関する統計

パラメーター

タイプ

説明

日付

String

yyyyMMdd形式の日付。

例: 20170120。

PlayDuration

String

ビデオの再生時間。 単位:ミリ秒。

PlayRange

String

再生時間の分布。

VV

VV

ビデオビューの総数。

UV

UV

ユニークな訪問者の総数。

UserPlayStatistaAvgs: 1日あたりの平均再生に関する統計

パラメーター

タイプ

説明

日付

String

yyyyMMdd形式の日付。

例: 20170120。

AvgPlayDuration

String

ビデオの平均再生時間。 単位:ミリ秒。

AvgPlayCount

String

ビデオビューの平均数。

VV: ビデオビューの数

ApsaraVideo Player SDKを使用するビデオ再生に関する統計のみがサポートされています。

パラメーター

タイプ

説明

Android

String

ApsaraVideo Player SDK for Androidを使用して再生されたビデオに対して収集されたビデオビューの総数。

iOS

String

ApsaraVideo Player SDK for iOSを使用して再生されたビデオに対して収集されたビデオビューの総数。

フラッシュ

String

ApsaraVideo Player SDK for Flashを使用して再生されたビデオに対して収集されたビデオビューの総数。

HTML5

String

ApsaraVideo Player SDK for HTML5を使用して再生されたビデオに対して収集されたビデオビューの総数。

UV: ユニークな訪問者の数

ApsaraVideo Player SDKを使用するビデオ再生に関する統計のみがサポートされています。

パラメーター

タイプ

説明

Android

String

ApsaraVideo Player SDK for Androidを使用するユニークビジターの総数。

iOS

String

ApsaraVideo Player SDK for iOSを使用するユニークビジターの総数。

フラッシュ

String

ApsaraVideo Player SDK for Flashを使用するユニークビジターの総数。

HTML5

String

HTML5用のApsaraVideo Player SDKを使用するユニークビジターの総数。

イベント通知

MessageCallback: イベント通知の設定

パラメーター

タイプ

説明

CallbackType

String

コールバックメソッド。 有効な値: HTTPおよびMNS。

CallbackURL

String

コールバックURL。 このパラメーターは、HTTPコールバックに対してのみ返されます。

MnsEndpoint

String

Message Service (MNS) のパブリックエンドポイント。 このパラメーターは、MNSコールバックに対してのみ返されます。

MnsQueueName

String

MNSキューの名前。 このパラメーターは、MNSコールバックに対してのみ返されます。

EventTypeList

String

コールバックイベントの型。

AuthSwitch

String

コールバック認証が有効かどうかを示します。 このパラメーターは、HTTPコールバックに対してのみ返されます。 有効な値:

  • on: コールバック認証が有効です。

  • off

AuthKey

String

暗号化キー。 このパラメーターは、HTTPコールバックに対してのみ返されます。

マルチアプリケーションサービス

AppInfo: アプリケーションに関する情報

パラメーター

タイプ

説明

AppId

String

アプリケーションの ID

AppName

String

アプリケーションの名前。

説明

String

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

タイプ

String

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

  • System

  • Custom

Status

String

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

  • 正常: アプリケーションは正常です。

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

CreationTime

String

アプリケーションが作成された時刻。 時刻は UTC で表示されます。

ModificationTime

String

アプリケーションが最後に変更された時刻。 時刻は UTC で表示されます。

AppPolicy: アプリケーションポリシーに関する情報

パラメーター

タイプ

説明

AppId

String

アプリケーションの ID

PolicyType

String

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

  • System

  • Custom

PolicyName

String

ポリシー名です。

CreationTime

String

ポリシーが作成された時刻です。 時刻は UTC で表示されます。

説明

String

ルールの説明。