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

ApsaraVideo Live:DescribeLiveStreamWatermarks

最終更新日:Aug 23, 2024

透かしテンプレートを照会します。

使用上の注意

この操作では、透かしテンプレートを照会します。 PageNumberパラメーターを使用して、結果を別のページで表示できます。 この操作を呼び出すときは、パラメーターを適切に設定してください。

QPS limit

この操作は、アカウントごとに1秒あたり最大60回呼び出すことができます。 1秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。 その結果、あなたのビジネスが影響を受ける可能性があります。 この操作を呼び出すときは、制限に注意することをお勧めします。 詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

Parameter データ型 Required 説明
アクション 文字列 必須 DescribeLiveStreamWatermarks

実行する操作です。 Set the value to DescribeLiveStreamWatermarks.

ページ番号 Integer 任意 1

結果を表示するページの数。 このパラメーターを指定しない場合、デフォルト値の1が使用されます。

PageSize 整数 任意 100

各ページに表示されるテンプレートの数。 このパラメーターを指定しない場合、デフォルト値の100が使用されます。

レスポンスパラメーター

パラメーター データ型 説明
RequestId 文字列 5c6a2a0df228-4a64- af62-20e91b9676b3

リクエストの ID です。

WatermarkList 透かしの配列

The list of watermark templates.

透かし
説明 String 私の透かし

透かしの説明。

高さ 整数 200

透かしの高さ。 単位: ピクセル

Name 文字列 ライブ透かし ****

透かしの名前です。

OffsetCorner String TopRight

透かしの位置。

  • TopLeft: 左上隅。
  • TopRight: 右上隅。
  • BottomLeft: 左下隅。
  • BottomRight: 右下隅。
PictureUrl String http://example.com

透かし画像のURL。

RefHeight Integer 1080

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

RefWidth Integer 1920

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

TemplateId String 445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

透かしテンプレートのID。

透明性 Integer 255

透かしの透明度。 値が小さいほど、より透明な透かしを示す。 有効な値:0~255 。

データ型 Integer 0

透かしのタイプ。

  • 0: イメージ。 画像透かしのみが現在サポートされています。
  • 1: text.
XOffset Float 50.0

The offset of the watermark along the x-axis. 単位: ピクセル。

説明 この場合、RefWidthパラメータの値が参照として使用されます。 OffsetCornerパラメータがTopLeftに設定されている場合、XOffsetパラメータの値は、背景ビデオのものに対する透かしの左上隅のx軸オフセットを示します。 座標軸から背景映像の中心への方向は正である。 言い換えれば、x軸は右に向かって正である。
YOffset Float 100.0

The offset of the watermark along the y-axis. 単位: ピクセル

説明 この場合、RefHeightパラメーターの値が参照として使用されます。 OffsetCornerパラメータがTopLeftに設定されている場合、YOffsetパラメータの値は、背景ビデオのオフセットに対する透かしの左上隅のy軸オフセットを示します。 座標軸から背景映像の中心への方向は正である。 すなわち、y軸は下向きに正である。

リクエストの例

http(s):// live.aliyuncs.com/?Action=DescribeLiveStreamWatermarks
&<共通リクエストパラメーター>

応答のサンプル

XML形式

<DescribeLiveStreamWatermarkResponse>
  <RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>
  <WatermarkList>
        <透かし>
              <RefHeight>1080</RefHeight>
              <透明性> 255</透明性>
              <タイプ> 0</タイプ>
              <説明> 私の透かし </説明>
              <PictureUrl>http://example.com</PictureUrl>
              <OffsetCorner>TopRight</OffsetCorner>
              <高さ> 200</高さ>
              <YOffset></YOffset>
              <XOffset></XOffset>
              <RefWidth>1920</RefWidth>
              <TemplateId>445409ec-7eaa-4 61d-8f29-4bec2eb9 ****</TemplateId>
              <名前> ライブ透かし ****</Name>
        </透かし>
  </WatermarkList>
</DescribeLiveStreamWatermarkResponse>

JSON 形式

{
    "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3" 、
    "WatermarkList": {
        "透かし": [
            {
                "RefHeight": "1080",
                "透明性": "255" 、
                "タイプ": "0" 、
                "説明": "私の透かし" 、
                "PictureUrl": "http://example.com" 、
                "OffsetCorner": "TopRight",
                "高さ": "200" 、
                "YOffset": "",
                "XOffset": "" 、
                "RefWidth": "1920",
                "TemplateId": "445409ec-7eaa-4 61d-8f29-4bec2eb9 ****" 、
                "名前": "livewatermark ****"
            }
        ]
    }
}

Error codes

エラーコードのリストについては、エラーセンターをご覧ください。