vod api のメディア処理パラメーターの説明 - ApsaraVideo VOD

このトピックでは、ApsaraVideo VOD API のメディア処理パラメーターについて説明します。

EncryptConfig：HLS 暗号化設定

フィールド名	タイプ	必須	説明
CipherText	String	はい	キーの暗号文。これを使用してプレーンテキストキーを取得します。
DecryptKeyUri	String	はい	キーの暗号文に基づいて復号鍵を取得するために使用される URI。例：`http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****`。
KeyServiceType	String	はい	キーサービスのタイプ。デフォルト値：`KMS`。KMS は Alibaba Cloud Key Management Service の略称です。

EncryptConfig パラメーターの例

{
  "CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "DecryptKeyUri":"http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "KeyServiceType":"KMS"
}

OverrideParams：トランスコーディングジョブパラメーターのオーバーライド設定

フィールド名	タイプ	必須	説明
Watermarks	Watermark[]	いいえ	ウォーターマークを置き換える場合に必須です。
SubtitleSetting	SubtitleSetting	いいえ	字幕を置き換える場合に必須です。説明使用するトランスコーディングテンプレートには、事前に字幕パラメーターを設定しておく必要があります。設定されていない場合、字幕パラメーターは上書きされません。字幕設定の詳細については、「SubtitleConfig」をご参照ください。置き換え用の字幕ファイルの URL は、HTTP (HTTPS ではない) の OSS URL である必要があります。CDN 高速化ドメイン名の URL はサポートされていません。例：`http://out-dda****.cn-shanghai.aliyuncs.com/subtitle/subtitle.ass`
PackageSubtitleSetting	PackageSubtitleSetting[]	いいえ	アダプティブビットレートストリーミングのパッケージング中に字幕 URL を上書きする場合に必須です。
TranscodeTemplateList	TranscodeTemplate[]	いいえ	テンプレートパラメーターを置き換える場合に必須です。トランスコーディングテンプレート内の `Video`、`Audio`、`Clip`、`Rotate`、および `TranscodeFileRegular` パラメーターの上書きをサポートしています。オリジナル画質テンプレートのパラメーターは上書きできません。パラメーターを上書きするには、`TranscodeTemplateId` パラメーターが必須です。

説明

現在、ウォーターマークの画像ファイルまたはテキストコンテンツのみ置き換えが可能です。

TranscodeTemplateList の例

        [
                {
                  "TranscodeTemplateId":"9580424e49b28c952a46544e3e8f****",
                  "Video":{
                          "Width":720,
                          "Height":480,
                          "Bitrate":"600"
                  },
                  "Audio":{
                          "Bitrate":128
                  },
                  "Clip":{
                          "TimeSpan":{
                                "Seek":"1",
                                "Duration":"5"
                        },
                  "Rotate":"270",
                  "TranscodeFileRegular":"{MediaId}/{JobId}/{PlayDefinition}"
                  }
                }
        ]

Watermark：ウォーターマークパラメーターのオーバーライド設定

フィールド名	タイプ	必須	説明
WatermarkId	String	はい	トランスコーディングテンプレートに関連付けられているウォーターマークの ID。ID は ApsaraVideo VOD コンソールで確認できます。詳細については、「ウォーターマーク管理」をご参照ください。
FileUrl	String	いいえ	ウォーターマークファイルの OSS URL。このパラメーターは画像ウォーターマークに必須です。ファイルの OSS URL を取得する方法の詳細については、「CreateUploadAttachedMedia」をご参照ください。
Content	String	いいえ	テキストウォーターマークのコンテンツ。このパラメーターはテキストウォーターマークに必須です。

重要

`FileUrl` は、ソースビデオのストレージロケーションと一致している必要があります。

SubtitleSetting：字幕パラメーターのオーバーライド設定

フィールド名	タイプ	必須	説明
SubtitleList	Subtitle	はい	置き換え字幕のリスト。

字幕設定

フィールド名

タイプ

必須

説明

SubtitleUrl

String

はい

字幕ファイルの OSS URL。HTTPS URL はサポートされていません。

CharEncode

String

はい

字幕コンテンツのエンコード形式。有効な値：

auto (自動検出)
UTF-8
GBK
BIG5

説明

