Callback studio produksi - ApsaraVideo Live

Topik ini menjelaskan parameter permintaan callback studio produksi serta menyediakan contoh callback tersebut.

Parameter permintaan

Parameter	Tipe	Diperlukan	Deskripsi
CasterId	String	Tidak	ID studio produksi. Parameter ini diperlukan jika Anda mengatur parameter EventType ke OperateCallback atau RuntimeErrorCallback. Parameter ini opsional jika Anda mengatur parameter EventType ke EpisodeGroupCallback.
EventType	String	Ya	Jenis acara. OperateCallback: callback untuk operasi. RuntimeErrorCallback: callback untuk kesalahan waktu proses. EpisodeGroupCallback: callback untuk pemutaran carousel. ShowListDTSCallback: callback untuk kemajuan pemutaran episode saat ini jika studio produksi dalam mode daftar putar.
EventMessage	EventMessage	Ya	Deskripsi acara. Untuk informasi lebih lanjut, lihat bagian EventMessage dari topik ini.

EventMessage

Tabel berikut menjelaskan bidang parameter EventMessage jika Anda mengatur parameter EventType ke OperateCallback atau RuntimeErrorCallback.

Bidang	Tipe	Diperlukan	Deskripsi
RequestId	String	Tidak	ID permintaan. Bidang ini diperlukan jika Anda mengatur parameter EventType ke OperateCallback.
SceneId	String	Tidak	ID adegan. Bidang ini diperlukan untuk acara adegan.
LayoutId	String	Tidak	ID tata letak. Bidang ini diperlukan untuk acara tata letak.
ResourceId	String	Tidak	ID sumber daya. Bidang ini diperlukan untuk acara sumber video.
ComponentId	String	Tidak	ID komponen. Bidang ini diperlukan untuk acara komponen.
Code	String	Tidak	Kode status.
Message	String	Tidak	Pesan acara.

Tabel berikut menjelaskan bidang parameter EventMessage jika Anda mengatur parameter EventType ke EpisodeGroupCallback.
Bidang Tipe Diperlukan Deskripsi
ProgramId String Ya ID daftar episode untuk pemutaran carousel.
EpisodeId String Ya ID episode.
Code String Tidak Kode status.
Message String Tidak Pesan acara.
Tabel berikut menjelaskan bidang parameter EventMessage jika Anda mengatur parameter EventType ke ShowListDTSCallback.
Bidang Tipe Diperlukan Deskripsi
ProgressTime String Ya Kemajuan pemutaran episode. Unit: milidetik.
ShowId String Ya ID episode.
Duration String Ya Total durasi episode.
ShowName String Ya Nama episode.

Kode status

Kode status	Deskripsi
Success	Operasi berhasil.
StreamInterrupt	Pemutaran aliran langsung atau file terhenti secara tak terduga.
CanvasStreamInterrupt	Aliran kanvas terhenti secara tak terduga.
AudioResampleFailed	Pengambilan sampel ulang audio gagal.
AudioAddFailed	Sumber audio gagal ditambahkan.
AudioDelFailed	Sumber audio gagal dihapus.
AudioStreamTypeInvalid	Tipe aliran audio gagal diproses.
VideoTypeInvalid	Tipe lapisan gagal diproses.
VideoVisibleInvalid	Visibilitas elemen lapisan gagal diproses.
VideoTransparencyInvalid	Nilai transparansi elemen lapisan gagal diproses.
VideoEffectInvalid	Nilai efek elemen lapisan gagal diproses.
VideoWidthInvalid	Nilai normalisasi lebar elemen lapisan gagal diproses.
VideoPositionReferInvalid	Poros referensi elemen lapisan gagal diproses.
VideoStreamTypeInvalid	Tipe media gagal diproses. Tipe media meliputi aliran langsung dan file.
VideoRepeatNumInvalid	Jumlah pengulangan file VOD (Video on Demand) gagal diproses.
VideoStreamAddFailed	Aliran langsung gagal ditambahkan.
ImageOpenFailed	Gambar gagal dibuka.
ImageGetDecodeInfoFailed	Informasi dekode gambar gagal diperoleh.
ImageDecodeFailed	Gambar gagal didekode.
TextInvalid	Teks gagal diproses.
TextFontInvalid	Font teks gagal diproses.
TextSizeInvalid	Nilai normalisasi ukuran font teks gagal diproses.
TextBorderWidthInvalid	Nilai normalisasi lebar batas teks gagal diproses.
CanvasLoadFailed	Aliran kanvas gagal dimuat.
SideOutputUrlInvalid	URL redirect aliran tidak valid.

Contoh

Callback untuk operasi

 {
    "CasterId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
    "EventType": "OperateCallback",
    "EventMessage": {
        "RequestId": "26A96B9A-A201-4EC3-8E43-CB92E68FA132",
        "SceneId": "35716B9A-A201-4EC3-8E43-CB92E68F****",
        "ComponentId": "06196B9A-A201-4EC3-8E43-CB92E68F****",
        "Code": "ImageOpenFailed",
        "Message": "Gagal membuka gambar: http://XXXX/XXXX.jpg"
    }
}

Callback untuk kesalahan waktu proses

{
    "CasterId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
    "EventType": "RuntimeErrorCallback",
    "EventMessage": {
      "Code": "StreamInterrupt",
      "Message": "Gagal membuka aliran: rtmp://DOMAIN/APP/STREAM"
    }
}

Callback untuk kemajuan pemutaran

{
  "EventMessage": {
    "ProgressTime": "116796",
    "ShowId": "9ef1db9d-5e24-4e5f-b161-8a2429d9b882",
    "Duration": "396847",
    "ShowName": "test.mp4"
  },
  "EventType": "ShowListDTSCallback",
  "ResponseTime": 1663731128684,
  "CasterId": "3761c920-dfa6-40c7-a79c-2886b1493996"
}

Bidang	Tipe	Diperlukan	Deskripsi
ProgressTime	String	Ya	Kemajuan pemutaran episode. Unit: milidetik.
ShowId	String	Ya	ID episode.
Duration	String	Ya	Total durasi episode.
ShowName	String	Ya	Nama episode.