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

:Basic structures

最終更新日:Jul 12, 2022

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

ビデオ: ビデオに関する情報

パラメーター

データ型

説明

VideoId

String

ビデオのID。

タイトル

String

ビデオのタイトル。

説明

String

ビデオの説明。

有効期間

Float

ビデオの長さ。 (単位:秒)

CoverURL

String

ビデオサムネイルのURL。

ステータス

String

ビデオのステータス。

CreationTime

String

ビデオが作成された時刻。 時刻は UTC 表示です。

Size

Long

メザニンビデオファイルのサイズ。 単位: バイト。

スナップショット

String[]

ビデオスナップショットのURL。 値は配列です。

CateId

Long

ビデオのカテゴリID。

CateName

String

ビデオのカテゴリ名。

タグ

String

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

TemplateGroupId

String

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

StorageLocation

String

ビデオファイルが保存されているObject Storage Service (OSS) バケットのURL。

AppId

String

アプリケーションの ID を示します。

VideoBase: ビデオに関する基本情報

パラメーター

データ型

説明

VideoId

String

ビデオのID。

タイトル

String

ビデオのタイトル。

有効期間

String

ビデオの長さ。 (単位:秒)

CoverURL

String

ビデオサムネイルのURL。

ステータス

String

ビデオのステータス。

CreationTime

String

The time when the video was created. 時刻は UTC 表示です。

MediaType

MediaType

メディアアセットのタイプ。 設定可能な値は以下のとおりです。

  • ビデオ: video

  • audio: オーディオのみ

説明

デフォルトでは、GetPlayInfo操作はコンテンツ配信ネットワーク (CDN) URLを返します。 ドメイン名が指定されていない場合、GetPlayInfo操作はOSS URLを返します。 この場合、のURLのみ。mp4ビデオファイルは再生に使用できます。

Media: the information about a media asset

パラメーター

データ型

説明

MediaId

String

メディアアセットのID。

CreationTime

String

The time when the media asset was created. 時刻は UTC 表示です。

MediaType

String

メディアアセットのタイプ。 設定可能な値は以下のとおりです。

  • ビデオ: video

  • audio: オーディオのみ

  • 画像: 画像

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

ビデオ

ビデオ

ビデオに関する情報。

Audio

Audio

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

イメージ

画像

イメージに関する情報。

AttachedMedia

AttachedMedia

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

PlayInfo: the playback information about a video stream

パラメーター

データ型

説明

ビットレート

String

The bitrate of the video stream. 単位:Kbit/s

定義

String

ビデオストリームの定義。 設定可能な値は以下のとおりです。

  • FD: 低い定義

  • LD: standard definition

  • SD: high definition

  • HD: 超高い定义

  • OD: 元の質

  • 2K: 2K解像度

  • 4K: 4K解像度

仕様

String

トランスコードされたオーディオまたはビデオストリームの出力仕様。 For more information about this parameter, see the "Specification" section of the Parameters for media assets topic.

有効期間

String

ビデオストリームの長さ。 (単位:秒)

Encrypt

Long

ビデオストリームが暗号化されているかどうかを示します。 設定可能な値は以下のとおりです。

  • 0: 暗号化されない

  • 1: 暗号化

暗号化タイプ

String

ビデオストリームに対して実行された暗号化のタイプ。 設定可能な値は以下のとおりです。

  • AliyunVoDCryption: Alibaba Cloud独自の暗号化

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

PlayURL

String

ビデオストリームのストリーミングURL。

形式

String

ビデオストリームの形式。

メディアアセットがビデオファイルの場合、次の有効な値が含まれます。

  • mp4

  • m3u8

メディアアセットがオーディオのみのファイルの場合、値はmp3です。

FPS

String

ビデオストリームのフレームレート。 単位: フレーム /秒。

Size

Long

ビデオのサイズ。 単位: バイト。

Long

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

Height

Long

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

StreamType

String

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

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

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

JobId

String

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

WatermarkId

String

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

ステータス

String

The status of the video stream. 設定可能な値は以下のとおりです。

  • Normal: ビデオストリームを再生できます。

  • Invisible: ビデオストリームがブロックされています。

NarrowBandType

String

Narrowband HDのタイプ™. 設定可能な値は以下のとおりです。

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

  • 1.0: Narrowband HD™1.0

  • 2.0: Narrowband HD™2.0

このパラメータは、組み込みのNarrowband HDの定義が™1.0コード変換テンプレートを指定します。 詳細については、「TranscodeTemplate: トランスコードテンプレートの設定」をご参照ください。

CreationTime

String

The time when the media stream was created. 時刻は UTC 表示です。