`CharEncode` には特定のエンコード形式を設定してください。このパラメーターを `auto` に設定すると、エンコード形式が正しく検出されない場合があります。

PackageSubtitleSetting：パッケージ化された字幕の置き換えパラメーター

フィールド名	タイプ	必須	説明
PackageSubtitleList	PackageSubtitle[]	はい	字幕を置き換える場合に必須です。

PackageSubtitle：パッケージ化された字幕の置き換えパラメーター

フィールド名	タイプ	必須	説明
SubtitlePackageTemplateId	String	はい	字幕パッケージングテンプレートの ID。
Language	String	はい	言語。詳細については、RFC 5646 をご参照ください。例：en-US。説明 `Language` パラメーターは、置き換え対象の字幕ファイルを取得するためにのみ使用されます。言語自体は置き換えられません。
SubtitleUrl	String	はい	字幕の URL。HTTP の OSS URL のみがサポートされています。HTTP の CDN URL および HTTPS URL はサポートされていません。説明現在、サポートされている HTTP URL は 1 つのみです。字幕ファイルは、ApsaraVideo VOD によって割り当てられたシステムバケットにのみ保存できます。

説明

`SubtitlePackageTemplateId` および `Language` パラメーターは、置き換え対象の字幕の URL を取得するために使用されます。言語自体は置き換えできません。

OverrideParams パラメーターの例

{
  "Watermarks":[
    {
      "WatermarkId":"watermark1",
      "FileUrl":"http://****.bucket.aliyuncs.com/image/replace.png"
    },
    {
      "WatermarkId":"watermark2",
      "Content":"Watermark test"
    }
  ],
  "SubtitleSetting":{
          "SubtitleList":[
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b850b-724c-4011-b885-dd16c****.ass",
                "CharEncode":"UTF-8"
                },
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b86db-724c-4011-b885-dd161d****.srt",
                "CharEncode":"auto"
                }
        ]
  },
  "PackageSubtitleSetting": {
    "PackageSubtitleList": [
      {
        "Language": "en-US",
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395****", 
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/789679188D1F36A00AEB****.vtt" 
      },
      {
        "Language": "ja",  
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395ad****",
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/F43FD90FF4B936A00AEB****.vtt"
      }
    ]
  }
}

WatermarkConfig：ウォーターマーク設定

ウォーターマークタイプが画像の場合

パラメーター名	パラメータータイプ	必須	説明
Dx	String	はい	水平オフセットは 2 つの形式で指定できます。ピクセル値：[8,4096] 画面のパーセンテージ：(0,1)。値 0 は 0%、値 1 は 100%、値 0.5 は 50% を表します。他の値も同様に解釈されます。
Dy	String	はい	垂直オフセットは 2 つの形式で指定できます。ピクセル値：[8,4096] 画面比率：(0,1)。値 0 は画面の 0%、1 は 100%、0.5 は 50% を表します。他の値も同様に解釈されます。
Width	String	はい	ウォーターマークの幅は 2 つの形式で指定できます。ピクセル値：[8,4096] 画面比率：(0,1)。値 0 は画面の 0%、値 1 は 100%、値 0.5 は 50% を表します。他の値も同様に解釈されます。
Height	String	はい	ウォーターマークの高さは 2 つの値形式をサポートしています。ピクセル値：[8,4096] 画像比率：(0,1)。値 0 は画像エリアの 0%、1 は 100%、0.5 は 50% を表します。他の値も同様に解釈されます。
ReferPos	String	はい	ウォーターマークの位置： BottomRight (右下) BottomLeft (左下) TopRight (右上) TopLeft (左上)
Timeline	Timeline	いいえ	ウォーターマークのタイムライン。ウォーターマークが表示される開始時刻と終了時刻を指定します。値は JSON 文字列です。

重要

`Timeline` パラメーターは、画像ウォーターマークに対してのみ有効です。

ウォーターマークタイプがテキストの場合

