All Products
Search

This Product

    ApsaraVideo Live:AddCasterComponent

    Document Center

    ApsaraVideo Live:AddCasterComponent

    Last Updated:Jun 10, 2026

    Menambahkan komponen ke studio produksi.

    Deskripsi operasi

    Before calling this operation, create a production studio and review its layout list. This operation adds components such as images, text, and captions. For more information about creating a production studio using an API call, see Create a production studio.

    QPS limit

    The queries per second (QPS) limit for a single user is 10. If you exceed this limit, API calls are throttled. This may affect your business. Plan your calls accordingly.

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

    create

    *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, cari ID di parameter CasterId pada tanggapan.

    • Jika Anda membuat studio produksi di konsol ApsaraVideo Live, buka halaman Konsol ApsaraVideo Live > Studio Produksi > Studio Produksi Cloud untuk menampilkan ID.

    Catatan

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

    LIVEPRODUCER_POST-cn-0pp1czt****
    ComponentName

    string

    No

    Nama komponen. Nilai default adalah ID komponen.

    text01
    LocationId

    string

    Yes

    Menentukan posisi komponen. Setiap posisi hanya dapat memuat satu komponen. Format harus RC01 hingga RC99.

    Catatan

    Jika tipe komponen adalah caption, parameter ini menentukan lokasi sumber video yang dijadikan Tampilan.

    RC01
    ComponentType

    string

    Yes

    Tipe komponen. Nilai valid:

    • text: Komponen teks. Jika Anda mengatur parameter ini ke text, Anda juga harus mengatur parameter TextLayerContent.

    • image: Komponen gambar. Jika Anda mengatur parameter ini ke image, Anda juga harus mengatur parameter ImageLayerContent.

    • caption: Komponen caption. Jika Anda mengatur parameter ini ke caption, Anda juga harus mengatur parameter CaptionLayerContent.

    text
    Effect

    string

    No

    Efek tampilan komponen. Nilai valid:

    • none (default): Tanpa efek.

    • animateH: Bergulir secara horizontal.

    • animateV: Bergulir secara vertikal.

    animateH
    ComponentLayer

    string

    Yes

    Ukuran, tata letak, dan informasi lain tentang layer komponen. Elemennya dijelaskan sebagai berikut:

    • HeightNormalized: Tinggi yang dinormalisasi.

    • WidthNormalized: Lebar yang dinormalisasi.

    • PositionNormalized: Posisi elemen layer yang dinormalisasi.

    • PositionRefer: Koordinat referensi untuk posisi elemen.

    Nilai berupa string berformat JSON. Nama parameter harus dalam upper-camel case.

    {"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}
    LayerOrder

    string

    No

    Pesanan layer komponen.

    • cover: Komponen berada di latar depan.

    • background: Komponen berada di latar belakang.

    cover
    TextLayerContent

    string

    No

    Properti elemen layer. Properti dijelaskan sebagai berikut:

    Penting Parameter ini hanya wajib jika ComponentType diatur ke text.

    • SizeNormalized: Ukuran font yang dinormalisasi. Nilai ini dihitung sebagai ukuran font / tinggi output. Nilai harus berada dalam rentang [0,1]. Jika ukuran font yang dihitung dari nilai yang dinormalisasi lebih besar dari 1024, ukuran font diatur ke 1024.

    • BorderWidthNormalized: Lebar border teks yang dinormalisasi. Nilai ini dihitung berdasarkan ukuran font: BorderWidth / FontSize. Nilai harus berada dalam rentang [0,1]. Jika lebar yang dihitung dari nilai yang dinormalisasi lebih besar dari 16, lebar diatur ke 16. Nilai default adalah 0.

    • FontName: Nama font. Untuk nilai valid, lihat Font studio produksi. Font default adalah KaiTi.

    • BorderColor: Warna border teks. Nilai harus berupa kode warna heksadesimal dalam Pesanan 0x000000 hingga 0xffffff. Nilai default adalah string kosong (""), yang menunjukkan bahwa tidak ada warna border yang diatur.

    • Text: Konten teks. Nilai default adalah string kosong ("").

    • Color: Warna teks. Nilai default adalah 0xff0000, yang merepresentasikan warna merah.

    Nilai harus berupa string berformat JSON. Nama parameter harus dalam upper-camel case.

    {"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}
    ImageLayerContent

    string

    No

    Properti elemen layer. Properti dijelaskan sebagai berikut:

    Penting

    Parameter ini wajib jika ComponentType diatur ke image.

    MaterialId: ID aset media. Nama yang Anda tentukan saat mengunggah aset media digunakan sebagai ID aset media.

    Nilai harus berupa string berformat JSON. Nama parameter harus dalam upper-camel case.

    {"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d****"}
    CaptionLayerContent

    string

    No

    Properti elemen layer. Properti dijelaskan sebagai berikut:

    Penting Parameter ini wajib jika ComponentType diatur ke caption.

    • SizeNormalized: Ukuran font yang dinormalisasi. Nilai ini dihitung sebagai ukuran font / tinggi output. Nilai harus berada dalam rentang [0,1] dan akurat hingga dua desimal. Jika ukuran font yang dihitung dari nilai yang dinormalisasi lebih besar dari 1024, ukuran font diatur ke 1024.

    • BorderWidthNormalized: Lebar border teks yang dinormalisasi. Nilai ini dihitung berdasarkan ukuran font: BorderWidth / FontSize. Nilai harus berada dalam rentang [0,1] dan akurat hingga dua desimal. Jika lebar yang dihitung dari nilai yang dinormalisasi lebih besar dari 16, lebar diatur ke 16. Nilai default adalah 0.

    • FontName: Nama font. Untuk nilai valid, lihat Font studio produksi. Font default adalah KaiTi.

    • BorderColor: Warna border teks. Nilai harus berupa kode warna heksadesimal dalam Pesanan 0x000000 hingga 0xffffff. Nilai default adalah string kosong (""), yang menunjukkan bahwa tidak ada warna border yang diatur.

    • LocationId: ID saluran sumber terjemahan.

    • SourceLan: Bahasa audio asli sumber video. Nilai valid: en (Inggris), cn (Mandarin), es (Spanyol), dan ru (Rusia). Nilai default adalah cn.

    • TargetLan: Bahasa audio target untuk sumber video. Jika Anda tidak mengatur parameter ini, hanya pengenalan ucapan yang dilakukan. Jika Anda mengatur parameter ini, audio diterjemahkan. Nilai valid: en (Inggris), cn (Mandarin), es (Spanyol), dan ru (Rusia).

    • ShowSourceLan: Apakah akan menampilkan bahasa sumber. Nilai valid: true dan false. Nilai default adalah false.

    • Truncation: Apakah caption dapat dipotong. Nilai valid: true dan false. Nilai default adalah false.

    • SourceLanPerLineWordCount: Jumlah maksimum kata per baris untuk caption bahasa sumber. Nilai default adalah 20.

    • TargetLanPerLineWordCount: Jumlah maksimum kata per baris untuk caption bahasa target. Nilai default adalah 20.

    • SourceLanReservePages: Jumlah baris yang dicadangkan untuk caption bahasa sumber. Parameter ini hanya berlaku jika Truncation diatur ke true. Nilai default adalah 2.

    • TargetLanReservePages: Jumlah baris yang dicadangkan untuk caption bahasa target. Parameter ini hanya berlaku jika Truncation diatur ke true. Nilai default adalah 2.

    Nilai harus berupa string berformat JSON. Nama parameter harus dalam upper-camel case.

    {"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"}
    HtmlLayerContent

    string

    No

    Konfigurasi komponen H5.

    {"htmlUrl":http://caster.example.com}

    Font studio produksi

    FontNilai FontName
    KaiTiKaiTi
    Alibaba PuHuiTi - RegularAlibabaPuHuiTi-Regular
    Alibaba PuHuiTi - BoldAlibabaPuHuiTi-Bold
    Alibaba PuHuiTi - LightAlibabaPuHuiTi-Light
    Source Han Sans - RegularNotoSansHans-Regular
    Source Han Sans - BoldNotoSansHans-Bold
    Source Han Sans - LightNotoSansHans-Light

    Elemen respons

    Element

    Type

    Description

    Example

    object

    ComponentId

    string

    The component ID. Use this ID to query, modify, or delete the component.

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

    string

    The request ID.

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    Contoh

    Respons sukses

    JSONformat

    {
  "ComponentId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidUserId.Malformed %s, please check userId.
    400 InvalidCasterId.Malformed %s, please check and try again later.
    400 MissingParameter %s.
    400 InvalidParameter.Malformed There are invalid parameters: %s.
    400 InvalidPositionNormalized.Malformed %s, please check and try again later.
    400 DuplicateLocationID %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.
    404 CanvasNotExist %s, please check and try again later.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.