ModificationTime

String

The time when the media stream was last updated. 時刻は UTC 表示です。

VideoMeta: ビデオのメタデータ

パラメーター

データ型

説明

VideoId

String

ビデオのID。

タイトル

String

ビデオのタイトル。

有効期間

Float

ビデオの長さ。 (単位:秒)

CoverURL

String

ビデオサムネイルのURL。

ステータス

String

ビデオのステータス。

ステータス: ビデオのステータス

利点

説明

補足

アップロード

ビデオはアップロード中です。

This is the initial status of a video. ビデオがアップロードされていることを示します。

アップロード失敗

ビデオのアップロードに失敗しました。

ビデオは再開可能モードでアップロードされ、ApsaraVideo VODは再開可能アップロードが失敗したかどうかを判断できないため、この値は一時的に使用されません。

UploadSucc

ビデオがアップロードされます。

N/A

トランスコード

ビデオはトランスコードされています。

N/A

トランスコード失敗

ビデオのトランスコードに失敗しました。

トランスコードの失敗は、通常、メザニンビデオファイルのエラーが原因です。 トランスコードの失敗をトラブルシューティングするには、TranscodeCompleteイベント通知からエラーメッセージを取得します。 詳細については、「TranscodeComplete」をご参照ください。 質問がある場合は、 チケット

チェック中

ビデオはレビュー中です。

ビデオを公開する前にレビューすることを指定するには、ApsaraVideo VODコンソールにログインします。 左側のナビゲーションウィンドウで、[レビュー] > [設定] を選択します。 [Process] パラメーターを [Review Before Publish] に設定します。 ビデオがトランスコードされると、ビデオのステータスが [レビュー中] に変わります。 この場合、ビデオはApsaraVideo VODコンソールでのみ再生できます。

ブロックされました

ビデオがブロックされています。

レビュー中のビデオがブロックされています。

通常

ビデオを再生できます。

この状態のビデオを再生できます。

ProduceFail

ビデオの制作に失敗しました。

N/A

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

利点

説明

補足

アップロード

The image is being uploaded.

これが画像の初期状態である。 画像がアップロードされていることを示します。

通常

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

この状態の画像がアップロードされます。

アップロード失敗

画像のアップロードに失敗しました。

この状態の画像はアップロードに失敗します。

Category: the information about a media asset category

パラメーター

データ型

説明

CateId

Long

ビデオのカテゴリID。

CateName

String

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

ParentId

Long

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

Level

Long

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

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

パラメーター

データ型

説明

VideoId

String

ビデオのID。

FileName

String

メザニンファイルの名前。

有効期間

String

メザニンファイルの長さ。 (単位:秒)

ステータス

String

メザニンファイルのステータス。

CreationTime

String

メザニンファイルが作成された時刻。 時刻は UTC 表示です。

Height

Long

メザニンファイルの高さ。 単位: ピクセル

Long

メザニンファイルの幅。 単位: ピクセル

FPS

String

メザニンファイルのフレームレート。 単位: フレーム /秒。

FileURL

String

メザニンファイルのURL。

ビットレート

String

メザニンファイルのビットレート。 単位:Kbit/s

Size

Long

メザニンファイルのサイズ。 単位: バイト。

OutputType

String

出力ファイルのストリーミングURLのタイプ。 設定可能な値は以下のとおりです。

  • oss: OSS URL

  • cdn: CDN URL

VideoStreamList

VideoStream []

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

AudioStreamList

AudioStream []

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

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

パラメーター

データ型

説明

Index

String

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

CodecName

String

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

CodecLongName

String

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

プロファイル

String

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

CodecTimeBase

String

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

CodecTagString

String

The tag string of the encoding format.

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: the information about an audio stream

パラメーター

データ型

説明

Index

String

The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.

CodecName

String

The short name of the encoding format.

CodecLongName

String

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

CodecTimeBase

String

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

CodecTagString

String

The tag string of the encoding format.

CodecTag

String

エンコード形式のタグ。

SampleFmt

String

サンプリング形式。

サンプルレート

String

The sample rate.

Channels

String

サウンドチャンネルの数。

ChannelLayout

String

サウンドチャンネルの出力レイアウト。

タイムベース

String

タイムベース。

StartTime

String

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

有効期間

String

オーディオ再生の持続時間。

ビットレート

String

ビットレート。

NumFrames

String

フレームの総数。

Lang

String

言語。

ステータス: メザニンファイルのステータス

利点

説明

補足

アップロード

メザニンファイルはアップロード中です。

This is the initial status of a mezzanine file. ファイルがアップロード中であることを示します。