パラメーター名	パラメータータイプ	必須	説明
Content	String	はい	テキストウォーターマークのコンテンツ。例：「テキストウォーターマーク」。
FontName	String	いいえ	フォント名
FontColor	String	いいえ	フォントの色
FontAlpha	String	いいえ	フォントの透明度。有効な値：(0, 1]。デフォルト値：1.0。
BorderColor	String	いいえ	輪郭色
Top	Integer	いいえ	テキストの上マージン。整数値のみサポートされます。単位：px。デフォルト値：0。有効な値：[0, 4096]。
Left	Integer	いいえ	テキストの左マージン。整数値のみサポートされます。単位：px。デフォルト値：0。有効な値：[0, 4096]。
FontSize	Integer	いいえ	フォントサイズ。整数値のみサポートされます。デフォルト値：16。有効な値：(4, 120)。
BorderWidth	Integer	いいえ	輪郭の幅。整数値のみサポートされます。単位：px。デフォルト値：0。有効な値：(0, 4096]。

ウォーターマークのタイムライン

パラメーター名	タイプ	必須	説明
Start	String	はい	ウォーターマークが表示され始める時刻。単位：秒。値は数値である必要があります。デフォルト値：0。
Duration	String	はい	ウォーターマークが表示される期間。単位：秒。有効な値：数値または `ToEND`。デフォルト値：`ToEND` (ビデオの終わりを示します)。

重要

`Timeline` パラメーターは、画像ウォーターマークに対してのみ有効です。

フォント名

フォント名	説明
SimSun	宋体
WenQuanYi Zen Hei	文泉驛正黒
WenQuanYi Zen Hei Mono	文泉驛等幅正黒
WenQuanYi Zen Hei Sharp	文泉驛点陣正黒
Yuanti SC	簡体ラウンド、レギュラー

ビデオスナップショット

スナップショットテンプレートの設定

SnapshotTemplateConfig

名前

タイプ

必須

説明

SnapshotType

String

はい

スナップショットタイプ。有効な値：

NormalSnapshot：通常のスナップショット。
SpriteSnapshot：スプライト。
WebVttSnapshot：WebVTT スナップショット。

SnapshotConfig

JSON

はい

スナップショットテンプレートの設定。設定は `SnapshotType` の値によって異なります。詳細については、後述の「SnapshotConfig」をご参照ください。

SnapshotConfig

説明

スプライトは、通常のスナップショットを撮影し、それらを結合して作成されます。したがって、`SnapshotConfig` パラメーターは、通常のスナップショットとスプライトの両方で必須です。

パラメーター名	タイプ	必須	説明
FrameType	String	はい	スナップショットのフレームタイプ。有効な値： intra：キーフレーム。 normal：通常フレーム。
Count	Long	はい	キャプチャするスナップショットの数。
Interval	Long	はい	スナップショットをキャプチャする間隔。値は 0 以上である必要があります。単位：秒。値が 0 の場合、ビデオのデュレーションと `Count` の値に基づいて、等間隔でスナップショットがキャプチャされます。
SpecifiedOffsetTime	Long	はい	スナップショットのキャプチャを開始する時刻。単位：ミリ秒。
Width	Integer	いいえ	スナップショットの幅。有効な値：[8, 4096]。デフォルト値：ソースビデオの幅。単位：px。
Height	Integer	いいえ	スナップショットの高さ。有効な値：[8, 4096]。デフォルト値：ソースビデオの高さ。単位：px。
SpriteSnapshotConfig	JSON	いいえ	スプライト設定。このパラメーターは、`SnapshotType` が `SpriteSnapshot` に設定されている場合に必須です。詳細については、後述の「SpriteSnapshotConfig」をご参照ください。
Format	String	いいえ	出力スナップショットファイルのフォーマット。値を `vtt` に設定します。このパラメーターは、`SnapshotType` が `WebVttSnapshot` に設定されている場合にのみ有効です。
SubOut	JSON	いいえ	`SnapshotType` が `WebVttSnapshot` に設定されている場合のスナップショットの表示方法を制御します。詳細については、後述の「SubOut」をご参照ください。

SpriteSnapshotConfig

パラメーター名	タイプ	必須	説明
CellWidth	String	いいえ	スプライト内の各小さい画像の幅。デフォルト値：通常のスナップショットの幅。単位：px。
CellHeight	String	いいえ	スプライト内の各小さい画像の高さ。デフォルト値：通常のスナップショットの高さ。単位：px。
Padding	String	はい	各小さい画像のパディング。単位：px。
Margin	String	はい	各小さい画像のマージン。単位：px。
Color	String	はい	スプライトの背景色。詳細については、「色の設定」をご参照ください。説明 RGB 値を使用した色の設定はサポートされていません。
Columns	String	はい	小さい画像の列数。有効な値：[1, 10000]。
Lines	String	はい	小さい画像の行数。有効な値：[1, 10000]。
KeepCellPic	String	はい	小さい画像を保持するかどうかを指定します。有効な値： keep：保持します。 delete：項目を削除します。

