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

ApsaraVideo VOD:メディア処理のパラメータ

最終更新日:Feb 24, 2025

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

EncryptConfig: HLS暗号化の設定

パラメーター

データ型

必須/任意

説明

CipherText

String

必須

平文キーを取得するために使用される暗号文キー。

DecryptKeyUri

String

必須

暗号文キーに基づいて復号化キーを取得するために使用されるアドレス。 例: http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk ****

KeyServiceType

String

必須

キーサービスのタイプ。 デフォルト値: KMS。Alibaba CloudのKey Management Serviceを示します。

EncryptConfigパラメーターの例

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

OverrideParams: コード変換ジョブの設定

パラメーター

データ型

必須/任意

説明

透かし加工

透かし []

選択可能

透かしの設定。 透かしを置き換えるには、このパラメーターを設定する必要があります。

サブタイトル設定

サブタイトル設定

選択可能

字幕パッケージ。 ビデオの字幕を置き換えるには、このパラメーターを設定する必要があります。

説明
  • 使用するトランスコードテンプレートに対して、字幕パラメーターが事前に設定されていることを確認してください。 それ以外の場合は、字幕設定を変更できません。 字幕パラメーターの設定方法の詳細については、「SubtitleConfig」をご参照ください。

  • 字幕ファイルの取得に使用される新しいURLは、HTTP: // out-dda **** .cn-shanghai.aliyuncs.com/subtitle/subtitle.assなど、httpベースObject Storage Service (OSS) URLである必要があります。 CDN URLとHTTPSベースのOSS URLはサポートされていません。

PackageSubtitleSetting

PackageSubtitleSetting []

選択可能

字幕パッケージの構成。 アダプティブビットレートストリーミングテンプレートの字幕ファイルの取得に使用されるURLを置き換えるには、このパラメーターを設定する必要があります。

TranscodeTemplateList

TranscodeTemplate []

選択可能

コード変換テンプレートの設定。 トランスコードテンプレートの設定を変更するには、このパラメーターを設定する必要があります。

  • コード変換テンプレートのVideo、Audio、Clip、Rotate、TranscodeFileRegularパラメーターを変更できます。

  • 元の品質テンプレートのパラメーターは変更できません。

  • トランスコードテンプレートの設定を変更するには、TranscodeTemplateIdパラメーターを設定する必要があります。

説明

透かしの画像またはテキストのみを置き換えることができます。

TranscodeTemplateListパラメーターの例

        [
                {
                  "TranscodeTemplateId":"9580424e49b28c952a46544e3e8f ****" 、
                  "ビデオ":{
                          "幅":720、
                          "高さ":480、
                          "ビットレート":"600"
                  },
                  "オーディオ":{
                          "ビットレート":128
                  }, 
                  "クリップ":{
                          "TimeSpan":{
                                "シーク":"1"
                                "期間":"5"
                        },
                  "回転":"270" 、
                  "TranscodeFileRegular":"{MediaId}/{JobId}/{PlayDefinition}"
                  }
                }
        ]
                        

透かし: 透かしの設定

パラメーター

データ型

必須/任意

説明

WatermarkId

文字列

はい

トランスコードテンプレートに関連付けられている透かしID。 ApsaraVideo VODコンソールで透かしIDを照会できます。 詳細については、「透かしの管理」をご参照ください。

FileUrl

文字列

任意

透かしファイルのOSS URL。 画像透かしを設定するには、このパラメーターを設定する必要があります。 OSS URLを取得する方法の詳細については、「CreateUploadAttachedMedia」をご参照ください。

Content

文字列

任意

テキスト透かしの内容。 テキスト透かしを設定するには、このパラメーターを設定する必要があります。

重要

透かしファイルは、ソースビデオと同じオリジンに保存する必要があります。

SubtitleSetting: 字幕ファイル

パラメーター

タイプ

必須

説明

SubtitleList

字幕

必須

字幕ファイル。

Subtitle: サブタイトルの設定

パラメーター

タイプ

必須/任意

説明

SubtitleUrl

String

必須

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

CharEncode

String

必須

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

  • オート: 自動検出

  • UTF-8

  • GBK

  • BIG5

