All Products
Search

This Product

    ApsaraVideo Live:DescribeCasterLayouts

    Document Center

    ApsaraVideo Live:DescribeCasterLayouts

    Last Updated:Jun 10, 2026

    Mengkueri tata letak studio produksi.

    Deskripsi operasi

    Anda dapat memanggil operasi API ini untuk mengkueri tata letak studio produksi. Jika Anda tidak menentukan ID tata letak, semua tata letak studio dikembalikan.

    Batas QPS

    Batas kueri per detik (QPS) untuk operasi API ini adalah 15 panggilan per detik untuk setiap pengguna. Jika Anda melampaui batas ini, panggilan API akan dibatasi. Hal ini dapat memengaruhi bisnis Anda, jadi Anda harus memanggil operasi API ini dengan kecepatan yang wajar.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    live:DescribeCasterLayouts

    get

    *Caster

    acs:live:*:{#accountId}:caster/{#CasterId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    ID region.

    cn-shanghai
    CasterId

    string

    Yes

    ID studio produksi.

    • Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, gunakan nilai CasterId yang dikembalikan dalam respons.

    • Jika Anda membuat studio produksi di konsol LIVE, temukan ID di halaman Studio Produksi > Studio Produksi Cloud.

    Catatan

    Nama studio produksi dalam daftar di halaman Studio Produksi Cloud adalah ID studio produksi.

    LIVEPRODUCER_POST-cn-0pp1czt****
    LayoutId

    string

    No

    ID tata letak.

    Jika Anda tidak memberikan nilai untuk LayoutId, semua tata letak studio produksi akan dikembalikan.

    72d2ec7a-4cd7-4a01-974b-7cd53947****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Layouts

    object

    Layout

    array<object>

    Daftar tata letak.

    array<object>

    Daftar tata letak.

    AudioLayers

    object

    AudioLayer

    array<object>

    The list of AudioLayer configurations.

    object

    The list of AudioLayer configurations.

    FixedDelayDuration

    integer

    The fixed latency for the audio. This can be used for caption synchronization.

    Unit: milliseconds (ms). Default value: 0. Valid values: 0 to 5000.

    20
    ValidChannel

    string

    The sound channels that can be used for audio input. Valid values:

    • leftChannel: The left sound channel.

    • rightChannel: The right sound channel.

    • all (default): Both sound channels.

    all
    VolumeRate

    number

    The volume rate. A value of 1 indicates the original volume.

    Catatan

    The default value is 0. This displays the element in its original size.

    1
    BlendList

    object

    LocationId

    array

    The list of associated positions. The order is the same as that of VideoLayers.

    string

    The position ID.

    RV01
    LayoutId

    string

    The layout ID.

    72d2ec7a-4cd7-4a01-974b-7cd53947****
    MixList

    object

    LocationId

    array

    The list of associated positions. The order is the same as that of AudioLayers.

    string

    The position ID.

    RV01
    VideoLayers

    object

    VideoLayer

    array<object>

    The list of VideoLayer configurations. The default array sequence is used.

    array<object>

    The list of VideoLayer configurations. The default array sequence is used.

    FillMode

    string

    The fill mode of the element. Valid values:

    • none (default): No fill. The layer is configured based on the video frame.

    • fit: Fit. The layer is configured based on the fill area. The video frame is scaled with its original aspect ratio to fit the longer edge of the fill area and is centered. If the aspect ratio of the fill area is different from that of the video frame, the layer below is displayed in the unfilled areas. If no layer is configured below, the background is black.

    fit
    FixedDelayDuration

    integer

    The fixed latency set for the video. This can be used for caption synchronization.

    Unit: milliseconds (ms). Default value: 0. Valid values: 0 to 5000.

    20
    HeightNormalized

    number

    The normalized height of the layer element.

    • If the fill mode is none, the width of the element is scaled proportionally based on this height. The default value is 0, which means the video is displayed in its original size.

    • If the fill mode is fit, this parameter is required and must be greater than 0. It represents the normalized height of the fill area.

    0.5
    PositionNormalizeds

    object

    Position

    array

    The normalized position of the layer element in the format [x,y]. The default value is [0,0].

    Catatan

    The x and y coordinates must be normalized.

    number

    The value.

    0
    PositionRefer

    string

    The reference point for the element's position. Valid values:

    • topLeft (default): Top left.

    • topRight: Top right.

    • bottomLeft: Bottom left.

    • bottomRight: Bottom right.

    • center: Center.

    • topCenter: Top center.

    • bottomCenter: Bottom center.

    • leftCenter: Left center.

    • rightCenter: Right center.

    topLeft
    WidthNormalized

    number

    The normalized width of the layer element.

    • If the fill mode is none, the height of the element is scaled proportionally based on this width. The default value is 0, which means the video is displayed in its original size.

    • If the fill mode is fit, this parameter is required and must be greater than 0. It represents the normalized width of the fill area.

    0.5
    RequestId

    string

    ID permintaan.

    3be7ade8-d907-483c-b24a-0dad45****
    Total

    integer

    Jumlah total catatan.

    3

    Contoh

    Respons sukses

    JSONformat

    {
  "Layouts": {
    "Layout": [
      {
        "AudioLayers": {
          "AudioLayer": [
            {
              "FixedDelayDuration": 20,
              "ValidChannel": "all",
              "VolumeRate": 1
            }
          ]
        },
        "BlendList": {
          "LocationId": [
            "RV01"
          ]
        },
        "LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "MixList": {
          "LocationId": [
            "RV01"
          ]
        },
        "VideoLayers": {
          "VideoLayer": [
            {
              "FillMode": "fit",
              "FixedDelayDuration": 20,
              "HeightNormalized": 0.5,
              "PositionNormalizeds": {
                "Position": [
                  0
                ]
              },
              "PositionRefer": "topLeft",
              "WidthNormalized": 0.5
            }
          ]
        }
      }
    ]
  },
  "RequestId": "3be7ade8-d907-483c-b24a-0dad45****",
  "Total": 3
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidCasterId.Malformed %s, please check and try again later.
    401 IllegalOperation %s, please check and try again later.
    500 InternalError %s, please try again later.
    404 InvalidCaster.NotFound %s, please check and try again later.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.