通常

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

この状態のメザニンファイルがアップロードされます。

アップロード失敗

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

この状態のメザニンファイルのアップロードに失敗します。

削除済み

メザニンファイルが削除されます。

この状態のメザニンファイルは削除されます。

LiveRecordVideo: ライブストリームから作成されたVODファイルに関する情報

パラメーター

データ型

説明

StreamName

String

ライブストリームの名前。

DomainName

String

ライブストリームのドメイン名。

AppName

String

The name of the application.

PlaylistId

String

The ID of the playlist.

RecordStartTime

String

録音の開始時間。

RecordEndTime

String

The end time of the recording.

ビデオ

ビデオ

ビデオに関する情報。

TopPlayVideoStatis: the daily playback statistics on one of the top videos

パラメーター

データ型

説明

VideoId

String

ビデオのID。

PlayDuration

String

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

タイトル

String

ビデオのタイトル。

VV

String

ビデオビューの数。

UV

String

ユニークな訪問者の数。

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

パラメーター

データ型

説明

日付

String

yyyyMMdd形式の日付。

例: 20170120。

PlayDuration

String

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

タイトル

String

ビデオのタイトル。

VV

String

The number of video views.

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を使用するユニークビジターの総数。

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 (UTC + 8) を示します。

ModifiedTime

String

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

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

ステータス

String

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

説明

String

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

タイムライン

String

JSON形式のオンライン編集プロジェクトのタイムライン。

有効期間

String

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

CoverURL

String

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

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

パラメーター

データ型

説明

Id

String

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

タイトル

String

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

CreationTime

String

タイムラインが作成された時刻。

ModifiedTime

String

タイムラインが最後に変更された時刻。

有効期間

Float

タイムラインの合計期間。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

CurrentRuler

Float

タイムラインの現在のルーラー。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

CurrentPosition

Float

オンライン編集プロジェクトの再生ヘッドの現在の位置。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

VideoTracks

VideoTrack []

ビデオトラック。

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

パラメーター

データ型

説明

Count

Int

ビデオトラッククリップの総数。

有効期間

String

ビデオトラックの長さ。

VideoTrackClips

VideoTrackClip []

ビデオトラックのクリップ。

VideoTrackClip: ビデオトラッククリップに関する情報

パラメーター

データ型

説明

Id

String

ビデオトラッククリップのID。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

タイムラインを使用してデータを編集する場合は、このパラメーターをタイムライン内で一意の値に設定する必要があります。

VideoId

String

ビデオトラッククリップのビデオID。

データ型

String

ビデオトラッククリップのタイプ。 設定可能な値は以下のとおりです。

  • ビデオ: ビデオ

  • 画像: 画像

デフォルト値: Video。

タイトル

String

ビデオトラッククリップのタイトル。 タイトルはビデオのタイトルと同じでなければなりません。

Index

Int

タイムライン内のビデオトラッククリップのシーケンス番号。 シーケンス番号はゼロから始まります。

CutFlag

Boolean

ビデオトラッククリップをトリミングするかどうかを指定します。 有効な値は、true および false です。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

TextFlag

Boolean

バナーテキストをビデオトラッククリップに追加するかどうかを指定します。 有効な値は、true および false です。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

DeWatermarkFlag

Boolean

ビデオトラッククリップの一部をマスクするかどうかを指定します。 有効な値は、true および false です。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

URL

String

ビデオトラッククリップの編集に使用されるストリームのストリーミングURL。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

CoverURL

String

ビデオトラッククリップのサムネイルURL。 デフォルトでは、このサムネイルURLはビデオのものと同じです。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

SpriteURL

String

ビデオトラッククリップのスプライトスナップショットURL。 複数のURLはコンマ (,) で区切ります。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

Int

ビデオトラッククリップの編集に使用されるストリームの幅。 単位: ピクセル

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されず、バナーテキストやマスキングなどの効果が追加されていない場合、このパラメーターを設定する必要はありません。

Height

Int

ビデオトラッククリップの編集に使用されるストリームの高さ。 単位: ピクセル

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されず、バナーテキストやマスキングなどの効果が追加されていない場合、このパラメーターを設定する必要はありません。

FPS

Float

ビデオトラッククリップのフレームレート。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

ビットレート

Float

ビデオトラッククリップの編集に使用されるストリームのビットレート。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

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

Float

ビデオ内のビデオトラッククリップの開始時刻。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

アウト

Float

ビデオ内のビデオトラッククリップの終了時間。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

有効期間

Float

ビデオトラッククリップのデュレーション。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

VirginDuration

Float