注: ビジネス要件に基づいて、CharEncodeパラメーターを有効なエンコード形式に設定することを推奨します。 パラメーターをautoに設定すると、検出されたエンコード形式が実際のエンコード形式ではない場合があります。

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

パラメーター

データ型

必須/任意

説明

PackageSubtitleList

PackageSubtitle []

必須

字幕パッケージ。 ビデオの字幕を置き換えるには、このパラメーターを設定する必要があります。

PackageSubtitle: 字幕パッケージの設定

パラメーター

データ型

必須/任意

説明

SubtitlePackageTemplateId

String

必須

字幕パッケージテンプレートのID。

言語

String

必須

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

説明

このパラメーターは、置換する字幕ファイルのURLの照会にのみ使用され、字幕言語の変更には使用できません。

SubtitleUrl

String

必須

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

説明

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

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

説明

SubtitlePackageTemplateIdおよびLanguageパラメーターは、置換する字幕ファイルのURLの照会にのみ使用され、字幕言語の変更には使用できません。

OverrideParamsパラメーターの例

{
  "透かし":[
    {
      "WatermarkId":"watermark1" 、
      "FileUrl":"http:// **** .bucket.aliyuncs.com/image/replace.png"
    },
    {
      "WatermarkId":"watermark2" 、
      "コンテンツ":"透かしテスト"
    }
  ],
  "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": [
      {
        "言语": "en-US" 、
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395 ****" 、 
        "SubtitleUrl": "http:// outin-**** .oss-cn-shanghai.aliyuncs.com/789679188D1F36A00AEB****.vtt" 
      },
      {
        "言语": "ja" 、  
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395ad ****" 、
        "SubtitleUrl": "http:// outin-**** .oss-cn-shanghai.aliyuncs.com/F43FD90FF4B936A00AEB****.vtt"
      }
    ]
  }
}
                        

WatermarkConfig: 透かしの設定

画像透かしのパラメータ

パラメーター

データ型

必須/任意

説明

Dx

String

必須

透かしの水平オフセット。 次のタイプの値がサポートされています。

  • ピクセル値: [8,4096]

  • 画像比 :( 0,1) 。 値0は、ビデオ画像の高さに対する垂直オフセットの割合が0% ことを示す。 値1は、割合が100% ことを示す。 0.5の値は、割合が50% ことを示す。 他の値も同様に変換することができる。

Dy

String

必須

透かしの垂直オフセット。 次のタイプの値がサポートされています。

  • ピクセル値: [8,4096]

  • 画像比 :( 0,1) 。 値0は、ビデオ画像の高さに対する垂直オフセットの割合が0% ことを示す。 値1は、割合が100% ことを示す。 0.5の値は、割合が50% ことを示す。 他の値も同様に変換することができる。

String

必須

透かしの幅。 次のタイプの値がサポートされています。

  • ピクセル値: [8,4096]

  • 画像比 :( 0,1) 。 値0は、ビデオ画像の幅に対する水平オフセットの割合が0% であることを示す。 値1は、割合が100% ことを示す。 0.5の値は、割合が50% ことを示す。 他の値も同様に変換することができる。

Height

String

必須

透かしの高さ。 次のタイプの値がサポートされています。

  • ピクセル値: [8,4096]

  • 画像比 :( 0,1) 。 値0は、ビデオ画像の幅に対する水平オフセットの割合が0% であることを示す。 値1は、割合が100% ことを示す。 0.5の値は、割合が50% ことを示す。 他の値も同様に変換することができる。

ReferPos

String

必須

透かしの位置。 有効な値:

  • BottomRight

  • BottomLeft

  • TopRight

  • トップ左

タイムライン

タイムライン

選択可能

開始時刻と終了時刻を含む、透かし表示のタイムライン。 値はJSON文字列です。

重要

このパラメータは、画像透かしに対してのみ有効です。

テキスト透かしのパラメータ

パラメーター

データ型

必須/任意

説明

Content

String

必須

テキスト透かしの内容。 例: "テキスト透かし" 。

FontName

String

任意

フォントの名前。 詳細については、「フォント名のパラメーター値」をご参照ください。

FontColor

String

任意

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

FontAlpha

