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

:リクエストパラメーター

最終更新日:Jul 12, 2022

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

PlayConfig: メディア再生のカスタム設定を指定します

このパラメータは、メディア再生のカスタム設定を指定します。 値はJSON文字列です。 特定のストリーミングドメインのメディア再生を設定できます。 次の表に、PlayConfigパラメーターで設定できるパラメーターを示します。

パラメーター

データ型

必須/任意

説明

PlayDomain

String

任意

ストリーミングドメインの名前。 複数のストリーミングドメインが設定されている場合は、現在のビデオを再生するストリーミングドメインの1つを指定できます。 指定されたストリーミングドメインが存在しない場合、現在のビデオの保存場所に対して設定されたデフォルトのストリーミングドメインがストリーミングURLで返されます。 例: "vod.test_domain"

XForwardedFor

String

任意

リクエストを開始したクライアントの送信元IPアドレス。 このパラメーターは、レビューセキュリティグループに追加されたIPアドレスからリクエストが開始されたかどうかを確認するために使用されます。 詳細については、「セキュリティIPアドレスのプレビュー」をご参照ください。 ApsaraVideo VODは、リクエストが複数のプロキシサーバーを通過した後、このパラメーターに基づいて送信元IPアドレスを取得できます。 データのセキュリティを確保するには、AES/ECB/PKCS5Paddingアルゴリズムを使用して送信元IPアドレスを暗号化する必要があります。 暗号化に使用されるキーを処理するには、チケットを起票してください。 例: "yqCD7Fp1uqChoVj/sl/p5Q==" 。

PreviewTime

String

任意

プレビュー期間 (秒単位) 。 最小値は 1 です。 最大値は、ビデオの合計期間を示します。 このパラメータを設定しないと、ビデオ全体が再生されます。 プレビュー機能を有効にする方法の詳細については、「VODリソースのプレビュー機能の設定」をご参照ください。

MtsHlsUriToken

String

任意

トークン発行サービスによって生成されるMtsHlsUriTokenパラメーター。 このパラメーターは、Http-Live-Streaming (HLS) Encryptionモードで暗号化されたビデオを復号化して再生するシナリオで設定できます。 これにより、解読キーが傍受されるのを防ぐことができます。 詳細については、「HLS暗号化」をご参照ください。

暗号化タイプ

String

任意

暗号化のタイプ。 このパラメーターを設定すると、暗号化されていないビデオや特定のモードで暗号化されたビデオを再生できます。 設定可能な値は以下のとおりです。

  • Unencrypted: 暗号化されない

  • AliyunVoDCryption: Alibaba Cloud独自の暗号化

  • HLSEncryption: HLS暗号化

説明

例:

PlayConfig={"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"}                

ReAuthInfo: メディア再生用のCDN再認証の設定を指定します。

このパラメーターは、メディア再生のCDN再認証の設定を指定します。 値はJSON文字列です。 After you enable CDN reauthentication, you can use this parameter to set the uid and rand parameters for URL signing. 次の表に、ReAuthInfoパラメーターで設定できるパラメーターを示します。

パラメーター

データ型

必須/任意

説明

uid

String

任意

一般的に0に設定される追加パラメータ。 このパラメーターは必要に応じて設定できます。

rand

String

任意

乱数は通常0に設定されます。 毎回異なるURLを生成するには、UUIDを乱数として使用します。

説明

例:

ReAuthInfo={"uid":"12345","rand":"abckljd"}
                        

UserData: メディアアップロードのカスタム設定を指定します。

このパラメーターには、イベント通知のコールバック設定など、メディアアップロードのカスタム設定を指定します。 The value is a JSON string.

説明

HTTPコールバックメソッドのみがサポートされています。

次の表に、UserDataパラメーターで設定できるパラメーターを示します。

パラメーター

データ型

必須/任意

説明

MessageCallback

String

任意

The callback configurations for event notifications. If you set this parameter, the specified callback configurations take effect. それ以外の場合、デフォルトのコールバック設定が有効になります。 データ構造はJSON Objectです。 For more information, see SetMessageCallback. Example: {"CallbackType":"http", "CallbackURL":"http://callback-host/addr"}. CallbackTypeパラメーターは、コールバックメソッドを指定します。 デフォルト値はhttpです。 CallbackURLパラメーターは、コールバックURLを指定します。

Extend

String

任意

カスタム拡張フィールド。コールバック中に透過的に送信されます。 フィールド値の長さは最大512バイトです。 データ構造はJSON Objectです。

AccelerateConfig

String

任意

アップロード高速化の設定。 データ構造はJSON Objectです。 例: {"Type":"oss","Domain":"https://oss-accelerate.aliyuncs.com"} 。 Typeパラメーターは、アクセラレーションメソッドを指定します。 値をossに設定します。 Domainパラメーターには、CDNのドメイン名を指定します。 デフォルトでは、CDNのドメイン名はHTTPS URLです。 詳細は、「リージョンとエンドポイント」をご参照ください。

説明

例:

UserData={"MessageCallback":{"CallbackURL":"http://example.com","CallbackType":"http"}, "Extend":{"localId":"xxx","test":"www"}, "AccelerateConfig":{
"タイプ":"oss" 、"ドメイン":"https://demo.developer.aliyundoc.com"}
                        

EncryptConfig: HLS暗号化の設定を指定します。

このパラメータは、HLS暗号化の設定を指定します。

パラメーター

データ型

必須/任意

説明

CipherText

String

必須

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

DecryptKeyUri

String

必須

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

KeyServiceType

String

必須

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

SpriteSnapshotConfig: イメージスプライトをキャプチャするための設定を指定します

パラメーター

データ型

必須/任意

説明

CellWidth

String

任意

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

CellHeight

String

任意

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

間隔

String

任意

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

マージン

String

任意

The margin of the original snapshots that compose the image sprite. デフォルト値は 0 です。 単位: ピクセル

String

任意

イメージスプライトの背景色。 デフォルト値: Black。

カラム

String

任意

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

Lines

String

任意

イメージスプライトを構成する元のスナップショットの行数。 Valid values: [1,10000]. Default value: 10.

KeepCellPic

String

任意

Specifies whether to retain the original snapshots that compose the image sprite. 設定可能な値は以下のとおりです。

  • keep

  • delete

Default value: keep.

説明

If you want to set all the parameters in the SpriteSnapshotConfig parameter to their default values, specify an empty JSON string for the SpriteSnapshotConfig parameter.