ビデオトラッククリップが属するビデオの合計期間。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

タイムラインがビデオ制作にのみ使用され、編集中のデータストレージには使用されない場合、このパラメーターを設定する必要はありません。

TimelineIn

Float

タイムラインでのビデオトラッククリップの開始時刻。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

TimelineOut

Float

タイムラインでのビデオトラッククリップの終了時刻。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

効果

効果 []

ビデオトラッククリップに追加されるエフェクト。

効果: 効果に関する情報

パラメーター

データ型

説明

データ型

String

エフェクトのタイプ。 設定可能な値は以下のとおりです。

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

  • DeWatermark: ビデオトラッククリップの特定の部分をマスクします。

パラメーター名

String

エフェクトの名前。

サブタイプ

String

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

TypeパラメーターがDeWatermarkに設定されている場合、このパラメーターをDelogo_Blurに設定します。

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

Float

ビデオトラッククリップに追加するエフェクトの開始時刻。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

アウト

Float

ビデオトラッククリップに追加するエフェクトの終了時刻。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

TimelineIn

Float

タイムラインでのエフェクトの開始時刻。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

TimelineOut

Float

タイムラインでのエフェクトの終了時刻。 (単位:秒) 小数点以下4桁まで正確な値を指定します。

X

String

エフェクトのX座標。 座標原点は、ビデオ画像の左上隅である。 値は整数または10進数にすることができます。

  • 値が整数の場合、値は8から4096の範囲でピクセル値を示し、単位はピクセルです。

  • 値が10進数の場合、値は0〜1の範囲であり、出力ビデオ画像の解像度におけるピクセル値とピクセル単位の幅の比を示します。 10進数は、0.9999など、小数点第4位まで正確にすることができます。 余分な数字は自動的に削除されます。

Y

String

エフェクトのY座標。 座標原点は、ビデオ画像の左上隅である。 値は整数または10進数にすることができます。

  • 値が整数の場合、値は8から4096の範囲でピクセル値を示し、単位はピクセルです。

  • 値が10進数の場合、値は0〜1の範囲であり、出力ビデオ画像の解像度におけるピクセル値とピクセル単位の幅の比を示します。 10進数は、0.9999など、小数点第4位まで正確にすることができます。 余分な数字は自動的に削除されます。

Int

エフェクトを追加する领域の幅。 値は整数または10進数にすることができます。

  • 値が整数の場合、値は8から4096の範囲でピクセル値を示し、単位はピクセルです。

  • 値が10進数の場合、値は0〜1の範囲であり、出力ビデオ画像の解像度におけるピクセル値とピクセル単位の幅の比を示します。 10進数は、0.9999など、小数点第4位まで正確にすることができます。 余分な数字は自動的に削除されます。

Height

Int

エフェクトを追加するエリアの高さ。 値は整数または10進数にすることができます。

  • 値が整数の場合、値は8から4096の範囲でピクセル値を示し、単位はピクセルです。

  • 値が10進数の場合、値は0〜1の範囲であり、出力ビデオ画像の解像度におけるピクセル値とピクセル単位の幅の比を示します。 10進数は、0.9999など、小数点第4位まで正確にすることができます。 余分な数字は自動的に削除されます。

FEWidth

Float

編集中のビデオ画像の表示幅。 単位: ピクセル

FEHeight

Float

編集中に表示されるビデオ画像の高さ。 単位: ピクセル

フォント

String

フォント。 値をSimSunに設定します。

フォントフェイス

FontFace

フォントの外観。

FontColor

String