String

任意

テキスト透かしの透明度。 有効な値: (0,1) 。 デフォルト値 : 1.0

BorderColor

String

任意

フォントアウトラインの色。 詳細については、「カラー設定パラメーター」をご参照ください。

Integer

選択可能

テキストの透かしの上余白。 整数値のみがサポートされています。 デフォルト値:0 有効な値: [0,4096] 。

左揃え

Integer

選択可能

テキストの透かしの左マージン。 整数値のみがサポートされています。 デフォルト値:0 有効な値: [0,4096] 。

FontSize

Integer

選択可能

フォントのサイズ。 整数値のみがサポートされています。 デフォルト値: 16。 有効な値: (4,120) 。

BorderWidth

Integer

選択可能

フォントアウトラインの幅。 整数値のみがサポートされています。 デフォルト値:0 有効な値: (0,4096) 。

タイムライン: 透かしタイムラインの設定

パラメーター

データ型

必須/任意

説明

開始

String

必須

透かしが表示される時間範囲の開始。 単位は秒です。 有効な値: 正の数。 デフォルト値:0

有効期間

String

必須

ウォーターマークが表示される時間範囲。 単位は秒です。 有効な値: [Startパラメーターの値、ToEND] 。 デフォルト値: ビデオの終わりを示すToEND。

重要

このパラメータは、画像透かしに対してのみ有効です。

フォント名のパラメータ値

フォント名

説明

シムサン

簡体字中国語-SimSun

WenQuanYi Zen Hei

WenQuanYi Zen Hei

WenQuanYi Zen Hei Mono

簡体字中国語-WenQuanYi Zen Hei Mono

WenQuanYi Zen Heiシャープ

簡体字中国語-WenQuanYi Zen Hei Sharp

ユアンティSC

ユアンティSCレギュラー

ビデオスナップショット

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

SnapshotTemplateConfig

パラメーター

タイプ

必須

説明

SnapshotType

String

必須

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

  • NormalSnapshot: 通常のスナップショット

  • SpriteSnapshot: イメージスプライト

  • WebVttSnapshot: WebVTTスナップショット

SnapshotConfig

JSON

必須

スナップショットの設定は、スナップショットの種類によって異なります。 詳細については、「SnapshotConfig」をご参照ください。

SnapshotConfig

説明

イメージスプライトは、複数の通常のスナップショットで構成されます。 したがって、SnapshotConfigパラメーターは、イメージスプライトと通常のスナップショットの両方に必要です。

パラメーター

タイプ

必須

説明

FrameType

String

必須

スナップショットのフレームタイプ。 有効な値:

  • intra: キーフレーム

  • normal: ノーマルフレーム

集計

Long

必須

キャプチャするスナップショットの数。

間隔

Long

必須

スナップショット間隔。 値は0以上である必要があります。 単位は秒です。 このパラメーターを0に設定した場合、スナップショットは、ビデオの長さをCountパラメーターの値で割った値に基づいて偶数間隔でキャプチャされます。

SpecifiedOffsetTime

Long

必須

最初のスナップショットがキャプチャされた時点。 単位:ミリ秒。

Integer

選択可能

各スナップショットの幅。 有効な値: [8,4096] 。 デフォルトでは、ソースビデオの幅が使用されます。 単位: ピクセル。

Height

Integer

選択可能

各スナップショットの高さ。 有効な値: [8,4096] 。 デフォルトでは、ソースビデオの高さが使用されます。 単位: ピクセル。

SpriteSnapshotConfig

JSON

選択可能

イメージスプライトのスナップショット設定。 このパラメーターは、SnapshotTypeをSpriteSnapshotに設定する場合に必要です。 詳細については、「SpriteSnapshotConfig」をご参照ください。

Format

String

任意

出力ファイルの形式です。 値をvttに設定します。 このパラメーターは、SnapshotTypeパラメーターがWebVttSnapshotに設定されている場合にのみ有効です。

サブアウト

JSON

選択可能

スナップショットの表示方法を指定します。 このパラメーターは、SnapshotTypeパラメーターがWebVttSnapshotに設定されている場合にのみ有効です。 詳細については、「SubOut」をご参照ください。

