All Products
Search

This Product

    ApsaraVideo Live:StartRtcCloudRecording

    Document Center

    ApsaraVideo Live:StartRtcCloudRecording

    Last Updated:Jul 17, 2026

    Memulai tugas perekaman cloud RTC.

    Deskripsi operasi

    Perekaman cloud adalah fitur berbayar. Untuk detail penagihan, lihat Biaya perekaman cloud.

    Titik akhir

    Titik akhir berikut aktif untuk operasi ini:

    WilayahID WilayahTitik akhir publik
    Shanghaicn-shanghailive.aliyuncs.com
    Singapuraap-southeast-1live.ap-southeast-1.aliyuncs.com
    AS (Virginia)us-east-1live.us-east-1.aliyuncs.com

    Batas laju

    Batas QPS pengguna individu untuk operasi ini adalah 50 panggilan per detik. Jika batas terlampaui, panggilan API akan dibatasi (throttled), yang dapat memengaruhi bisnis Anda. Panggil operasi ini sesuai kebutuhan.

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

    create

    *Semua sumber daya.

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    AppId

    string

    Yes

    ID aplikasi tempat saluran yang akan direkam berada. Aplikasi harus milik akun utama dari akun yang memanggil operasi ini.

    ********-7074-****-9ef5-85c19a4*****
    ChannelId

    string

    Yes

    ID saluran yang akan direkam. Pastikan saluran memiliki pengguna aktif saat Anda memanggil operasi ini. Jika tidak, tugas perekaman gagal dibuat.

    room1024
    SubscribeParams

    object

    Yes

    Parameter langganan.

    SubscribeUserIdList

    array<object>

    Yes

    Daftar entri UserId yang disubskripsi. Dalam mode perekaman single-stream, setiap UserId direkam secara terpisah. Dalam mode perekaman pencampuran aliran, audio dan video dari semua UserId dicampur menjadi satu set audio dan video.

    Catatan

    • Array tidak boleh kosong dan mendukung maksimal 17 elemen.

    object

    No

    Informasi tentang UserId yang disubskripsi.

    UserId

    string

    Yes

    UserId yang dilanggan.

    userA
    StreamType

    integer

    No

    Tipe media dari UserId yang dilanggan. Nilai valid:

    • 0: aliran asli, yang mencakup audio dan video. (Default)

    • 1: aliran audio saja.

    • 2: aliran video saja (hanya valid dalam mode perekaman pencampuran aliran).

    Valid values:

    • 0 :

      aliran asli, yang mencakup audio dan video.

    • 1 :

      aliran audio saja.

    • 2 :

      aliran video saja.

    0
    SourceType

    integer

    No

    Tipe aliran input video dari UserId. Parameter ini hanya valid ketika langganan bukan audio saja (StreamType != 1). Nilai valid:

    • 0: kamera. (Default)

    • 1: berbagi layar.

    Valid values:

    • 0 :

      kamera.

    • 1 :

      berbagi layar.

    0
    RecordParams

    object

    Yes

    Parameter perekaman.

    RecordMode

    integer

    Yes

    Mode perekaman. Nilai valid:

    • 0: Mode perekaman single-stream. File rekaman terpisah dibuat untuk setiap UserId yang disubskripsi.

    • 1: Mode perekaman pencampuran aliran. Aliran dari semua UserId yang disubskripsi dicampur dan ditranskode, dan hanya satu set file rekaman yang dibuat.

    Valid values:

    • 0 :

      Mode perekaman single-stream. File rekaman terpisah dibuat untuk setiap UserId yang disubskripsi.

    • 1 :

      Mode perekaman pencampuran aliran. Aliran dari semua UserId yang disubskripsi dicampur dan ditranskode, dan hanya satu set file rekaman yang dibuat.

    0
    StreamType

    integer

    No

    Tipe media dari aliran output rekaman. Nilai valid:

    • 0: aliran asli, yang mencakup audio dan video. (Default)

    • 1: aliran audio saja.

    • 2: aliran video saja.

    Valid values:

    • 0 :

      aliran asli, yang mencakup audio dan video.

    • 1 :

      aliran audio saja.

    • 2 :

      aliran video saja.

    0
    MaxFileDuration

    integer

    No

    Durasi maksimum file rekaman, dalam detik. File rekaman yang melebihi durasi ini akan dipisah. Nilainya harus berada dalam rentang [180, 7200], yaitu maksimal 2 jam. Jika tidak ditentukan, nilai default adalah 2 jam.

    7200
    StorageParams

    object

    Yes

    Parameter penyimpanan.

    StorageType

    integer

    Yes

    Metode penyimpanan. Nilai valid:

    • 0: VOD

    • 1: OSS

    Valid values:

    • 0 :

      VOD.

    • 1 :

      OSS.

    1
    FileInfo

    array<object>

    No

    Informasi penyimpanan file, yang menentukan format, lokasi penyimpanan, dan penamaan file rekaman. Parameter ini hanya valid ketika StorageType diatur ke OSS.

    Catatan

    File rekaman dibuat untuk setiap elemen dalam array berdasarkan konfigurasi yang sesuai. Jika format tidak ditentukan, format HLS digunakan secara default.

    object

    No

    Konfigurasi penyimpanan untuk setiap format file.

    Format

    string

    Yes

    Format penyimpanan file. Nilai valid:

    • HLS

    • MP4

    • MP3

    Valid values:

    • MP4 :

      Format MP4.

    • MP3 :

      Format MP3.

    • HLS :

      Format HLS.

    HLS
    FileNamePattern

    string

    No

    Format penamaan file. Anda dapat memilih dan menggabungkan variabel berikut dalam urutan apa pun:

    • AppId

    • ChannelId

    • UserId (diperlukan dalam mode single-stream; tidak valid dalam mode pencampuran aliran, di mana ia dipertahankan sebagai string {UserId} jika dipilih)

    • RecordMode

      • Ketika nilainya 0, sesuai dengan Single.

      • Ketika nilainya 1, sesuai dengan Mix.

    • SourceType

      • Dalam mode single-stream, ketika tipe aliran hanya video, parameter ini berlaku. SourceType dapat diatur ke:

        • 0: Sesuai dengan C (Camera) untuk aliran video kamera.

        • 1: Sesuai dengan S (Screen) untuk aliran video berbagi layar.

      • Dalam mode single-stream, ketika tipe aliran hanya audio, SourceType secara otomatis diatur ke A (Audio) untuk menunjukkan bahwa konten rekaman adalah aliran hanya audio.

      • Dalam mode single-stream, ketika tipe aliran adalah aliran asli, parameter ini berlaku. SourceType dapat diatur ke:

        • 0: Sesuai dengan OC (Original Camera) untuk aliran asli kamera.

        • 1: Sesuai dengan OS (Original Screen) untuk aliran asli berbagi layar.

      • Dalam skenario lain, konfigurasi SourceType tidak valid. Jika Anda mengonfigurasi SourceType secara manual, sistem mempertahankan string placeholder {SourceType}.

    • StreamType (menggunakan parameter StreamType di bawah RecordParams)

      • Ketika nilainya 0, sesuai dengan AV (Audio Video) untuk aliran audio dan video.

      • Ketika nilainya 1, sesuai dengan A (Audio) untuk aliran audio.

      • Ketika nilainya 2, sesuai dengan V (Video) untuk aliran video.

    • StartTime: pengatur waktu saat perekaman dimulai, dalam zona waktu UTC+8, dalam format mirip 2025-03-25-11:27:28. (Diperlukan ketika nilai default tidak digunakan.)

    Nilai default:

    • Mode perekaman single-stream

      • {AppId}_{ChannelId}_{UserId}_{StartTime}

      • Jika nilai StreamType atau SourceType yang berbeda disubskripsi untuk UserId yang sama, nilai defaultnya adalah {AppId}_{ChannelId}_{UserId}_{SourceType}_{StartTime}.

    • Mode perekaman pencampuran aliran

      • {AppId}_{ChannelId}_{StartTime}

    Catatan

    • String hanya dapat berisi variabel yang tercantum di atas. Nama variabel harus diapit oleh {}. Variabel dipisahkan oleh garis bawah tunggal (_). Setiap variabel dapat muncul paling banyak sekali dalam string.

    • Setelah file dinamai xxx, file disimpan dalam format mirip TaskId/xxx.m3u8, di mana TaskId adalah ID tugas yang dibuat saat tugas cloud recording dimulai dan secara otomatis ditambahkan ke jalur penyimpanan.

    {AppId}_{ChannelId}_{StartTime}_{UserId}
    SliceNamePattern

    string

    No

    Format penamaan segmen. Parameter ini hanya valid dalam format HLS. Mirip dengan FileNamePattern, kecuali bahwa variabel tambahan Sequence tersedia:

    • AppId

    • ChannelId

    • UserId (diperlukan dalam mode single-stream; tidak valid dalam mode pencampuran aliran, di mana ia dipertahankan sebagai string {UserId} jika dipilih)

    • RecordMode

      • Ketika nilainya 0, sesuai dengan Single.

      • Ketika nilainya 1, sesuai dengan Mix.

    • SourceType

      • Dalam mode single-stream, ketika tipe aliran hanya video, parameter ini berlaku. SourceType dapat diatur ke:

        • 0: Sesuai dengan C (Camera) untuk aliran video kamera.

        • 1: Sesuai dengan S (Screen) untuk aliran berbagi layar.

      • Dalam mode single-stream, ketika tipe aliran hanya audio, SourceType secara otomatis diatur ke A (Audio) untuk menunjukkan bahwa konten rekaman adalah aliran hanya audio.

      • Dalam mode single-stream, ketika tipe aliran adalah aliran asli, parameter ini berlaku. SourceType dapat diatur ke:

        • 0: Sesuai dengan OC (Original Camera) untuk aliran asli kamera.

        • 1: Sesuai dengan OS (Original Screen) untuk aliran asli berbagi layar.

      • Dalam skenario lain, konfigurasi SourceType tidak valid. Jika Anda mengonfigurasi parameter ini secara manual, sistem mempertahankan string placeholder {SourceType}.

    • StreamType (menggunakan parameter StreamType di bawah RecordParams)

      • Ketika nilainya 0, sesuai dengan AV (Audio Video) untuk aliran audio dan video.

      • Ketika nilainya 1, sesuai dengan A (Audio) untuk aliran audio.

      • Ketika nilainya 2, sesuai dengan V (Video) untuk aliran video.

    • StartTime: pengatur waktu saat perekaman dimulai, dalam zona waktu UTC+8, dalam format mirip 2025-03-25-11:27:28. (Diperlukan ketika nilai default tidak digunakan.)

    • Sequence: dalam format HLS, nama file ts berisi Sequence. Variabel ini tidak valid dalam format lain. (Diperlukan ketika nilai default tidak digunakan.)

    Nilai default:

    • Mode perekaman single-stream

      • {AppId}_{ChannelId}_{UserId}_{StartTime}_{Sequence}

      • Jika nilai StreamType atau SourceType yang berbeda disubskripsi untuk UserId yang sama, nilai defaultnya adalah {AppId}_{ChannelId}_{UserId}_{SourceType}_{StartTime}_{Sequence}.

    • Mode perekaman pencampuran aliran

      • {AppId}_{ChannelId}_{StartTime}_{Sequence}

    Catatan

    • String hanya dapat berisi variabel yang tercantum di atas. Nama variabel harus diapit oleh {}. Variabel dipisahkan oleh garis bawah tunggal (_). Setiap variabel dapat muncul paling banyak sekali dalam string.

    • Setelah segmen dinamai xxx, segmen disimpan dalam format mirip TaskId/xxx.ts, di mana TaskId adalah ID tugas yang dibuat saat tugas cloud recording dimulai dan secara otomatis ditambahkan ke jalur penyimpanan.

    {AppId}_{ChannelId}_{StartTime}_{Sequence}
    FilePathPrefix

    array

    No

    Jalur penyimpanan file. Setiap elemen dalam array sesuai dengan satu tingkat direktori. Misalnya, jika nilai parameter adalah ["dir1","dir2"], file xxx.m3u8 disimpan sebagai dir1/dir2/TaskId/xxx.m3u8. Jika parameter ini kosong, file disimpan langsung sebagai TaskId/xxx.m3u8.

    • TaskId tugas secara otomatis ditambahkan ke akhir jalur untuk mencegah file rekaman dari tugas yang berbeda tercampur.

    • Jika FilePathPrefix ditentukan, setiap elemen dalam array hanya dapat berisi huruf (a-zA-Z), digit (0-9), tanda hubung (-), dan garis bawah (_), dan tidak boleh berupa string kosong.

    • Panjang total semua tingkat direktori yang digabungkan tidak boleh melebihi 128 karakter (termasuk karakter penghubung "/", tetapi tidak termasuk TaskId yang ditambahkan secara otomatis). Misalnya, jika nilai parameter adalah ["dir1","dir2"], jalur yang digabungkan adalah "dir1/dir2/", yang berarti jumlah total karakter dalam semua elemen ditambah panjang array (sesuai dengan "/" setelah setiap tingkat direktori) tidak boleh melebihi 128.

    • Array dapat berisi maksimal 5 elemen, artinya Anda dapat menyesuaikan hingga 5 tingkat direktori.

    string

    No

    Nama setiap tingkat direktori.

    dir1
    SliceDuration

    integer

    No

    Panjang segmen, dalam detik. Parameter ini hanya valid dalam format HLS. Nilainya harus berada dalam rentang [10, 30]. (Nilai default: 30)

    Jika Anda tidak memiliki persyaratan khusus, gunakan nilai default.

    30
    OSSParams

    object

    No

    Konfigurasi penyimpanan OSS. Parameter ini diperlukan ketika metode penyimpanan adalah OSS dan tidak valid ketika metode penyimpanan adalah VOD.

    OSSEndpoint

    string

    Yes

    Titik akhir penyimpanan OSS. ID wilayah yang sesuai harus cocok dengan titik akhir yang dipilih.

    oss-cn-shanghai.aliyuncs.com
    OSSBucket

    string

    Yes

    Nama bucket OSS. Bucket harus milik akun utama dari akun yang memanggil operasi ini.

    mytest-bucket
    VodParams

    object

    No

    Konfigurasi penyimpanan VOD. Parameter ini diperlukan ketika metode penyimpanan adalah VOD dan tidak valid ketika metode penyimpanan adalah OSS.

    Catatan

    • Wilayah AS (Virginia) tidak mendukung perekaman ke VOD.

    StorageLocation

    string

    No

    Alamat penyimpanan yang dikonfigurasi di konsol video-on-demand di bawah Manajemen Aset Media > Manajemen Penyimpanan. File rekaman pertama-tama disimpan ke lokasi ini lalu diunggah ke VOD.

    Catatan

    • Parameter ini diperlukan ketika StorageType diatur ke 0 (mode VOD).

    • Pastikan wilayah alamat penyimpanan ini cocok dengan titik akhir yang dipilih.

    mytest.oss-cn-shenzhen.aliyuncs.com
    VodTranscodeGroupId

    string

    No

    ID kelompok template transkoding video-on-demand.

    Catatan

    • Parameter ini diperlukan ketika StorageType diatur ke 0 (mode VOD).

    • Pastikan wilayah ID kelompok template transkoding ini cocok dengan titik akhir yang dipilih.

    ****8a914d3989e9825eb90530b2****
    AutoCompose

    integer

    No

    Apakah akan mengaktifkan penggabungan otomatis. Nilai valid:

    • 0: Dinonaktifkan. (Default)

    • 1: Diaktifkan. Saat diaktifkan, parameter ComposeVodTranscodeGroupId harus ditentukan.

    Valid values:

    • 0 :

      Dinonaktifkan.

    • 1 :

      Diaktifkan. Saat diaktifkan, parameter ComposeVodTranscodeGroupId harus ditentukan.

    0
    ComposeVodTranscodeGroupId

    string

    No

    ID kelompok template transkoding VOD yang digunakan untuk mentranskode video baru yang disusun secara otomatis di ApsaraVideo VOD.

    Catatan

    • Parameter ini hanya diperlukan ketika AutoCompose diatur ke 1.

    • Jika hanya ada satu file Sumber daya media saat perekaman berakhir, Pemicu penggabungan otomatis tidak terjadi meskipun diaktifkan.

    • Untuk masalah umum tentang Pencampuran aliran otomatis dan transkoding, lihat FAQ Live-to-VOD.

    • Untuk detail penagihan transkoding VOD, lihat Penagihan transkoding media.

    ****4c34112cfe68248f2f77759c****
    MixTranscodeParams

    object

    No

    Parameter transkoding. Biarkan parameter ini kosong dalam mode perekaman aliran tunggal. Parameter ini diperlukan dalam mode perekaman pencampuran aliran.

    FrameFillType

    integer

    No

    Tipe pengisian frame ketika aliran terputus. Nilai valid:

    • 0: Isi dengan frame terakhir. (Default)

    Valid values:

    • 0 :

      isi dengan frame terakhir.

    0
    AudioBitrate

    integer

    Yes

    Laju bitrate audio dalam kbps. Nilainya harus berada dalam rentang [8, 500]. Parameter ini diperlukan dalam mode pencampuran aliran.

    300
    AudioChannels

    integer

    Yes

    Jumlah saluran audio. Nilai valid:

    • 1: mono.

    • 2: stereo.

    Parameter ini diperlukan dalam mode pencampuran aliran.

    Valid values:

    • 1 :

      mono.

    • 2 :

      stereo.

    2
    AudioSampleRate

    integer

    Yes

    Laju sampel audio dalam Hz. Nilai valid:

    • 8000

    • 16000

    • 32000

    • 44100

    • 48000

    Parameter ini diperlukan dalam mode pencampuran aliran.

    Valid values:

    • 8000 :

      8000HZ

    • 16000 :

      16000HZ

    • 32000 :

      32000HZ

    • 44100 :

      44100HZ

    • 48000 :

      48000HZ

    32000
    VideoCodec

    string

    No

    Pengkodean video. Nilai valid:

    • H.264 (Default)

    • H.265

    Valid values:

    • H.264 :

      Pengkodean H.264.

    • H.265 :

      Pengkodean H.265.

    H.264
    VideoBitrate

    integer

    No

    Laju bitrate video dalam kbps. Nilainya harus berada dalam rentang [1, 10000]. Parameter ini diperlukan dalam mode pencampuran aliran ketika output rekaman diharapkan mengandung video. Parameter ini tidak valid dalam kasus lain.

    5000
    VideoFramerate

    integer

    No

    Laju frame video dalam fps. Nilainya harus berada dalam rentang [1, 60]. Parameter ini diperlukan dalam mode pencampuran aliran ketika output rekaman diharapkan mengandung video. Tidak valid dalam kasus lain.

    30
    VideoGop

    integer

    No

    GOP video. I-frame ada setiap VideoGop frame. Nilainya harus berada dalam rentang [1, 60]. Parameter ini diperlukan dalam mode pencampuran aliran ketika output rekaman diharapkan mengandung video. Tidak valid dalam kasus lain.

    30
    VideoHeight

    integer

    No

    Tinggi video dalam piksel. Nilainya harus berada dalam rentang [0, 1920]. (Nilai default: 0)

    480
    VideoWidth

    integer

    No

    Lebar video dalam piksel. Nilainya harus berada dalam rentang [0, 1920]. (Nilai default: 0)

    640
    MixLayoutParams

    object

    No

    Parameter tata letak. Biarkan parameter ini kosong dalam mode perekaman aliran tunggal. Parameter ini diperlukan dalam mode perekaman pencampuran aliran ketika output rekaman diharapkan mengandung file non-audio saja.

    MixBackground

    object

    No

    Gambar latar belakang global untuk pencampuran aliran.

    RenderMode

    integer

    No

    Mode tampilan untuk output. Nilai valid:

    • 0: Crop. (Default)

    • 1: Skala dan tampilkan dengan batas hitam.

    Valid values:

    • 0 :

      potong.

    • 1 :

      Skala dan tampilkan dengan batas hitam.

    0
    Url

    string

    No

    URL gambar latar belakang. Panjang maksimal adalah 2048 karakter.

    https://xxxx.com/photos/my-test-picture.png
    UserPanes

    array<object>

    No

    Informasi tata letak jendela untuk pengguna yang disubskripsi. Hanya UserId dengan informasi tata letak yang dikonfigurasi yang ditempatkan dalam video. Parameter ini diperlukan dalam mode pencampuran aliran saat merekam file non-hanya-audio.

    array<object>

    No

    Konfigurasi jendela dalam video.

    UserId

    string

    No

    UserId yang sesuai dengan jendela ini.

    • Jika UserId tidak ditentukan, pengguna yang disubskripsi diisi ke dalam jendela sesuai urutan mereka bergabung ke saluran.

    • Kombinasi UserId dan SourceType yang ditentukan di sini harus disertakan dalam SubscribeUserIdList.

    • Langganan hanya audio tidak dapat ditambahkan ke tata letak.

    userA
    SourceType

    integer

    No

    Tipe aliran input video dari UserId. Mengatur SourceType tidak valid ketika UserId tidak ditentukan. Nilai valid:

    • 0: kamera. (Default)

    • 1: berbagi layar.

    Kombinasi UserId dan SourceType yang ditentukan di sini harus disertakan dalam SubscribeUserIdList.

    Valid values:

    • 0 :

      kamera.

    • 1 :

      berbagi layar.

    0
    Height

    string

    No

    Tinggi panel sebagai persentase ternormalisasi. Nilainya harus berada dalam rentang [0, 1]. (Nilai default: 0)

    0.5
    Width

    string

    No

    Lebar panel sebagai persentase ternormalisasi. Nilainya harus berada dalam rentang [0, 1]. (Nilai default: 0)

    0.5
    X

    string

    No

    Koordinat X sebagai persentase ternormalisasi. Nilainya harus berada dalam rentang [0, 1]. (Nilai default: 0)

    0
    Y

    string

    No

    Koordinat Y sebagai persentase ternormalisasi. Nilainya harus berada dalam rentang [0, 1]. (Nilai default: 0)

    0
    ZOrder

    integer

    No

    Urutan penumpukan. 0 adalah lapisan bawah, lapisan 1 berada di atas lapisan 0, dan seterusnya. (Nilai default: 0)

    0
    SubBackground

    object

    No

    Gambar latar belakang sub-panel. Ketika pengguna mematikan kamera, belum memulai pengambilan aliran setelah bergabung, atau meninggalkan saluran di tengah jalan, gambar yang sesuai ditampilkan di posisi tata letak.

    RenderMode

    integer

    No

    Mode tampilan untuk output sub-pane. Nilai valid:

    • 0: Crop. (Default)

    • 1: Skala dan tampilkan dengan batas hitam.

    Valid values:

    • 0 :

      potong.

    • 1 :

      skala dan tampilkan dengan batas hitam.

    0
    Url

    string

    No

    URL gambar latar belakang. Panjang maksimal adalah 2048 karakter.

    https://xxxx.com/photos/my-test-pane-picture.png
    NotifyUrl

    string

    No

    URL untuk menerima Paket callback. Pesan status tugas dikirim ke URL ini melalui POST dalam format JSON. Panjang maksimal adalah 2048 karakter.

    Untuk detail Paket callback, lihat Dokumentasi.

    http://xxxx/test/mycallback
    NotifyAuthKey

    string

    No

    Kunci otentikasi untuk Paket callback. Jika tidak ditentukan, tidak ada otentikasi yang dilakukan. Jika ditentukan, panjangnya harus berada dalam rentang [16, 64] karakter dan hanya berisi huruf besar, huruf kecil, dan digit.

    • Jika NotifyUrl tidak ditentukan, NotifyAuthKey juga tidak valid.

    • Ketika NotifyAuthKey yang valid diatur, konten otentikasi disertakan dalam Paket callback.

    mytestkeymytestkey
    NotifyFileUploadedFormat

    array

    No

    Format yang ditentukan di mana Paket callback dikirim ketika event pembuatan file rekaman (RecordFileUploaded) dipicu.

    string

    No

    Format file spesifik di mana callback diterima. Nilai valid (tidak peka huruf besar/kecil):

    • SLICE

    • HLS

    • MP4

    • MP3

    Mode penyimpanan VOD tidak didukung. Untuk mode penyimpanan OSS, format yang dipilih harus disertakan dalam format file yang ditentukan di StorageParams.FileInfo.

    MP4
    MaxIdleTime

    integer

    No

    Periode pengatur waktu tunggu idle. Ketika tugas tetap idle lebih lama dari MaxIdleTime, tugas secara otomatis dihentikan. Unit: detik. Nilainya harus berada dalam rentang [10, 14400], yaitu maksimal 4 jam. (Nilai default: 300 detik)

    • Dalam mode perekaman pencampuran aliran, tugas dianggap idle ketika semua aliran pengguna yang disubskripsi berhenti melakukan pengambilan aliran.

    • Dalam mode perekaman single-stream, aliran yang disubskripsi saling independen. Ketika aliran apa pun berhenti melakukan pengambilan aliran, aliran tersebut dianggap idle. Setelah MaxIdleTime tercapai, perekaman untuk aliran tersebut dihentikan. Ketika semua aliran yang disubskripsi telah mencapai waktu tunggu karena idle, seluruh tugas cloud recording dihentikan.

    600

    • Dalam mode perekaman single-stream:

      • Anda dapat menyubskripsi aliran kamera dan berbagi layar dari UserId yang sama secara bersamaan, tetapi parameter FileNamePattern dan SliceNamePattern harus menyertakan variabel SourceType untuk mencegah file rekaman saling menimpa.

      • Menyubskripsi hanya aliran hanya video dari UserId tidak didukung. Dalam mode single-stream, UserInfo.StreamType tidak dapat diatur ke 2.

    • Dalam mode perekaman aliran tunggal:

      • Jika RecordParams.StreamType diatur ke audio saja (nilai 1), SubscribeParams tidak boleh berisi langganan video saja (nilai SubscribeParams 2).

      • Jika RecordParams.StreamType diatur ke video saja (nilai 2), SubscribeParams tidak boleh berisi langganan audio saja (nilai SubscribeParams 1).

    • Dalam mode perekaman pencampuran aliran:

      • Jika RecordParams.StreamType diatur ke audio saja (nilai 1), tidak semua UserId di SubscribeParams dapat dilanggan ke video saja (semua nilai SubscribeParams diatur ke 2).

      • Jika RecordParams.StreamType diatur ke video saja (nilai 2), tidak semua UserId di SubscribeParams dapat dilanggan ke audio saja (semua nilai SubscribeParams diatur ke 1).

    • Selama perekaman, jika saluran ditutup di tengah jalan, pengguna harus bergabung kembali dan melanjutkan pengambilan aliran dalam periode pengatur waktu tunggu idle. Jika tidak, tugas secara otomatis dihentikan.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter tanggapan.

    RequestId

    string

    ID permintaan.

    ******58-5876-****-83CA-B56278******
    TaskId

    string

    ID tugas.

    ******73-8501-****-8ac1-72295a******

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "******58-5876-****-83CA-B56278******",
  "TaskId": "******73-8501-****-8ac1-72295a******"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter.NotifyUrl %s, please check the notifyUrl. Format parameter NotifyUrl tidak valid. Periksa parameter tersebut.
    400 InvalidParameter.StorageParams.FileInfo %s, please check the fileInfo of storageParams. Parameter FileInfo berisi bidang tidak valid. Periksa parameter tersebut.
    400 InvalidParameter.StorageParams.OSSParams %s, please check the ossParams of storageParams. Parameter OSSParams berisi bidang tidak valid. Periksa parameter tersebut.
    400 NotFound.OSSBucket %s, please check the ossBucket of storageParams. OSSBucket yang ditentukan tidak ada.
    400 InvalidParameter.SubscribeParams.SubscribeUserIdList %s, please check the subscribeUserIdList of subscribeParams. Parameter SubscribeUserIdList tidak valid. Periksa parameter tersebut.
    400 InvalidParameter.MixLayoutParams.UserPanes %s, please check the userPanes of mixLayoutParams. Parameter UserPanes berisi bidang tidak valid. Periksa parameter tersebut.
    400 InvalidParameter.MixTranscodeParams %s, please check the transcodeParams. Parameter MixTranscodeParams berisi bidang tidak valid. Periksa parameter tersebut.
    400 MissingParameter %s. Parameter yang diperlukan hilang.
    403 InvalidParameter.UserId %s, please check the UserId. Parameter UserId tidak valid. Periksa parameter tersebut.
    403 QuotaExceed.RunningTask The number of active cloud recording tasks has reached the limit. Jumlah tugas Catatan cloud aktif telah mencapai batas atas.
    404 InvalidParameter.ChannelId %s, please check the channelId.
    404 InvalidParameter.AppId %s, please check the appId. Parameter AppId tidak valid. Periksa nilai parameter.
    405 InvalidParameter.StorageParams.VodParams %s, please check the vodParams of storageParams.
    405 InvalidParameter.NotifyAuthKey %s, please check the notifyAuthKey.
    405 InvalidParameter.MaxIdleTime %s, please check the maxIdleTime.
    405 InvalidParameter.RecordParams %s, please check the recordParams.
    405 InvalidParameter.StorageParams.StorageType %s, please check the storageType of storageParams. Parameter StorageType tidak valid. Periksa nilai parameter.
    405 InvalidParameter.NotifyFileUploadedFormat %s, please check the notifyFileUploadedFormat. Parameter NotifyFileUploadedFormat tidak valid. Periksa nilai parameter.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.