All Products
Search

This Product

    ApsaraVideo Live:DescribeCasterComponents

    Document Center

    ApsaraVideo Live:DescribeCasterComponents

    Last Updated:Dec 24, 2025

    Mengambil daftar komponen untuk studio produksi.

    Deskripsi operasi

    Panggil operasi AddCasterComponent untuk menambahkan komponen ke studio produksi, lalu gunakan operasi ini untuk mengambil daftar komponen tersebut.

    Batas QPS

    Batas permintaan per detik (QPS) untuk satu pengguna adalah 15. Jika batas ini dilampaui, panggilan API akan dikenai pengendalian aliran (throttled), yang dapat memengaruhi bisnis Anda. Pastikan Anda memanggil operasi ini dalam batas yang ditentukan.

    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:DescribeCasterComponents

    get

    *Caster

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    ID wilayah.

    cn-shanghai
    CasterId

    string

    Yes

    ID studio produksi.

    • Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, ambil ID dari parameter CasterId dalam respons.

    • Jika Anda membuat studio produksi di konsol LIVE, buka halaman Cloud Production Studio melalui LIVE Console > Production Studio > Cloud Production Studio.

    Catatan

    Nama studio produksi dalam daftar pada halaman Cloud Production Studio adalah ID studio produksi tersebut.

    LIVEPRODUCER_POST-cn-0pp1czt****
    ComponentId

    string

    No

    ID komponen. Jika Anda menambahkan komponen dengan memanggil operasi AddCasterComponent, ambil ID dari parameter ComponentId dalam respons.

    21926b36-7dd2-4fde-ae25-51b5bc8e****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Components

    object

    Component

    array<object>

    Daftar komponen.

    array<object>

    CaptionLayerContent

    object

    Properti elemen teks terjemahan (caption).

    BorderColor

    string

    Warna garis tepi teks.

    Nilai yang valid: 0x000000 hingga 0xffffff. Nilai default adalah string kosong (""), yang berarti parameter ini tidak digunakan.

    0x000000
    BorderWidthNormalized

    number

    Lebar garis tepi teks yang dinormalisasi. Nilainya dihitung berdasarkan ukuran font: BorderWidth/FontSize.

    Jika nilai yang dihitung melebihi 16, maka nilai 16 yang digunakan. Nilai default: 0.

    0
    Color

    string

    Warna teks. Nilai yang valid: 0x000000 hingga 0xffffff.

    0x000000
    FontName

    string

    Font. Nilainya harus merupakan nilai preset. Nilai yang valid:

    • KaiTi: KaiTi

    • AlibabaPuHuiTi-Regular: Alibaba PuHuiTi Regular

    • AlibabaPuHuiTi-Bold: Alibaba PuHuiTi Bold

    • NAlibabaPuHuiTi-Light: Alibaba PuHuiTi Light

    • NotoSansHans-Regular: Noto Sans CJK Regular

    • NotoSansHans-Bold: Noto Sans CJK Bold

    • NotoSansHans-Light: Noto Sans CJK Light

    Nilai default: KaiTi.

    KaiTi
    LineSpaceNormalized

    number

    Jarak antar baris. Parameter ini menentukan spasi antara dua baris teks. Nilai default: 0.

    0
    LocationId

    string

    Jika tipe komponen adalah caption, parameter ini menentukan lokasi sumber video yang dirujuk (ID channel).

    RV01
    PtsOffset

    integer

    Nilai yang digunakan untuk mengoreksi deviasi antara presentation timestamp (PTS) caption dan PTS audio.

    Nilai yang valid: -10000 hingga +10000. Nilai default: 0.

    0
    ShowSourceLan

    boolean

    Menentukan apakah bahasa sumber ditampilkan. Nilai yang valid:

    • true: Bahasa sumber ditampilkan.

    • false (default): Bahasa sumber tidak ditampilkan.

    false
    SizeNormalized

    number

    Ukuran font yang dinormalisasi. Ukuran font diatur ke [font_size,output_height].

    Jika ukuran font yang dihitung lebih besar dari 1024, maka nilai 1024 yang digunakan. Nilai default adalah -1, yang berarti parameter ini tidak digunakan.

    0.1
    SourceLan

    string

    Bahasa sumber audio sumber video. Nilai yang valid:

    • en: Inggris

    • cn (default): Tiongkok

    • es: Spanyol

    • ru: Rusia

    cn
    TargetLan

    string

    Bahasa target audio sumber video. Nilai yang valid:

    • en: Inggris

    • cn (default): Tiongkok

    • es: Spanyol

    • ru: Rusia

    cn
    WordCountPerLine

    integer

    Jumlah maksimum karakter yang ditampilkan per baris.

    15
    WordSpaceNormalized

    number

    Jarak antar karakter. Parameter ini menentukan spasi antara dua karakter. Nilai default: 0.

    0
    WordsCount

    integer

    Jumlah karakter yang ditampilkan. Anda dapat menyesuaikan nilai ini bersama dengan ukuran font.

    Nilai yang valid: 10 hingga 50. Nilai default: 35.

    35
    ComponentId

    string

    ID komponen.

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

    object

    Ukuran, tata letak, dan informasi lainnya mengenai layer komponen.

    HeightNormalized

    number

    Tinggi elemen layer yang dinormalisasi. Lebar elemen diskalakan secara proporsional berdasarkan tinggi ini.

    Nilai default adalah 0, yang berarti elemen ditampilkan dalam ukuran aslinya.

    0.5
    PositionNormalizeds

    object

    Position

    array

    Koordinat elemen layer yang dinormalisasi, dalam format [x,y]. Nilai default: [0,0].

    Catatan

    Nilai x dan y harus dinormalisasi.

    number

    Nilai.

    0.3
    PositionRefer

    string

    Titik referensi untuk posisi elemen. Nilai yang valid:

    • topLeft (default): Sudut kiri atas.

    • topRight: Sudut kanan atas.

    • bottomLeft: Sudut kiri bawah.

    • bottomRight: Sudut kanan bawah.

    topLeft
    Transparency

    integer

    Transparansi layer. Nilai yang valid: 0 hingga 255.

    Nilai 0 menunjukkan bahwa layer sepenuhnya transparan. Nilai 255 (default) menunjukkan bahwa layer sepenuhnya buram.

    200
    WidthNormalized

    number

    Lebar elemen layer yang dinormalisasi. Tinggi elemen diskalakan secara proporsional berdasarkan lebar ini. Nilai default adalah 0, yang berarti elemen ditampilkan dalam ukuran aslinya.

    Catatan

    Parameter ini bertentangan dengan HeightNormalized. Jika keduanya diatur, hanya HeightNormalized yang berlaku. Jika Anda mengatur salah satu saja, nilai yang diatur terakhir akan menggantikan nilai sebelumnya.

    0.5
    ComponentName

    string

    Nama komponen. Nilai default adalah ID komponen.

    component_name
    ComponentType

    string

    Tipe komponen. Nilai yang valid:

    • text: Komponen teks.

    • image: Komponen citra.

    • caption: Komponen teks terjemahan.

    text
    Effect

    string

    Efek tampilan komponen. Nilai yang valid:

    • none: Tanpa efek.

    • animateH: Gulir horizontal.

    • animateV: Gulir vertikal.

    animateV
    ImageLayerContent

    object

    Properti elemen citra.

    MaterialId

    string

    ID aset media.

    6cf724c6ebfd4a59b5b3cec6f10d****
    LocationId

    string

    Posisi komponen.

    Anda hanya dapat mengatur satu komponen untuk setiap posisi. Formatnya harus "RC01" hingga "RC12".

    RC01
    TextLayerContent

    object

    Properti elemen teks.

    BorderColor

    string

    Warna garis tepi teks. Nilai yang valid: 0x000000 hingga 0xffffff. Nilai default adalah string kosong (""), yang berarti parameter ini tidak digunakan.

    0x000000
    BorderWidthNormalized

    number

    Lebar garis tepi teks yang dinormalisasi. Nilainya dihitung berdasarkan ukuran font: BorderWidth/FontSize.

    Jika nilai yang dihitung melebihi 16, maka nilai 16 yang digunakan. Nilai default: 0.

    0
    Color

    string

    Warna teks. Nilai yang valid: 0x000000 hingga 0xffffff.

    0xff0000
    FontName

    string

    Font. Nilainya harus merupakan nilai preset. Nilai yang valid:

    • KaiTi: KaiTi

    • AlibabaPuHuiTi-Regular: Alibaba PuHuiTi Regular

    • AlibabaPuHuiTi-Bold: Alibaba PuHuiTi Bold

    • NAlibabaPuHuiTi-Light: Alibaba PuHuiTi Light

    • NotoSansHans-Regular: Noto Sans CJK Regular

    • NotoSansHans-Bold: Noto Sans CJK Bold

    • NotoSansHans-Light: Noto Sans CJK Light

    Nilai default: KaiTi.

    KaiTi
    SizeNormalized

    number

    Ukuran font yang dinormalisasi.

    Ukurannya diatur ke font_size/output_height. Jika ukuran font yang dihitung lebih besar dari 1024, maka nilai 1024 yang digunakan. Nilai default adalah -1, yang berarti parameter ini tidak digunakan.

    16
    Text

    string

    Konten teks.

    hello world
    RequestId

    string

    ID permintaan.

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

    integer

    Jumlah total catatan.

    3

    Contoh

    Respons sukses

    JSONformat

    {
  "Components": {
    "Component": [
      {
        "CaptionLayerContent": {
          "BorderColor": "0x000000",
          "BorderWidthNormalized": 0,
          "Color": "0x000000",
          "FontName": "KaiTi",
          "LineSpaceNormalized": 0,
          "LocationId": "RV01",
          "PtsOffset": 0,
          "ShowSourceLan": false,
          "SizeNormalized": 0.1,
          "SourceLan": "cn",
          "TargetLan": "cn",
          "WordCountPerLine": 15,
          "WordSpaceNormalized": 0,
          "WordsCount": 35
        },
        "ComponentId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "ComponentLayer": {
          "HeightNormalized": 0.5,
          "PositionNormalizeds": {
            "Position": [
              0.3
            ]
          },
          "PositionRefer": "topLeft",
          "Transparency": 200,
          "WidthNormalized": 0.5
        },
        "ComponentName": "component_name",
        "ComponentType": "text",
        "Effect": "animateV",
        "ImageLayerContent": {
          "MaterialId": "6cf724c6ebfd4a59b5b3cec6f10d****"
        },
        "LocationId": "RC01",
        "TextLayerContent": {
          "BorderColor": "0x000000",
          "BorderWidthNormalized": 0,
          "Color": "0xff0000",
          "FontName": "KaiTi",
          "SizeNormalized": 16,
          "Text": "hello world"
        }
      }
    ]
  },
  "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.