SubOut

パラメーター名

タイプ

必須

説明

IsSptFrag

String

はい

有効な値：

false：各スナップショットを個別の画像として保存します。
true：保存する前に、スナップショットをスプライトのような大きな画像に結合します。

スナップショットテンプレートの例

{
  "SnapshotConfig": {
    "Count": 10,
    "SpecifiedOffsetTime": 0,
    "Interval": 1
  },
  "SnapshotType": "NormalSnapshot"
}

ビデオからのアニメーション画像

アニメーション画像テンプレートの設定

DynamicImageTemplateConfig

パラメーター名	タイプ	必須	説明
Name	String	はい	アニメーション画像テンプレートの名前。
Video	JSON	はい	アニメーション画像のビデオ設定。詳細については、後述の「Video」をご参照ください。
Container	JSON	はい	アニメーション画像のコンテナフォーマット設定。詳細については、後述の「Container」をご参照ください。
Clip	JSON	はい	アニメーション画像のクリッピング設定。詳細については、後述の「Clip」をご参照ください。
SetDefaultCover	String	はい	生成されたアニメーション画像をデフォルトでビデオサムネイルとして設定するかどうかを指定します。有効な値： true：デフォルトのサムネイルとして設定します。 false：デフォルトのサムネイルとして設定しません。

Video

説明

`Width` と `Height` を設定しない場合、出力されるアニメーション画像はソースビデオと同じディメンションになります。
`Width` のみを設定した場合、高さはソースビデオのアスペクト比に基づいて比例的にスケーリングされます。
`Height` のみを設定した場合、幅はソースビデオのアスペクト比に基づいて比例的にスケーリングされます。

パラメーター名	タイプ	必須	説明
Width	String	いいえ	出力アニメーション画像の幅。有効な値：[128, 4096]。
Height	String	いいえ	出力アニメーション画像の高さ。有効な値：[128, 4096]。
Fps	String	はい	フレームレート。有効な値：(0, 60]。

Container

パラメーター名

タイプ

必須

説明

Format

String

はい

出力アニメーション画像のフォーマット。有効な値：

webp
gif

Clip

パラメーター名	タイプ	必須	説明
TimeSpan	JSON	はい	クリッピングのタイムライン設定。詳細については、後述の「TimeSpan」をご参照ください。

TimeSpan

説明

デュレーションに基づいてビデオをクリップするには、Seek と Duration の両方のパラメーターを指定します。開始と終了をトリミングしてビデオをクリップするには、Seek と End の両方のパラメーターを指定します。
Seek、Duration、および End を同時に指定した場合、Seek と End パラメーターが有効になります。

パラメーター名	タイプ	必須	説明
Seek	String	はい	アニメーション画像のクリップの開始時刻。フォーマット 1：sssss[.SSS]。有効な値：[0.000, 86399.999]。例：0 フォーマット 2：hh:mm:ss[.SSS]。有効な値：[00:00:00.000, 23:59:59.999]。例：00:00:05.003
Duration	String	いいえ	クリップのデュレーション。フォーマット 1：sssss[.SSS]。有効な値：[0.000, 86399.999]。例：15 フォーマット 2：hh:mm:ss[.SSS]。有効な値：[00:00:00.000, 23:59:59.999]。例：00:00:10.003
End	String	いいえ	破棄するビデオの末尾部分のデュレーション。このパラメーターを指定すると、`Duration` パラメーターは無効になります。フォーマット 1：sssss[.SSS]。有効な値：[0.000, 86399.999]。例：12000.55 フォーマット 2：hh:mm:ss[.SSS]。有効な値：[00:00:00.000, 23:59:59.999]。例：00:00:15.003

アニメーション画像テンプレートの例

{
  "Video": {
    "Fps": 5,
    "Width": 1024
  },
  "Clip": {
    "TimeSpan": {
      "Seek": 0,
      "Duration": 15
    }
  },
  "Container": {
    "Format": "gif"
  },
  "SetDefaultCover": "false"
}