All Products
Search

This Product

    ApsaraVideo Live:SetCasterConfig

    Document Center

    ApsaraVideo Live:SetCasterConfig

    Last Updated:Jun 10, 2026

    Mengonfigurasi studio produksi secara detail, termasuk nama, konfigurasi transkoding, konfigurasi Catatan, dan parameter lain dari studio produksi.

    Deskripsi operasi

    You must call the CreateCaster operation to create a production studio before you call this operation. This operation replaces all existing configurations. If you set a parameter to an empty value, the existing configuration for that parameter is cleared.

    QPS limit

    The queries per second (QPS) limit for a single user is 10 calls per second. API calls that exceed this limit are throttled, which 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:SetCasterConfig

    update

    *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, gunakan nilai CasterId yang dikembalikan dalam tanggapan.

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

    Catatan

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

    a2b8e671-2fe5-4642-a2ec-bf93880e****
    CasterName

    string

    No

    Nama studio produksi.

    liveCaster****
    DomainName

    string

    No

    Domain streaming untuk Streamer aliran.

    Konfigurasikan nama domain sebelum Anda memulai studio produksi. Jika Anda mengosongkan parameter ini, konfigurasi nama domain studio produksi akan dihapus.

    example.com
    TranscodeConfig

    string

    No

    Konfigurasi transkoding.

    String JSON. Field dalam struct harus dalam format UpperCamelCase. Jika Anda mengosongkan parameter ini, konfigurasi transkoding akan dihapus. Jika tidak ada template transkoding yang ditentukan, error akan dilaporkan saat Anda memulai studio produksi.

    {"casterTemplate": "lp_ld"}
    RecordConfig

    string

    No

    Konfigurasi Catatan. Parameter ini berupa string JSON. Elemen dijelaskan sebagai berikut:

    • endpoint: Titik akhir API dari layanan Alibaba Cloud.

    • ossBucket: Nama Bucket OSS.

    • videoFormat: format file video yang dapat diekspor. Contoh: [{\"OssObjectPrefix\":\"record/{AppName}/{NamaStream}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{NamaStream}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{NamaStream}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}].

    • interval: Interval pengatur waktu. Unit: milidetik (ms).

    Catatan

    Jika Anda mengosongkan parameter ini, fitur Catatan dinonaktifkan dan konfigurasi Catatan yang ada dihapus.

    { "endpoint": "http://oss-cn-********.aliyuncs.com/api", "ossBucket****": "liveBucket****", "VideoFormat":[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}] "interval": 5 }
    Delay

    number

    No

    Penundaan aliran. Unit: detik.

    • 0 (default): Menonaktifkan penundaan aliran.

    • Nilai lebih besar dari 0: Mengaktifkan penundaan aliran.

    • Kosong: Menghapus konfigurasi penundaan aliran.

    Catatan

    Nilai maksimum adalah 300.

    0
    UrgentMaterialId

    string

    No

    ID Video cadangan, yang merupakan Aset media. Jika Anda mengosongkan parameter ini, konfigurasi Video cadangan akan dihapus.

    a2b8e671
    UrgentLiveStreamUrl

    string

    No

    URL aliran live cadangan.

    rtmp://demo.aliyundoc.com
    SideOutputUrl

    string

    No

    URL ingest kustom untuk output bypass dari studio produksi. Jika Anda mengosongkan parameter ini, sistem menggunakan URL ingest yang dibuat secara otomatis untuk output.

    Catatan

    Parameter SideOutputUrl hanya mendukung pengambilan aliran melalui RTMP.

    rtmp://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
    SideOutputUrlList

    string

    No

    Daftar URL ingest untuk pengambilan aliran multi-saluran. URL dapat berupa URL ingest dari Alibaba Cloud CDN atau CDN pihak ketiga. Anda dapat menambahkan hingga 20 URL ingest RTMP untuk satu studio produksi.

    Catatan

    Tentukan beberapa URL dalam sebuah array. Contoh: ["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"].

    rtmp://domain/app/stream?***
    CallbackUrl

    string

    No

    Alamat webhook. Untuk menerima notifikasi callback, masukkan alamat valid yang menerima permintaan HTTP dengan format yang valid. Jika Anda mengosongkan parameter ini, notifikasi callback untuk studio produksi dibatalkan.

    Catatan

    Untuk informasi lebih lanjut tentang callback studio produksi, lihat Informasi callback untuk studio produksi.

    http://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
    ProgramEffect

    integer

    No

    Apakah carousel efektif.

    • 0: Tidak efektif.

    • 1: Efektif.

    1
    ProgramName

    string

    No

    Nama carousel. Anda dapat mengonfigurasi parameter ini saat menggunakan fitur carousel.

    program_name
    ChannelEnable

    integer

    No

    Apakah akan mengaktifkan saluran.

    • 0 (default): Menonaktifkan saluran.

    • 1: Mengaktifkan saluran.

    Catatan

    Secara default, fitur ini dinonaktifkan. Setelah Anda mengaktifkan fitur ini, Anda tidak dapat menonaktifkannya. Jika saluran dinonaktifkan, Sumber daya direferensikan langsung oleh tata letak. Untuk mengaktifkan saluran untuk pertama kalinya (pengatur waktu pertama), studio produksi harus dalam status Stopped. Tata letak yang ada akan dibuang. Anda harus terlebih dahulu menambahkan Sumber daya ke saluran. Tata letak baru langsung mereferensikan saluran. Anda dapat menggunakan saluran untuk menyesuaikan progres pemutaran dan status Sumber video. Dalam mode ini, jika area Sumber video, Tampilan Preview (PVW), dan Program (PGM) mereferensikan Sumber daya yang sama, layar mereka tetap sinkron.

    1
    SyncGroupsConfig

    string

    No

    Konfigurasi untuk sinkronisasi multi-tampilan, yang menyinkronkan beberapa Sumber video. Sinkronisasi multi-tampilan memiliki dua mode:

    • mode: 0 (mode Streamer. Beberapa Sumber video disinkronkan berdasarkan mode yang ditentukan.)

    • mode: 1 (mode Konferensi. Semua Sumber video saling disinkronkan satu sama lain. Tidak ada konsep video Streamer aliran.)

    Mode Streamer: Parameter hostResourceId menentukan Sumber video dari Streamer aliran.

    Mode Konferensi: Parameter hostResourceId tidak digunakan. Anda hanya perlu menyediakan ID Sumber daya pada parameter resourceIds.

    "[{\"mode\":0,\"resourceIds\":[\"5a6c1c33-8424-46f6-813c-c152220a****\",\"4e6521dc-a40a-4077-b6bf-1fb12a76****\"],\"hostResourceId\":\"3aa2b39a-fd0e-4b8c-be73-b7af31c4****\"}]"
    UrgentImageId

    string

    No

    ID gambar cadangan, yang merupakan Aset media.

    a089175eb5f4427684fc0715159a****
    UrgentImageUrl

    string

    No

    URL gambar cadangan.

    http://learn.aliyundoc.com/AppName/image.jpg
    AutoSwitchUrgentOn

    boolean

    No

    Apakah akan mengaktifkan Alih otomatis ke Sumber daya cadangan.

    • true: Mengaktifkan.

    • false: Menonaktifkan.

    true
    AutoSwitchUrgentConfig

    string

    No

    Konfigurasi untuk Alih otomatis ke Sumber daya cadangan. eofThres: periode pengatur waktu setelah sistem otomatis beralih ke Sumber daya cadangan jika aliran terputus. Unit: detik.

    {"eofThres":3}

    Elemen respons

    Element

    Type

    Description

    Example

    object

    CasterId

    string

    The ID of the production studio. You can use this ID to query ingest URLs, start the studio, add video resources, add layouts, query layouts, add components, and add playlists.

    b4810848-bcf9-4aef-bd4a-e6bba2d9****
    RequestId

    string

    The request ID.

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

    Contoh

    Respons sukses

    JSONformat

    {
  "CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
  "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 InvalidParameter.Malformed There are invalid parameters: %s.
    400 IncorrectCasterStatus.Inuse %s, please check and try again later.
    400 MissingParameter %s.
    400 InvalidCaster.ChannelDisableUnsupported %s, please check.
    400 IncorrectCasterStatus.EnableChannel %s, please check and try again later.
    403 PermissionDenied %s, please check and try again later.
    404 InvalidCaster.NotFound %s, please check and try again later.
    404 InvalidDomainName.NotFound %s, please check and try again later.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.