フォントの色 (16進形式) 。 値は番号記号 (#) で始まる必要があります。 例: #ffffff.

FontSize

Int

フォントのサイズ。

FontColorOpacity

Float

フォントの透明度。 有効な値は 0~1 です。 値1は、フォントが透明でないことを示します。 値0は、フォントが完全に透明であることを示します。

Content

String

バナーテキストの内容。

FontFace: フォントスタイル

パラメーター

データ型

説明

太さ

Boolean

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

イタリック

Boolean

フォントがイタリックかどうかを指定します。

下線

Boolean

フォントに下線を付けるかどうかを指定します。

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

パラメーター

データ型

説明

タイトル

String

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

説明

String

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

CoverURL

String

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

CateId

String

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

タグ

String

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

ProduceConfig: ビデオ制作の構成

パラメーター

データ型

説明

TemplateGroupId

String

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

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

TemplateId

String

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

ビデオファイルが生成される場合、符号化フォーマットはH.264であり、コンテナフォーマットはMP4である。

アニメーションステッカーの作成、インテリジェントな字幕制作の実装、M3U8プレイリストに基づくビデオの編集、カスタム制作パラメータの使用など、ビジネス要件を満たすようにこのパラメータを設定する場合は、 指定されたテンプレートを申請するticket

Integer

生成されたビデオの出力解像度の幅。 単位: ピクセル

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

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

Height

Integer

生成されたビデオの出力解像度の高さ。 単位: ピクセル

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

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

StorageLocation

String

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

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

説明

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

パラメーター

データ型

説明

MaterialId

String

マテリアルのID。

タイトル

String

素材のタイトル。

説明

String

材料の説明。

有効期間

Float

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

CoverURL

String

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

ステータス

String

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

CreationTime

String

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

Size

Long

メザニンファイルのサイズ。 単位: バイト。

CateId

Long

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

CateName

String

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

タグ

String

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

スナップショット

String[]

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

スプライト

String[]

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

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

利点

説明

補足

通常

オンライン編集プロジェクトは編集中です。

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

制作

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

N/A

生産

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

N/A

ProduceFaile

ビデオ制作は失敗します。

N/A

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

パラメーター

データ型

説明

JobId

String

ジョブの ID です。

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

パラメーター

データ型

説明

JobId

String

ジョブの ID です。

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

パラメーター

データ型

説明

JobId

String

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

CreationTime

String

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

Total

Long

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

レギュラー

String

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

スナップショット

スナップショット []

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

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

パラメーター

データ型

説明

Index

String

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

Url

String

スナップショットのURL。

WatermarkInfo: 透かしに関する情報

パラメーター

データ型

必須/任意

説明

CreationTime

String

必須

ウォーターマークが作成された時刻。

パラメーター名

String

必須

透かしの名前です。

IsDefault

String

必須

透かしがデフォルトかどうかを示します。 設定可能な値は以下のとおりです。

  • デフォルト: 透かしはデフォルトのものです。

  • NotDefault: 透かしはデフォルトではありません。

データ型

String

必須

透かしのタイプ。 設定可能な値は以下のとおりです。

  • 画像: 画像

  • テキスト: テキスト

WatermarkId

String

必須

透かしのID。

FileUrl

String

任意

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

WatermarkConfig

WatermarkConfig

必須

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

VodTemplateInfo: テンプレートに関する情報

パラメーター

データ型

説明

パラメーター名

String

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

VodTemplateId

String

テンプレートのID。

TemplateType

String

テンプレートのタイプ。 設定可能な値は以下のとおりです。

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

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

IsDefault

String

テンプレートがデフォルトであるかどうかを示します。 設定可能な値は以下のとおりです。

  • デフォルト: テンプレートはデフォルトです。

  • NotDefault: テンプレートはデフォルトではありません。

TemplateConfig

JSON

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

CreationTime

String

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

ModifyTime

String

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

DynamicImageTemplateConfig: アニメーションステッカーテンプレートの設定

パラメーター

データ型

説明

パラメーター名

String

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

ビデオ

ビデオ

アニメーションステッカーの画像構成。

コンテナー

コンテナ

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

クリップ

クリップ

ビデオをトリミングしてアニメーションステッカーを生成するために使用される設定。

SetDefaultCover

String

アニメーションステッカーをサムネイルとして使用するかどうかを示します。 設定可能な値は以下のとおりです。

  • true: アニメーションステッカーがサムネイルとして使用されます。

  • false: アニメーションステッカーはサムネイルとして使用されません。

ビデオ: アニメーションステッカーの画像構成

パラメーター

データ型

必須/任意

説明

String

必須

アニメーションステッカーの幅。 有効な値: [128,4096] 。

Height

String

必須

アニメーションステッカーの高さ。 有効な値: [128,4096] 。

FPS

String

必須

アニメーションステッカーのフレームレート。 有効な値: (0,60)

コンテナ: アニメーションステッカーの形式

パラメーター

データ型

必須/任意

説明

形式

String

必須

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

クリップ: ビデオをトリミングしてアニメーションステッカーを生成するために使用される設定

パラメーター

データ型

必須/任意

説明

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

有効期間

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

完了

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

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」セクションをご参照ください。

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

コンテナー

コンテナ

必須

オーディオおよびビデオストリームのカプセル化に使用されるコンテナーの形式。 値は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パラメーターの例

{
        "タイプ":"VideoPackage" 、
        "ビデオ":{
                "コーデック":"H.264" 、
                "ビットレート":"900" 、
                "幅":"960" 、
                "Remove":"false" 、
                "Fps":"30"
        },
        "オーディオ":{
                "コーデック":"AAC" 、
                "ビットレート":"128" 、
                "Samplerate":"44100"
        },
        "コンテナ":{
                "フォーマット":"m3u8"
        },
        "MuxConfig":{
                "セグメント":{
                        "期間":"6"
                }
        },
        "EncryptSetting":{
                "EncryptType":"AliyunVoDEncryption"
        },
        "PackageSetting":{
                "PackageType":"HLSPackage"
                "PackageConfig":{
                        "BandWidth":"900000"
                }
        },
       "SubtitleUrl": "http://outin-40564284ef058b2163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8edde0e-cn.ass" 、
        "CharEncode": "UTF-8" 、
        "WatermarkIds":["USER_DEFAULT_WATERMARK" 、"ddddddddddd"] 、
        "定義":"SD" 、
        "TemplateName":"test"
}
                        

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

説明
  • 特に必要な場合を除き、Codec、Bitrate、Height、およびWidthパラメーターを設定し、Removeパラメーターをfalseに設定するだけで済みます。

  • 出力ビデオファイルには、幅パラメーターと高さパラメーターのいずれかのみを設定することをお勧めします。 これにより、出力ビデオファイルのアスペクト比がメザニンファイルのアスペクト比と同じになります。

パラメーター

データ型

必須/任意

説明

Codec

String

必須

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

削除

String

必須

ビデオストリームを削除するかどうかを指定します。 設定可能な値は以下のとおりです。

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

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

規定値: false

ビットレート

String

任意

出力ビデオファイルのビットレート。 このパラメーターを設定しない場合、ビットレートはCrfパラメーターの値に基づいて指定されます。 単位:Kbit/s 有効な値: [10,50000] 。

Height

String

任意

出力ビデオファイルの画像の高さ。 値は2の倍数でなければなりません。 このパラメーターを設定しない場合、メザニンファイルの画像の高さが使用されます。 単位: ピクセル 有効な値: [128,4096] 。

String

任意

出力ビデオファイルの画像幅。 値は2の倍数でなければなりません。 このパラメーターを設定しない場合、メザニンファイルの画像幅が使用されます。 単位: ピクセル 有効な値: [128,4096] 。

FPS

String

任意

出力ビデオファイルのフレームレート。 このパラメーターを設定しない場合、メザニンファイルのフレームレートが使用されます。 単位: フレーム /秒。 有効な値: (0,60) 。

ゴップ

String

任意

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

LongShortMode

String

任意

画面の自動回転を有効にするかどうか、つまり長辺-短辺モードを指定します。 出力ビデオファイルの画像幅は、メザニンファイルの長辺またはポートレートモードのメザニンファイルの画像高さに対応します。 出力ビデオファイルの画像高さは、メザニンファイルの短辺またはポートレートモードのメザニンファイルの画像幅に対応します。 設定可能な値は以下のとおりです。

  • true: 自動回転画面を有効にします。

  • false: 自動回転画面を無効にします。

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

Crf

String

任意

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

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

プロファイル

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/s 有効な値: [1000,50000] 。

PixFmt

String

任意

ビデオカラー符号化のためのピクセルフォーマット。 有効値: yuv420pやyuvj420pなどの標準ピクセル形式。

デフォルト値: yuv420pまたは元のカラー形式。

Videoパラメータの例

{
        "コーデック":"H.264" 、
        "ビットレート":"128" 、
        "Remove":"false" 、
        "幅":"640" 、
        "Fps":"30"
} 

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

説明

特に必要な場合を除き、CodecパラメーターとBitrateパラメーターを設定し、Removeパラメーターをfalseに設定するだけです。

パラメーター

データ型

必須/任意

説明

Codec

String

必須

オーディオファイルのエンコード形式。 有効な値: AACおよびMP3。

ビットレート

String

必須

出力オーディオファイルのビットレート。 単位:Kbit/s 有効な値: [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にのみ設定できます。

プロファイル

String

任意

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

Volume

ボリューム

任意

ボリューム。

Audioパラメーターの例

{
        "コーデック":"AAC" 、
        "ビットレート":"128" 、
        "Remove":"false" 、
        "Samplerate":"44100"
} 

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

パラメーター

データ型

必須/任意

説明

形式

String

必須

コンテナー形式。

  • ビデオトランスコーディングの場合、このパラメーターはflv、mp4、またはHLS (m3u8およびts) に設定できます。

  • オーディオトランスコーディングの場合、このパラメータはmp3またはmp4に設定できます。

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

Containerパラメーターの例

{
        "フォーマット":"mp4"
} 

MuxConfig: HLSのセグメント構成

説明

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

パラメーター

データ型

必須/任意

説明

セグメント

セグメント

必須

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

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

パラメーター

データ型

必須/任意

説明

有効期間

String

必須

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

例: {"Duration":"10"}

MuxConfigパラメーターの例

{
        "セグメント":{
                "期間":"10"
        }
}

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

パラメーター

データ型

必須/任意

説明

TransMode

String

任意

コード変換モード。 有効な値: onepass、twopass、CBR。 デフォルト値: 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パラメーターよりも優先度が高くなります。

IsCheckAudioBitrate

String

任意

メザニンファイルのオーディオストリームのビットレートを確認するかどうかを指定します。 次に、ApsaraVideo VODは、チェック結果に基づいて、メザニンファイルのオーディオストリームのビットレートをトランスコードに使用するかどうかを決定します。 設定可能な値は以下のとおりです。

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

  • false: メザニンファイルのオーディオストリームのビットレートをチェックしないでください。

規定値: false

IsCheckAudioBitrateFail

String

任意

メザニンファイルのオーディオストリームのビットレートでトランスコードの失敗を確認するかどうかを指定します。 設定可能な値は以下のとおりです。

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

  • false: メザニンファイルのオーディオストリームのビットレートをチェックしないでください。

規定値: false このパラメーターは、IsCheckAudioBitrateパラメーターよりも優先度が高くなります。

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

完了

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パラメーターは無効です。

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

説明

注: DurationパラメーターとEndパラメーターのいずれかのみを設定します。

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

説明

EncryptTypeパラメーターをAliyunVoDCryptionに設定し、SubmitTranscodeJobs操作を呼び出してHLS暗号化を開始する必要があります。

パラメーター

データ型

必須/任意

説明

暗号化タイプ

String

必須

暗号化タイプ。 値をAliyunVoDEcryptionに設定します。 このパラメーターは、M3U8 (HLS) 形式に対してのみ有効です。

EncryptSettingパラメーターの例

{
        "EncryptType":"AliyunVoDEncryption"
} 

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

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

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

パラメーター

データ型

必須/任意

説明

PackageType

String

必須

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

PackageConfig

PackageConfig

任意

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

SubtitleExtractConfigList

SubtitleExtractConfig[]

任意

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

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

説明

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

パラメーター

データ型

必須/任意

説明

BandWidth

String

必須

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

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

PackageSettingパラメーターの例

ビデオストリームパッケージテンプレートを設定するためのサンプルコード:
{
        "PackageType":"HLSPackage" 、
        "PackageConfig":{
                "BandWidth":"400000"
        }
}
                        

SubtitleExtractConfig: 字幕パッケージ設定

パラメーター

データ型

必須/任意

説明

SubtitleUrlList

String[]

必須

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

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

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

Language

String

必須

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

形式

String

必須

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

パラメーター名

String

必須

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

SubtitlePackageパラメーターの例

字幕パッケージテンプレートを設定するためのサンプルコード:
 {
      "PackageType": "HLSPackage" 、
      "SubtitleExtractConfigList": [
        {
          "SubtitleUrlList": [
            「http://outin-4051403e7.oss-cn-shanghai.aliyuncs.com/subtitles/4bff3675-79a5-40fa-8c86-1f98169d69ca-eng.vtt」
          ],
          "言语": "en-US" 、
          "フォーマット": "vtt" 、
          "名前": "英語"
        },
        {
          "SubtitleUrlList": [
            「http://outin-4051403e7.oss-cn-shanghai.aliyuncs.com/subtitles/a3f50b08-11c3-4511-94cf-7fd4f7a5e87e-jpn.vtt」
          ],
          "言语": "ja" 、
          "フォーマット": "vtt" 、
          "名前": "日本語"
        },
        {
          "SubtitleUrlList": [
            「http://outin-4051403e7.oss-cn-shanghai.aliyuncs.com/subtitles/4dba87c2-a787-42cd-8328-2369aeb8bff3-cn.vtt」
          ],
          "Language": "cn" 、
          "フォーマット": "vtt" 、
          "名前": "中国語"
        }
      ]
    }

SubtitleConfig: 字幕設定

パラメーター

データ型

必須/任意

説明

SubtitleUrl

String

必須

字幕ファイルのOSS URL。 HTTPS URLとCDN URLはサポートされていません。 サポートされている字幕形式: srtとass。

説明

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

CharEnc

String

必須

字幕ファイルのエンコード形式。 設定可能な値は以下のとおりです。

  • auto: システムはエンコード形式を自動的に識別します。

  • UTF-8

  • GBK

  • BIG5

デフォルト値は UTF-8 です。

説明

字幕ファイルをアップロードする方法の詳細については、「CreateUploadAttachedMedia」および「OSSオブジェクトのアップロード」をご参照ください。

SubtitleConfigパラメーターの例

{
        "SubtitleUrl": "http://outin-40564284ef058b2d300163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8edde0e.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パラメーターの例

{
        "メソッド":"ダイナミック" 、
        "IntegratedLoudnessTarget":"auto" 、
        "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

プロファイル

×

×

ビットレート

×

Crf

×

Height

FPS

ゴップ

×

プリセット

×

×

ScanMode

バフサイズ

×

Maxrate

×

PixFmt

bgr8

TranscodeSummary: コード変換の概要

パラメーター

データ型

説明

VideoId

String

ビデオのID。

TranscodeTemplateGroupId

String

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

TranscodeStatus

String

トランスコードのステータス。 設定可能な値は以下のとおりです。

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

  • 部分: ビデオは部分的にトランスコードされています。

  • 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/s

FPS

String

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

形式

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

コード変換タスクのステータス。 設定可能な値は以下のとおりです。

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

  • 部分: ビデオは部分的にトランスコードされています。

  • 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: トランスコードジョブが失敗しました。

Priority

String

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

定義

String

定義。

説明

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

TranscodeTemplateId

String

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

CreationTime

String

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

CompleteTime

String

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

InputFileUrl

String

メザニンファイルのOSS URL。

OutputFile

OutputFile

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

ErrorCode

String

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

ErrorMessage

String

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

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

パラメーター

データ型

説明

OutputFileUrl

String

出力ファイルのOSS URL。

形式

String

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

String

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

Height

String

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

有効期間

String

出力ファイルの長さ。 (単位:秒)

ビットレート

String

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

FPS

String

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

ファイルサイズ

Long

出力ファイルのサイズ。 単位: バイト。

暗号化タイプ

String

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

WatermarkIdList

String

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

VideoStreamList

String

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

AudioStreamList

String

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

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

パラメーター

データ型

説明

ImageId

String

イメージの ID です。

URL

String

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

タイトル

String

画像のタイトル。

タグ

String

画像のタグ。

ImageType

String

イメージのタイプ。

CateId

Long

カテゴリ ID を示します。

CateName

String

カテゴリ名を示します。

説明

String

イメージの説明。

StorageLocation

String

ストレージの場所。

メザニン

メザニン

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

CreationTime

String

イメージが作成された時刻。 時刻は UTC 表示です。

ステータス

String

イメージのステータス。

AppId

String

アプリケーションの ID を示します。

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

パラメーター

データ型

説明

FileURL

String

メザニンイメージファイルのOSS URL。

OriginalFileName

String

メザニンイメージファイルの名前。

FileSize

Long

メザニン画像ファイルのサイズ。 単位: バイト。

Integer

メザニン画像ファイルの幅。 単位: ピクセル

Height

Integer

メザニン画像ファイルの高さ。 単位: ピクセル

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

パラメーター

データ型

説明

VideoId

String

ビデオのID。

DynamicImageId

String

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

FileURL

String

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

String

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

Height

String

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

有効期間

String

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

形式

String

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

FileSize

String

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

FPS

String

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

URLUploadInfo: URLベースのアップロードジョブに関する情報

パラメーター

データ型

説明

JobId

String

アップロードジョブのID。

UploadURL

String

アップロードするビデオのURL。

MediaId

String

アップロードするビデオのID。

ステータス

String

ビデオのステータス。

UploadStatus

String

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

CreationTime

String

アップロードジョブが作成された時刻。

CompleteTime

Long

アップロードジョブが完了した時刻。

UserData

String

カスタム設定。

ErrorCode

String

エラーコードを示します。

ErrorMessage

String

エラーメッセージを示します。

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

利点

説明

保留中

アップロードジョブが送信され、処理されます。

処理

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

ダウンロード

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

DOWNLOAD_SUCCESS

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

DOWNLOAD_FAIL

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

アップロード

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

UPLOAD_SUCCESS

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

UPLOAD_FAIL

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

SUCCESS

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

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 を示します。

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

利点

説明

補足

アップロード

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

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

通常

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

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

アップロード失敗

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

この状態の補助メディア資産はアップロードに失敗します。

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

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

ステータス

String

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

CreationTime

String

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

ModificationTime

String

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

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

パラメーター

データ型

説明

AppId

String

アプリケーションの ID を示します。

PolicyType

String

ポリシーのタイプ。 有効な値: システムとカスタム。

PolicyName

String

ポリシー名。

CreationTime

String

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

説明

String

ポリシーの説明。