SpriteSnapshotConfig

パラメーター

タイプ

必須

説明

CellWidth

String

任意

イメージスプライトを構成する元のスナップショットの幅。 デフォルト値: 通常のスナップショットの幅。 単位: ピクセル。

CellHeight

String

任意

イメージスプライトを構成する元のスナップショットの高さ。 デフォルト値: 通常のスナップショットの高さ。 単位: ピクセル。

間隔

String

必須

イメージスプライトを構成する元のスナップショットのパディング。 単位: ピクセル。

マージン

String

必須

イメージスプライトを構成する元のスナップショットのマージン。 単位: ピクセル。

String

必須

イメージスプライトの背景色。 詳細については、「カラー設定パラメーター」をご参照ください。

説明

RGB値を使用して背景色を設定することはできません。

カラム

String

必須

イメージスプライトを構成する元のスナップショットの列数。 有効な値: [1,10000] 。

Lines

String

必須

イメージスプライトを構成する元のスナップショットの行数。 有効な値: [1,10000] 。

KeepCellPic

String

必須

イメージスプライトを構成する元のスナップショットを保持するかどうかを指定します。 有効な値:

  • キープ

  • delete

サブアウト

パラメーター

タイプ

必須

説明

IsSptFrag

String

必須

有効な値:

  • false: 各スナップショットを個別に保存します。

  • true: 複数のスナップショットを組み合わせてイメージスプライトを生成し、イメージスプライトを保存します。

SnapshotConfigパラメーターの例

{
  "SnapshotConfig": {
    "カウント": 10、
    "SpecifiedOffsetTime": 0、
    "インターバル": 1
  },
  "SnapshotType": "NormalSnapshot"
} 

フレームアニメーション

フレームアニメーションテンプレート設定

DynamicImageTemplateConfig

パラメーター

タイプ

必須

説明

名前

String

必須

フレームアニメーションテンプレートの名前。

ビデオ

JSON

必須

アニメーションステッカーの表示構成。 詳細は、ビデオを参照してください。

Container

JSON

必須

アニメーションステッカーの形式。 詳細については、「コンテナー」をご参照ください。

クリップ

JSON

必須

ビデオクリップからアニメーションステッカーを生成するために使用される設定。 詳細については、「クリップ」をご参照ください。

SetDefaultCover

String

必須

キャプチャしたアニメーションステッカーをビデオサムネイルとして自動的に使用するかどうかを指定します。 有効な値:

  • true: キャプチャしたアニメーションステッカーをビデオサムネイルとして使用します。

  • false: キャプチャしたアニメーションステッカーをビデオサムネイルとして使用しません。

ビデオ

説明
  • WidthまたはHeightを指定しない場合、ソースビデオのサイズが使用されます。

  • 幅パラメーターのみを指定した場合、アニメーションステッカーの高さは、ソースビデオのアスペクト比に基づいてサイズ変更されます。

  • Heightパラメーターのみを指定した場合、アニメーションステッカーの幅は、ソースビデオのアスペクト比に基づいてサイズ変更されます。

パラメーター

タイプ

必須

説明

String

任意

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

Height

String

任意

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

FPS

String

必須

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

コンテナ

パラメーター

タイプ

必須

説明

Format

String

必須

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

  • webp

  • gif

クリップ

パラメーター

タイプ

必須

説明

TimeSpan

JSON

必須

アニメーションステッカーのタイムライン構成。 詳細については、「TimeSpan」をご参照ください。

TimeSpan

説明
  • 期間に基づいてアニメーションステッカーをキャプチャする場合は、シークパラメーターと期間パラメーターを指定します。 動画の特定の部分をキャプチャしてアニメーションステッカーを生成する場合は、シークパラメーターと終了パラメーターを指定する必要があります。

  • SeekDuration、および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

有効期間

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

完了

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

DynamicImageTemplateConfigパラメーターの例

{
  "ビデオ": {
    "Fps": 5、
    "幅": 1024
  },
  "クリップ": {
    "TimeSpan": {
      "シーク": 0、
      「期間」: 15
    }
  },
  "コンテナ": {
    "フォーマット": "gif"
  },
  "SetDefaultCover": "false"
}