全部产品
Search
文档中心

ApsaraVideo VOD:Tipe data dasar

更新时间:Jan 31, 2026

Topik ini menjelaskan tipe data dasar yang digunakan dalam API ApsaraVideo VOD.

Informasi dasar tentang aset media

Video: Informasi audio dan video

Nama

Tipe

Deskripsi

VideoId

String

ID file audio atau video.

Title

String

Judul file audio atau video.

Description

String

Deskripsi file audio atau video.

Duration

Float

Durasi file audio atau video. Satuan: detik.

CoverURL

String

URL gambar mini file audio atau video.

Status

String

Status file audio atau video. Untuk informasi selengkapnya, lihat Status: Status audio dan video.

CreationTime

String

Waktu saat file audio atau video dibuat. Waktu dalam UTC.

Size

Long

Ukuran file sumber audio atau video. Satuan: byte.

Snapshots

String[]

Array URL tangkapan video.

CateId

Long

ID kategori file audio atau video.

CateName

String

Nama kategori file audio atau video.

Tags

String

Tag file audio atau video. Pisahkan beberapa tag dengan koma (,).

TemplateGroupId

String

ID kelompok template transkoding yang digunakan untuk transkoding file audio atau video.

StorageLocation

String

Alamat penyimpanan file audio atau video.

AppId

String

ID aplikasi.

Status: Status audio dan video

Nilai

Deskripsi

Catatan

Uploading

Mengunggah

  • Ini adalah status awal file audio atau video. Ini menunjukkan bahwa file sedang diunggah. Jika file audio atau video Anda tetap dalam status Mengunggah untuk waktu yang lama, lihat Mengapa file yang saya unggah selalu dalam status Mengunggah?.

  • Anda hanya dapat menghapus file audio atau video dalam status ini. Anda cannot melakukan operasi lain pada file tersebut, seperti transkoding, pengambilan tangkapan, atau tinjauan aset media.

UploadFail

Pengunggahan gagal

  • Pengunggahan dapat gagal karena masalah jaringan atau kerusakan file sumber. Coba unggah ulang atau unggah file sumber yang berbeda.

  • Saat Anda menggunakan unggah yang dapat dilanjutkan, file audio atau video tidak akan memasuki status ini karena tidak mungkin menentukan apakah pengunggahan telah gagal.

  • Anda hanya dapat menghapus file audio atau video yang berada dalam status ini. Anda tidak dapat melakukan operasi lain pada file tersebut, seperti transkoding, pengambilan tangkapan, atau tinjauan.

UploadSucc

Diunggah

  • Jika video diunggah tetapi proses transkoding default dilewati karena alasan bisnis atau lainnya, atau jika kelompok template tanpa-transkoding digunakan untuk file sumber yang bukan dalam format MP4, FLV, M3U8, MP3, atau WEBM, maka tidak ada aliran pemutaran yang valid yang dihasilkan. Dalam kasus ini, video berada dalam status Uploaded. Setelah video ditranskode dan aliran pemutaran yang valid dihasilkan, statusnya berubah menjadi Normal.

  • Anda dapat melakukan operasi seperti transkoding, pengambilan tangkapan, atau tinjauan pada file audio dan video dalam status ini.

Transcoding

Transkoding

File audio dan video dalam status ini sedang ditranskoding. Saat video sedang ditranskoding untuk pertama kalinya, tidak ada aliran pemutaran yang valid tersedia, dan Anda tidak dapat memperoleh URL pemutaran dengan memanggil operasi API. Anda dapat menentukan status transkoding dari notifikasi event penyelesaian transkoding, seperti Transkoding Definisi Tunggal Selesai atau Transkoding Semua Definisi Selesai.

TranscodeFail

Transkoding gagal

Kegagalan transkoding biasanya disebabkan oleh kesalahan pada file sumber. Anda dapat memperoleh ErrorMessage dari notifikasi event StreamTranscodeComplete atau TranscodeComplete, atau lihat FAQ Transkoding untuk memecahkan masalah kegagalan tersebut.

Checking

Meninjau

  • Jika Anda mengaktifkan fitur Review Before Release di ApsaraVideo VOD Console > Review Management > Review Settings, file audio atau video secara otomatis memasuki proses tinjauan setelah diunggah ke ApsaraVideo VOD dan berhasil ditranskode. Status file tersebut kemudian ditandai sebagai Reviewing. Anda harus memulai tinjauan manual. Jika tidak, file tersebut tetap berada dalam status Reviewing.

  • Anda hanya dapat memutar file audio dan video dalam status ini di konsol ApsaraVideo VOD atau menggunakan alamat IP aman untuk tinjauan. Anda tidak dapat memperoleh URL pemutaran untuk file-file ini menggunakan API atau SDK. Namun, Anda masih dapat memutarnya menggunakan URL pemutaran yang valid yang telah dipublikasikan.

  • Anda dapat melakukan operasi seperti transkoding, penangkapan snapshot, atau tinjauan pada file dalam status ini.

Catatan

Perhatikan bahwa status Reviewing untuk aset media (yang dapat Anda lihat di kolom Status di bawah ApsaraVideo VOD Console > Media Files > Audio/Video) berbeda dari status Reviewing untuk pekerjaan moderasi berbantuan mesin (yang dapat Anda lihat di kolom Machine-assisted Moderation Status di bawah ApsaraVideo VOD Console > Review Management > Content Moderation). Status Reviewing untuk pekerjaan moderasi berbantuan mesin hanya menggambarkan status pekerjaan tersebut, sedangkan status Reviewing untuk aset media menggambarkan status pekerjaan moderasi berbantuan mesin dan manual.

Blocked

Diblokir

  • Anda hanya dapat memutar file audio dan video dalam status ini di konsol ApsaraVideo VOD atau menggunakan alamat IP aman untuk tinjauan. Anda tidak dapat memperoleh URL pemutaran untuk file-file ini menggunakan API atau SDK. Namun, Anda masih dapat memutarnya menggunakan URL pemutaran yang valid yang telah dipublikasikan.

  • Anda hanya dapat menghapus file audio atau video dalam status ini. Anda tidak dapat melakukan operasi lain pada file tersebut, seperti transkoding, pengambilan tangkapan, atau tinjauan aset media.

Normal

Normal

  • File audio atau video berada dalam status Normal jika setidaknya ada satu aliran pemutaran yang valid.

  • Anda dapat melakukan semua operasi, seperti transkoding, pengambilan tangkapan, tinjauan, dan pemutaran, pada file audio atau video yang berada dalam status ini.

ProduceFail

Synthesis failed

Video gagal diproduksi melalui pengeditan daring. Saat Anda menggunakan fitur pengeditan daring ApsaraVideo VOD untuk memproduksi video, pastikan semua aset media yang digunakan untuk produksi berada dalam status Normal. Jika tidak, produksi video mungkin gagal.

ImageInfo: Informasi gambar

Nama

Tipe

Deskripsi

ImageId

String

ID dari gambar.

URL

String

URL gambar. Jika nama domain yang dipercepat dikonfigurasi, URL CDN dikembalikan. Jika tidak, URL OSS dikembalikan.

Title

String

Judul dari gambar.

Tags

String

Tag dari gambar.

ImageType

String

Tipe dari gambar.

CateId

Long

ID kategori.

CateName

String

Nama kategori.

Description

String

Deskripsi.

StorageLocation

String

Alamat penyimpanan file.

Mezzanine

Mezzanine

Informasi sumber gambar.

CreationTime

String

Waktu saat gambar dibuat. Waktu dalam UTC.

Status

String

Status gambar. Untuk informasi selengkapnya, lihat Status: Status gambar.

AppId

String

ID aplikasi.

Status: Status gambar

Nilai

Deskripsi

Catatan

Uploading

Mengunggah

Ini adalah status awal gambar. Ini menunjukkan bahwa gambar sedang diunggah. Jika gambar Anda tetap dalam status Mengunggah untuk waktu yang lama, lihat Mengapa file yang saya unggah selalu dalam status Mengunggah?.

UploadFail

Pengunggahan gagal

Pengunggahan dapat gagal karena masalah jaringan atau kerusakan file sumber. Coba unggah ulang atau unggah file sumber yang berbeda.

Normal

Normal

Gambar telah diunggah.

AttachedMediaInfo: Informasi aset media pendukung

Nama

Tipe

Deskripsi

MediaId

String

ID dari aset media tambahan.

URL

String

URL aset media pendukung. Jika nama domain yang dipercepat dikonfigurasi, URL CDN dikembalikan. Jika tidak, URL OSS dikembalikan.

Title

String

Judul.

Tags

String

Tag.

Type

String

Tipe dari aset media tambahan.

Categories

Category[]

Daftar kategori.

Deskripsi

String

Deskripsi.

LokasiPenyimpanan

String

Alamat penyimpanan file.

WaktuPembuatan

String

Waktu saat aset media pendukung dibuat. Waktu dalam UTC.

WaktuModifikasi

String

Waktu pembaruan aset media pendukung. Waktu dalam UTC.

Status

String

Status aset media pendukung. Untuk informasi selengkapnya, lihat Status: Status aset media pendukung.

AppId

String

ID aplikasi.

Status: Status aset media pendukung

Nilai

Deskripsi

Catatan

Uploading

Mengunggah

Status awal. Ini menunjukkan bahwa aset media pendukung sedang diunggah.

Normal

Normal

Aset media pendukung telah diunggah.

UploadFail

Gagal

Pengunggahan aset media pendukung gagal.

Informasi file sumber daya media

Mezzanine: Informasi file sumber audio dan video

Nama

Tipe

Deskripsi

VideoId

String

ID video.

FileName

String

Nama file.

Duration

String

Durasi file. Satuan: detik.

Status

String

Status file sumber. Untuk informasi selengkapnya, lihat Status: Status file sumber audio dan video.

CreationTime

String

Waktu saat file dibuat. Waktu dalam UTC.

Height

Long

Tinggi file. Satuan: piksel.

Width

Long

Lebar file. Satuan: piksel.

Fps

String

Laju frame file, dalam frame per detik.

FileURL

String

URL file.

Bitrate

String

Bitrate file. Satuan: Kbps.

Size

Long

Ukuran file. Satuan: byte.

OutputType

String

Jenis file output. Nilai yang valid:

  • oss: alamat server asal.

  • cdn: alamat yang dipercepat.

VideoStreamList

VideoStream[]

Daftar informasi aliran video.

AudioStreamList

AudioStream[]

Daftar informasi aliran audio.

VideoStream: Informasi aliran video

Nama

Tipe

Deskripsi

Index

String

Nomor urut aliran video. Ini mengidentifikasi posisi aliran video dalam keseluruhan aliran media.

CodecName

String

Nama pendek format penyandian.

CodecLongName

String

Nama panjang format encoding.

Profile

String

Profil codec.

CodecTimeBase

String

Dasar waktu codec.

CodecTagString

String

String tag format penyandian.

CodecTag

String

Tag format penyandian.

Width

Long

Lebar resolusi video.

Height

Long

Resolusi video tinggi.

HasBFrames

String

Menunjukkan apakah frame B ada.

Sar

String

Rasio resolusi sinyal yang dikodekan.

Dar

String

Rasio aspek tampilan (DAR).

PixFmt

String

Format piksel.

Level

String

Tingkat encoding.

Fps

String

Laju frame target.

AvgFPS

String

Laju bingkai rata-rata.

Timebase

String

Basis waktu.

StartTime

String

Waktu mulai.

Duration

String

Durasi.

NumFrames

String

Jumlah total frame.

Lang

String

Bahasa.

Rotate

String

Sudut rotasi video. Nilai yang valid: [0, 360).

AudioStream: Informasi aliran audio

Nama

Tipe

Deskripsi

Index

String

Nomor urut aliran audio. Ini mengidentifikasi posisi aliran audio dalam keseluruhan aliran media.

CodecName

String

Nama pendek format penyandian.

CodecLongName

String

Nama panjang format encoding.

CodecTimeBase

String

Dasar waktu codec.

CodecTagString

String

String tag format penyandian.

CodecTag

String

Tag format penyandian.

SampleFmt

String

Format pengambilan sampel.

SampleRate

String

Laju sampel.

Channels

String

Jumlah saluran suara.

ChannelLayout

String

Tata letak saluran suara.

Timebase

String

Basis waktu.

StartTime

String

Waktu mulai.

Duration

String

Durasi.

Bitrate

String

Bitrate.

NumFrames

String

Jumlah total frame.

Lang

String

Bahasa.

Status: Status file sumber audio dan video

Nilai

Deskripsi

Keterangan

Mengunggah

Mengunggah

Status awal file. Ini menunjukkan bahwa file sedang diunggah.

Normal

Normal

File telah diunggah.

GagalUnggah

Gagal

Pengunggahan file gagal.

Dihapus

Dihapus

File dihapus.

Mezzanine: Informasi file sumber gambar

Nama

Tipe

Deskripsi

FileURL

String

URL OSS gambar.

OriginalFileName

String

Nama file yang diunggah.

FileSize

Long

Ukuran file. Satuan: byte.

Width

Integer

Lebar gambar. Satuan: piksel.

Height

Integer

Tinggi gambar. Satuan: piksel.

Pengunggahan batch dari URL

URLUploadInfo: Informasi pengunggahan URL

Nama

Tipe

Deskripsi

JobId

String

ID pekerjaan.

UploadURL

String

URL unggah.

MediaId

String

ID video yang diunggah.

FileSize

String

Ukuran file. Satuan: byte.

Status

String

Status pekerjaan pengunggahan URL. Untuk informasi selengkapnya, lihat Status: Status pekerjaan pengunggahan URL.

CreationTime

String

Waktu pembuatan.

CompleteTime

Long

Waktu penyelesaian.

UserData

String

Bidang yang ditentukan pengguna.

ErrorCode

String

Kode kesalahan.

ErrorMessage

String

Pesan kesalahan.

Status: Status pekerjaan pengunggahan URL

Nilai

Deskripsi

PENDING

Pekerjaan telah dikirim dan sedang menunggu untuk diproses.

PROCESSING

Pekerjaan sedang diproses.

DOWNLOADING

File sedang diunduh.

DOWNLOAD_SUCCESS

File berhasil diunduh.

DOWNLOAD_FAIL

File gagal diunduh.

UPLOADING

File sedang diunggah.

UPLOAD_SUCCESS

Pengunggahan berhasil.

UPLOAD_FAIL

Pengunggahan gagal.

SUCCESS

Pekerjaan berhasil dan callback selesai.

Pemutaran audio dan video

VideoBase: Informasi video dasar

Nama

Tipe

Deskripsi

VideoId

String

ID video.

Title

String

Judul video.

Duration

String

Durasi video. Satuan: detik.

CoverURL

String

Gambar mini video.

Status

String

Status video.

CreationTime

String

Waktu saat video dibuat. Waktu dalam UTC.

MediaType

MediaType

Jenis file media. Nilai yang valid:

  • video: video

  • audio: hanya audio

Catatan

Secara default, operasi pemutaran mengembalikan URL CDN yang dipercepat. Jika tidak ada nama domain yang dikonfigurasi, operasi tersebut mengembalikan URL server origin OSS. Dalam kasus ini, hanya URL file MP4 yang dapat digunakan untuk pemutaran.

PlayInfo: Informasi pemutaran video

Nama

Tipe

Deskripsi

Bitrate

String

Bitrate aliran video. Satuan: Kbps.

Definition

String

Definisi aliran video. Nilai yang valid:

  • FD: definisi rendah

  • LD: definisi standar

  • SD: definisi tinggi

  • HD: definisi ultra tinggi

  • OD: kualitas asli

  • 2K: 2K

  • 4K: 4K

Specification

String

Spesifikasi output untuk transkoding audio dan video. Untuk informasi selengkapnya, lihat Spesifikasi output.

Duration

String

Panjang aliran video. Satuan: detik.

Encrypt

Long

Menunjukkan apakah aliran video dienkripsi. Nilai yang valid:

  • 0: Tidak

  • 1: Ya

TipeEnkripsi

String

Jenis enkripsi aliran video. Nilai yang valid:

  • AliyunVoDEncryption: Enkripsi Video Alibaba Cloud (enkripsi pribadi)

  • HLSEncryption: Enkripsi HLS

PlayURL

String

URL pemutaran aliran video.

Format

String

Format aliran video.

Jika file media adalah video, nilai yang valid adalah:

  • mp4

  • m3u8

Jika file media hanya berisi audio, nilai yang valid adalah mp3.

Fps

String

Laju frame aliran video, dalam frame per detik.

Ukuran

Panjang

Ukuran aliran video. Satuan: byte.

Lebar

Panjang

Lebar aliran video. Satuan: piksel.

Tinggi

Panjang

Tinggi aliran video. Satuan: piksel.

StreamType

String

Jenis aliran media.

  • Jika aliran media adalah video, nilainya adalah video.

  • Jika aliran media hanya berisi audio, nilainya adalah audio.

JobId

String

ID pekerjaan transkoding untuk aliran media. ID ini berfungsi sebagai pengidentifikasi unik untuk aliran media.

WatermarkId

String

ID watermark yang terkait dengan aliran media saat ini.

Status

String

Status aliran video. Nilai yang valid:

  • Normal: Aliran yang ditranskoding terbaru untuk setiap definisi dan format berada dalam status Normal.

  • Invisible: Jika beberapa aliran ditranskoding untuk definisi dan format yang sama, aliran terbaru ditandai sebagai Normal, dan yang lainnya ditandai sebagai Invisible.

NarrowBandType

String

Jenis Narrowband HD. Nilai yang valid:

  • 0: normal

  • 1.0: Narrowband HD 1.0

  • 2.0: Narrowband HD 2.0

Parameter ini hanya berlaku ketika definisi dari template transkoding Narrowband HD 1.0 bawaan dikonfigurasi. Untuk informasi selengkapnya, lihat TranscodeTemplate: Konfigurasi template transkoding.

CreationTime

String

Waktu saat aliran dibuat. Waktu dalam UTC.

ModificationTime

String

Waktu saat aliran diperbarui. Waktu dalam UTC.

VideoMeta: Metadata video

Nama

Tipe

Deskripsi

VideoId

String

ID video.

Title

String

Judul video.

Durasi

Float

Durasi video. Satuan: detik.

CoverURL

String

Gambar mini video.

Status

String

Status video.

Pencarian aset media

Media: Informasi media

Nama

Type

Deskripsi

MediaId

String

ID dari aset media.

WaktuPembuatan

String

Waktu saat aset media dibuat. Waktu dalam UTC.

MediaType

String

Jenis file media. Nilai yang valid:

  • video: video

  • audio: audio

  • image: gambar

  • attached: aset media tambahan

Video

Video

Informasi video.

Audio

Audio

Informasi audio.

Gambar

Gambar

Informasi gambar.

AttachedMedia

AttachedMedia

Informasi aset media pendukung.

Kategorisasi aset media

Category: Kategori aset media

Nama

Tipe

Deskripsi

CateId

Long

ID kategori video.

CateName

String

Nama kategori. Nilainya dapat mencapai panjang 64 byte dan harus dalam UTF-8.

ParentId

Long

ID kategori induk. ID induk untuk kategori tingkat 1 adalah -1.

Level

Long

Tingkat kategori. Kategori tingkat 1 berada di level 0.

Live to VOD

LiveRecordVideo: Informasi perekaman Langsung-ke-VOD

Nama

Tipe

Deskripsi

StreamName

String

Nama aliran langsung.

DomainName

String

Nama domain.

AppName

String

Nama aplikasi.

PlaylistId

String

ID dari daftar putar.

RecordStartTime

String

Waktu mulai perekaman.

RecordEndTime

String

Waktu akhir perekaman.

Video

Video

Informasi video.

Pengeditan daring: Pengeditan dan produksi video

EditingProject: Proyek pengeditan daring

Nama

Tipe

Deskripsi

ProjectId

String

ID dari proyek pengeditan online.

Title

String

Judul dari proyek pengeditan online.

CreationTime

String

Waktu saat proyek pengeditan daring dibuat. Waktu dalam UTC dan mengikuti format yyyy-MM-ddTHH:mm:ssZ.

Sebagai contoh, 2017-01-11T12:00:00Z sesuai dengan pukul 20:00:00 pada 11 Januari 2017 (UTC+8).

ModifiedTime

String

Waktu saat proyek pengeditan daring terakhir dimodifikasi. Waktu dalam UTC dan mengikuti format yyyy-MM-ddTHH:mm:ssZ.

Sebagai contoh, 2017-01-11T12:00:00Z sesuai dengan pukul 20:00:00 pada 11 Januari 2017 (UTC+8).

Status

String

Status dari proyek pengeditan online.

Description

String

Deskripsi dari proyek pengeditan online.

Timeline

String

Linimasa dari proyek pengeditan online. Nilainya adalah string JSON.

Duration

String

Durasi total proyek pengeditan daring. Ini sama dengan durasi total timeline.

CoverURL

String

URL gambar mini dari proyek pengeditan online.

ProjectStatus: Status proyek pengeditan daring

Nilai

Deskripsi

Catatan

Normal

Draf

Status awal proyek pengeditan daring.

Menghasilkan

Memproduksi

Tidak ada.

Dihasilkan

Sintesis berhasil.

Tidak ada.

ProduceFailed

Synthesis failed

Tidak ada.

Material: Informasi materi untuk proyek pengeditan daring

Catatan

Tipe ini merujuk pada materi secara umum dan mencakup materi dalam manajemen materi serta video dalam pustaka media.

Nama

Tipe

Deskripsi

MaterialId

String

ID materi.

Title

String

Judul materi.

Description

String

Deskripsi materi.

Durasi

Float

Durasi dari materi. Satuan: detik. Nilainya akurat hingga empat tempat desimal.

CoverURL

String

URL gambar mini dari materi.

Status

String

Status materi.

CreationTime

String

Waktu saat materi dibuat. Waktu dalam UTC.

Size

Long

Ukuran file sumber materi. Satuan: byte.

CateId

Long

ID kategori dari materi.

CateName

String

Nama kategori dari materi.

Tags

String

Tag materi. Pisahkan beberapa tag dengan koma (,).

Snapshots

String[]

Array URL tangkapan materi.

Sprites

String[]

Array URL sprite materi.

ProduceConfig: Konfigurasi produksi video

Nama

Tipe

Deskripsi

TemplateGroupId

String

ID kelompok template transkoding yang digunakan untuk transkoding setelah produksi video selesai. File yang diproduksi digunakan sebagai file sumber. Proses ini mirip dengan proses transkoding setelah unggahan selesai.

Parameter ini opsional. Jika dibiarkan kosong, kelompok template default dalam pengaturan transkoding akan digunakan. Jika ditentukan, kelompok template yang ditentukan akan digunakan. Anda dapat melihat ID kelompok template di pengaturan transkoding konsol.

TemplateId

String

ID template produksi yang digunakan untuk produksi video, yang menghasilkan file sumber untuk aset media. Parameter ini opsional. Jika dibiarkan kosong, template pengeditan daring bawaan digunakan untuk produksi.

Jika target produksi adalah file video, template bawaan menggunakan format encoding H.264 dan format kontainer MP4.

Jika Anda memiliki persyaratan lain dan ingin menentukan parameter produksi (seperti produksi GIF animasi, subtitel cerdas, pemotongan cepat M3U8, atau parameter produksi kustom), Anda dapat membuat tiket untuk mengajukan permohonan.

Lebar

Bilangan bulat

Lebar frame video output. Satuan: piksel.

Parameter ini opsional. Nilai default tergantung pada resolusi file sumber materi yang digunakan dalam timeline. Lebar dan tinggi maksimum digunakan.

Sebagai contoh, jika tiga materi dengan resolusi file sumber 1280 × 720, 1920 × 1080, dan 720 × 1280 digunakan dalam timeline, resolusi video yang dihasilkan adalah 1920 × 1280.

Tinggi

Bilangan bulat

Tinggi frame video output. Satuan: piksel.

Parameter ini opsional. Nilai default tergantung pada resolusi file sumber materi yang digunakan dalam timeline. Lebar dan tinggi maksimum digunakan.

Sebagai contoh, jika tiga materi dengan resolusi file sumber 1280 × 720, 1920 × 1080, dan 720 × 1280 digunakan dalam timeline, resolusi video yang dihasilkan adalah 1920 × 1280.

Laju Bit

Bilangan Bulat

Bitrate video output. Satuan: Kbps.

Parameter ini opsional. Nilai default tergantung pada bitrate file sumber materi yang digunakan dalam timeline. Bitrate maksimum digunakan.

Misalnya, jika tiga materi dengan bitrate file sumber 400 Kbps, 600 Kbps, dan 800 Kbps digunakan dalam timeline, bitrate video yang dihasilkan adalah 800 Kbps.

LokasiPenyimpanan

String

Alamat penyimpanan file (wajib untuk wilayah selain Shanghai).

MediaMetadata: Metadata video yang diproduksi

Nama

Tipe

Deskripsi

Judul

String

Judul video yang diproduksi. Judul dapat mencapai panjang 128 byte dan harus dalam UTF-8.

Deskripsi

String

Deskripsi video yang diproduksi. Deskripsi dapat mencapai panjang 1.024 byte dan harus dalam UTF-8.

CoverURL

String

URL gambar mini kustom untuk video yang dihasilkan.

CateId

String

ID kategori video yang dihasilkan. Di konsol ApsaraVideo VOD > Konfigurasi Manajemen > Konfigurasi Manajemen Aset Media > Manajemen Kategori , edit atau lihat ID kategori.

Tag

String

Tag video yang diproduksi. Satu tag dapat mencapai panjang 32 byte. Anda dapat menambahkan maksimal 16 tag. Pisahkan beberapa tag dengan koma (,). Nilai harus dalam UTF-8.

Pengeditan daring - Timeline (untuk editor baru)

Catatan

Fitur pengeditan daring tidak didukung di wilayah tertentu. Pastikan fitur ini tersedia di wilayah tempat ApsaraVideo VOD diaktifkan sebelum menggunakannya. Untuk informasi selengkapnya, lihat Wilayah. Untuk informasi selengkapnya tentang tipe data pengeditan daring untuk editor lama, lihat Tipe data pengeditan daring – editor lama.

Timeline: Informasi timeline

Timeline dibuat dengan menyusun materi dan merancang efek berdasarkan konsep video. Timeline terutama terdiri dari track, materi, dan efek.

Nama

Tipe

Diperlukan

Deskripsi

VideoTracks

VideoTrack[]

Tidak. Trek video dan trek audio tidak boleh keduanya kosong.

Daftar trek video. Trek disusun berlapis dalam urutan yang sama dengan elemen array. Misalnya, trek yang sesuai dengan elemen pertama berada di lapisan paling bawah, trek untuk elemen kedua ditumpuk di atasnya, dan seterusnya.

AudioTracks

AudioTrack[]

Tidak. Trek audio dan trek video tidak boleh keduanya kosong.

Daftar trek audio.

SubtitleTracks

SubtitleTrack[]

Tidak

Daftar trek subtitle.

EffectTracks

EffectTrack[]

Tidak

Daftar trek efek.

VideoTrack: Informasi trek video

VideoTrack digunakan untuk mengatur materi visual, seperti video dan gambar.

Nama

Tipe

Diperlukan

Deskripsi

Tipe

String

Tidak

Defaultnya adalah trek video normal.

Ketika Type=Effect, trek saat ini dapat digunakan sebagai trek efek. Anda dapat mengisi VideoTrackClips dengan EffectTrackItem.

MainTrack

Boolean

Tidak

Menentukan apakah trek saat ini adalah trek utama. Nilai default adalah False.

VideoTrackClips

VideoTrackClip[]

Ya

Daftar klip materi pada trek video.

AudioTrack: Informasi trek audio

AudioTrack digunakan untuk mengatur materi audio, termasuk materi hanya audio dan materi video yang berisi aliran audio.

Nama

Jenis

Diperlukan

Deskripsi

MainTrack

Boolean

Tidak

Menentukan apakah trek saat ini adalah trek utama. Nilai default adalah False.

AudioTrackClips

AudioTrackClip[]

Ya

Daftar klip materi pada trek audio.

SubtitleTrack: Informasi trek subtitle

SubtitleTrack digunakan untuk mengatur subtitle, termasuk teks banner dan subtitle eksternal.

Nama

Tipe

Diperlukan

Deskripsi

SubtitleTrackClips

SubtitleTrackClip[]

Ya

Daftar klip materi pada trek subtitle.

EffectTrack: Informasi trek efek

EffectTrack digunakan untuk menerapkan efek ke seluruh video. Efek yang didukung termasuk filter dan VFX.

Nama

Type

Diperlukan

Deskripsi

EffectTrackItems

EffectTrackItem[]

Ya

Daftar klip trek efek.

VideoTrackClip: Informasi materi trek video

Materi VideoTrackClip mencakup materi video dan gambar.

Parameter In, Out, TimelineIn, dan TimelineOut menentukan titik potong materi dan posisinya pada timeline. Misalnya, untuk menempatkan segmen dari detik ke-5 hingga ke-10 video pada posisi detik ke-15 hingga ke-20 pada timeline, atur In=5, Out=10, TimelineIn=15, dan TimelineOut=20.

Nama

Tipe

Diperlukan

Deskripsi

MediaId

String

Tidak

ID media klip materi trek video. Dalam beberapa kasus, ID media juga disebut ID audio/video (VideoId) atau ID gambar (ImageId).

Tipe

String

Tidak

Jenis klip materi. Nilai default adalah Video.

Nilai yang valid:

  • Video

  • Image

  • GlobalImage (gambar global). Durasi gambar global dihitung berdasarkan durasi trek video terpanjang secara default.

Contoh: Menggunakan gambar global dalam trek video

X

Float

Tidak

Jarak horizontal dari sudut kiri atas gambar atau video ke sudut kiri atas video output. Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari lebar video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

Y

Float

Tidak

Jarak vertikal dari sudut kiri atas gambar atau video ke sudut kiri atas video output. Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari tinggi video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

Lebar

Float

Tidak

Lebar gambar dalam video output. Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari lebar video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

Tinggi

Float

Tidak

Tinggi gambar dalam video output. Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari tinggi video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

AdaptMode

String

Tidak

Mode penskalaan adaptif untuk ukuran video. Nilai default adalah Fill. Mode ini hanya berlaku ketika Anda mengatur lebar dan tinggi trek video. Dalam kasus ini, Width dan Height menentukan area target, dan video diskalakan secara adaptif di dalam area ini.

  • Contain: Konten diskalakan agar sesuai dengan area target sambil mempertahankan rasio aspeknya.

  • Cover: Konten mengisi seluruh area target sambil mempertahankan rasio aspeknya. Jika rasio aspek objek tidak sesuai dengan kotak konten, objek dipotong agar sesuai dengan area target.

  • Fill: Logika default. Konten diregangkan agar mengisi kotak konten target. Seluruh objek sepenuhnya mengisi kotak ini. Jika rasio aspek objek tidak cocok dengan kotak konten, objek diregangkan agar sesuai dengan area target.

In

Float

Tidak

Titik masuk klip materi relatif terhadap materi. Ini digunakan ketika materi adalah file audio atau video. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika Anda tidak menentukan In, nilai default adalah 0.

Out

Float

Tidak

Titik keluar klip materi relatif terhadap materi. Ini digunakan ketika materi adalah file audio atau video. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika Anda tidak menentukan Out, durasi materi digunakan sebagai nilai default.

MaxOut

Float

Tidak

Titik keluar maksimum klip materi relatif terhadap materi. Jika Anda mengatur parameter ini, titik keluar klip diatur ke nilai yang lebih kecil antara durasi materi dan nilai parameter ini. Parameter ini digunakan untuk materi audio dan video. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika Anda mengatur parameter Out, parameter MaxOut menjadi tidak valid.

Contoh: Mengatur titik keluar MaxOut dalam trek video

Durasi

Float

Tidak

Durasi klip materi. Ini umumnya digunakan ketika materi adalah gambar. Satuan: detik. Nilai akurat hingga empat tempat desimal.

DyncFrames

Int

Tidak

Laju frame gambar animasi. Ini digunakan ketika materi adalah gambar animasi.

Contoh: Menggunakan stiker GIF

TimelineIn

Float

Tidak

Titik masuk klip materi relatif terhadap timeline. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika Anda tidak menentukan TimelineIn, nilainya dihitung secara otomatis berdasarkan urutan berurutan klip materi.

TimelineOut

Float

Tidak

Titik keluar klip materi relatif terhadap timeline. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika Anda tidak menentukan TimelineOut, nilainya dihitung secara otomatis berdasarkan urutan berurutan klip materi.

Kecepatan

Float

Tidak

Kecepatan materi video. Nilai berkisar dari 0,1 hingga 100. Misalnya, jika Speed=2, video diproses dengan kecepatan 2x, Durasi klip menjadi separuhnya, dan dimasukkan ke dalam video akhir.

Contoh: Mengubah kecepatan audio dan video

MaskVideoUrl

String

Tidak

URL video mask. Ini biasanya merupakan video dengan saluran alfa yang digunakan untuk menambahkan efek transparansi ke video asli.

Hanya URL OSS publik yang didukung.

Efek

Efek[]

Tidak

Daftar efek untuk klip materi.

AudioTrackClip: Informasi materi trek audio

Materi AudioTrackClip mencakup materi hanya audio dan materi video yang memiliki aliran audio.

Parameter In, Out, TimelineIn, dan TimelineOut menentukan titik potong materi dan posisinya pada timeline. Misalnya, untuk menempatkan segmen dari detik ke-5 hingga ke-10 video pada posisi detik ke-15 hingga ke-20 pada timeline, atur In=5, Out=10, TimelineIn=15, dan TimelineOut=20.

Nama

Tipe

Diperlukan

Deskripsi

MediaId

String

Tidak

ID media klip materi trek audio.

In

Float

Tidak

Titik masuk klip materi relatif terhadap materi. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika In tidak ditentukan, nilai default adalah 0.

Out

Float

Tidak

Titik keluar klip materi relatif terhadap materi. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika Out tidak ditentukan, durasi materi digunakan sebagai nilai default.

TimelineIn

Float

Tidak

Titik masuk klip materi relatif terhadap timeline. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika TimelineIn tidak ditentukan, nilai dihitung secara otomatis berdasarkan urutan berurutan klip materi.

TimelineOut

Float

Tidak

Titik keluar klip materi relatif terhadap timeline. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika TimelineOut tidak ditentukan, nilai dihitung secara otomatis berdasarkan urutan berurutan klip materi.

Speed

Float

Tidak

Kecepatan materi audio. Nilai berkisar dari 0,1 hingga 100. Misalnya, jika Speed=2, audio diproses dengan kecepatan 2x, Durasi klip menjadi separuhnya, dan dimasukkan ke dalam video akhir.

Contoh: Mengubah kecepatan audio dan video

Effects

Effect[]

Tidak

Daftar efek untuk klip materi.

LoopMode

Boolean

Tidak

Efek putar ulang berulang untuk klip materi pada timeline. True: putar ulang berulang. False (default): pemutaran normal tanpa putaran.

Contoh: Putar ulang audio berulang

SubtitleTrackClip: Informasi materi trek subtitle

SubtitleTrackClip merepresentasikan materi subtitle.

Nama

Tipe

Diperlukan

Deskripsi

Tipe

String

Ya

Tipe dari materi subtitle. Nilai yang valid:

  • Subtitle: file subtitle eksternal

  • Text: teks banner

SubTipe

String

Tidak

Subtipe dari materi subtitle. Nilai yang valid:

  • srt: subtitle SRT eksternal

  • ass: subtitle ASS eksternal

Anda dapat mengabaikan parameter ini jika jenis materi subtitle adalah teks banner.

FileURL

String

Tidak

Alamat OSS file subtitle. Parameter ini wajib ketika jenis subtitle adalah subtitle eksternal. Formatnya adalah:

https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.srt

Contoh: Menggunakan file subtitle langsung untuk pengeditan

Catatan

FileURL hanya mendukung URL OSS publik. URL OSS yang dipercepat, URL CDN, atau URL HTTP lainnya tidak didukung.

X

Float

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan jarak horizontal dari sudut kiri atas teks ke sudut kiri atas video output. Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari lebar video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

Y

Float

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan jarak vertikal dari sudut kiri atas teks ke sudut kiri atas video output. Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari tinggi video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

TimelineIn

Float

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan posisi awal teks pada timeline. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika TimelineIn tidak ditentukan, nilai dihitung secara otomatis berdasarkan urutan berurutan materi.

TimelineOut

Float

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan posisi akhir teks pada timeline. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika TimelineOut tidak ditentukan, nilai dihitung secara otomatis berdasarkan urutan berurutan materi.

Konten

String

Tidak

Ketika jenis subtitle adalah teks banner, parameter ini wajib. Ini menunjukkan konten teks.

Font

String

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan font teks. Nilai default: SimSun. Untuk informasi selengkapnya tentang font yang didukung, lihat Font.

FontSize

Int

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan ukuran font.

FontColor

String

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan warna teks, dalam format # diikuti oleh nilai heksadesimal. Contoh: #ffffff.

FontColorOpacity

String

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan transparansi teks. Nilainya berkisar dari 0 hingga 1. Defaultnya adalah 1. 1 berarti buram, dan 0 berarti sepenuhnya transparan.

FontFace

FontFace

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan penampilan font.

Spacing

Int

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan spasi karakter teks banner. Satuan: piksel. Default adalah 0.

Sudut

Float

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan sudut rotasi berlawanan arah jarum jam teks banner. Satuan: derajat. Default adalah 0.

BorderStyle

Int

Tidak

Atur format border dan bayangan untuk teks banner. Nilai yang valid adalah 1 atau 3. 1=border+shadow, 3=kotak latar belakang buram. Default adalah 1.

Outline

Int

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan lebar garis luar teks banner. Satuan: piksel. Default adalah 0.

OutlineColour

String

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan warna garis luar teks banner, dalam format # diikuti oleh nilai heksadesimal. Contoh: #ffffff.

Bayangan

Int

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan kedalaman bayangan yang dilemparkan oleh teks banner. Satuan: piksel. Default adalah 0.

BackColour

String

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan warna bayangan teks banner, dalam format # diikuti oleh nilai heksadesimal. Contoh: #ffffff.

Perataan

String

Tidak

Ketika jenis subtitle adalah teks banner, ini mengatur penyelarasan. Defaultnya adalah TopLeft. Nilai yang valid:

  • TopLeft: sudut kiri atas video

  • TopCenter: tengah atas sumbu vertikal video

  • TopRight: sudut kanan atas video

  • CenterLeft: tengah kiri sumbu horizontal video

  • CenterCenter: tengah video

  • CenterRight: tengah kanan sumbu horizontal video

  • BottomLeft: sudut kiri bawah video

  • BottomCenter: tengah bawah sumbu vertikal video

  • BottomRight: sudut kanan bawah video

AdaptMode

String

Tidak

Secara otomatis membungkus atau menskalakan teks banner ketika melebihi lebar video atau TextWidth yang ditentukan. Nilai yang valid:

  • AutoWrap: pembungkus otomatis

  • AutoScale: penskalaan otomatis

  • AutoWrapAtSpaces: Secara otomatis membungkus teks hanya pada spasi. Ini cocok untuk pembungkusan otomatis subtitle berbahasa Inggris saja.

TextWidth

Integer

Tidak

Lebar kotak teks subtitle. Ini berlaku ketika AdaptMode diatur. Lebar kotak teks diatur ke nilai ini untuk pembungkusan atau penskalaan otomatis. Jika tidak ditentukan, lebar video digunakan untuk pembungkusan atau penskalaan otomatis. Satuan: piksel.

FontUrl

String

Tidak

Ketika jenis subtitle adalah teks banner, Anda dapat menggunakan jalur file font di bucket OSS Anda untuk menghasilkan subtitle. Format file font TTF, OTF, dan WOFF didukung. Contoh: https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf

EffectColorStyle

String

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan jenis gaya seni kata teks banner.

Untuk informasi selengkapnya tentang jenis dan efek seni kata, lihat Contoh efek seni kata.

AaiMotionInEffect

String

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan jenis efek masuk teks banner.

Untuk informasi selengkapnya tentang efek masuk keterangan, lihat Efek masuk.

AaiMotionIn

Float

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan durasi efek masuk. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika AaiMotionIn tidak ditentukan, defaultnya adalah 0,5 detik. Jika durasi teks kurang dari 0,5 detik, nilainya adalah durasi total dikurangi durasi keluar.

AaiMotionOutEffect

String

Tidak

Menentukan efek masuk untuk caption teks banner.

Untuk jenis dan efek efek masuk caption, lihat Efek masuk.

AaiMotionOut

Float

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan durasi efek keluar. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika AaiMotionOut tidak ditentukan, defaultnya adalah 0,5 detik. Jika durasi teks kurang dari 0,5 detik, nilainya adalah durasi teks total.

AaiMotionLoopEffect

String

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan jenis efek putar ulang teks banner. Ini tidak dapat berlaku bersamaan dengan efek masuk atau keluar.

Untuk informasi selengkapnya tentang efek putar ulang, lihat Efek putar ulang.

Rasio

Float

Tidak

Ketika jenis subtitle adalah teks banner, ini menunjukkan kecepatan pemutaran efek putar ulang. Nilai akurat hingga empat tempat desimal. Default adalah 1. Nilai lebih dari 1 berarti putar ulang lebih cepat, dan nilai kurang dari 1 berarti putar ulang lebih lambat.

EffectTrackItem: Informasi klip trek efek

Jenis EffectTrackItem mencakup VFX dan filter.

Nama

Tipe

Diperlukan

Deskripsi

Type

String

Ya

Jenis klip trek efek. Nilai yang didukung: VFX, Filter.

SubType

String

Ya

Subtipe klip track efek. Untuk informasi selengkapnya tentang efek yang didukung, lihat Contoh efek dan Contoh efek filter.

TimelineIn

Float

Tidak

Posisi awal klip efek pada timeline. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika TimelineIn tidak ditentukan, default adalah 0.

TimelineOut

Float

Tidak

Posisi akhir klip efek pada timeline. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika TimelineOut tidak ditentukan, default adalah waktu akhir video.

Durasi

Float

Tidak

Durasi klip efek pada timeline. Satuan: detik. Nilai akurat hingga empat tempat desimal. Jika Duration tidak ditentukan, default adalah durasi video.

Catatan

Hanya salah satu dari Duration dan TimelineOut yang berlaku.

X

Float

Tidak

Parameter ini hanya didukung ketika SubType diatur ke mosaic_rect/blur. Jarak horizontal dari sudut kiri atas area efek ke sudut kiri atas video output.

Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari lebar video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

Y

Float

Tidak

Parameter ini hanya didukung ketika SubType diatur ke mosaic_rect/blur.

Jarak vertikal dari area efek ke sudut kiri atas video output. Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari tinggi video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

Width

Float

Tidak

Parameter ini hanya didukung ketika SubType diatur ke mosaic_rect/blur. Lebar area efek dalam video output. Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari lebar video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

Height

Float

Tidak

Parameter ini hanya didukung ketika SubType diatur ke mosaic_rect/blur. Tinggi area efek dalam video output. Catatan: Nilai persentase dan piksel didukung. Nilai dari 0 hingga 0,9999 mewakili persentase dari tinggi video output. Nilai integer 2 atau lebih besar mewakili nilai piksel absolut.

FontFace: Gaya font

Nama

Type

Diperlukan

Deskripsi

Bold

Boolean

Tidak

Tebal.

Italic

Boolean

Tidak

Miring.

Underline

Boolean

Tidak

Garis bawah.

Effect: Informasi efek

Jenis efek yang berbeda memiliki properti unik selain serangkaian properti umum.

Untuk informasi selengkapnya tentang parameter efek, lihat Konfigurasi efek.

Properti umum Effect adalah sebagai berikut:

Nama

Tipe

Diperlukan

Deskripsi

Tipe

String

Ya

Jenis efek. Nilai yang valid:

  • Text: teks banner, materi trek video.

  • DeWatermark: penyembunyian, materi trek video.

  • Crop: pemotongan, materi trek video.

  • Scale: penskalaan, materi trek video.

  • Pad: padding, materi trek video.

  • Background: pengaturan latar belakang, materi trek video.

  • Transition: transisi, materi trek video.

  • VFX: efek, materi trek video.

  • Filter: filter, materi trek video.

  • Volume: penyesuaian volume, materi trek audio.

  • AFade: fade in dan fade out audio, materi trek audio.

  • Rotate: rotasi materi, materi trek video.

  • Clip: pemotongan acak.

  • Flip: flip.

  • KenBurns: efek Ken Burns.

  • Zoom: zoom.

SubTipe

String

Tidak

Subtipe efek.

  • Jika Anda mengatur Tipe ke Transition, parameter ini menunjukkan subtipe dari efek transisi. Untuk informasi lebih lanjut tentang parameter ini, lihat Contoh efek transisi.

  • Jika Anda mengatur Type ke VFX, parameter ini menunjukkan subtipe efek visual. Untuk daftar nilai yang didukung, lihat Contoh efek visual.

  • Jika Anda mengatur Tipe ke Filter, parameter ini menunjukkan subtipe dari efek filter. Untuk informasi lebih lanjut tentang parameter ini, lihat Contoh efek filter.

Tangkapan video/Stiker animasi

SnapshotJob: Informasi pekerjaan snapshot

Nama

Tipe

Deskripsi

JobId

String

ID pekerjaan.

VodTemplateInfo: Informasi template snapshot

Nama

Type

Deskripsi

Name

String

Nama template.

VodTemplateId

String

ID template.

TemplateType

String

Jenis template. Nilai yang valid:

  • Snapshot: Gambar yang diambil dari layar.

  • DynamicImage: Merepresentasikan gambar animasi.

IsDefault

String

Menunjukkan apakah ini adalah template default. Nilai yang valid:

  • Default: watermark default

  • NotDefault: bukan watermark default

TemplateConfig

JSON

Konfigurasi template terperinci, yang merupakan string JSON. Nilai yang valid:

CreationTime

String

Waktu pembuatan, dalam UTC.

ModifyTime

String

Waktu modifikasi, dalam UTC.

MediaSnapshot: Data snapshot media

Nama

Tipe

Deskripsi

JobId

String

ID pekerjaan snapshot.

CreationTime

String

Waktu saat pekerjaan snapshot dibuat. Waktu dalam UTC.

Total

Long

Jumlah total snapshot.

Regular

String

Aturan untuk menghasilkan URL snapshot.

Snapshots

Snapshot[]

Data snapshot.

Snapshot: Informasi snapshot

Nama

Tipe

Deskripsi

Index

String

Nilai indeks snapshot.

Url

String

URL snapshot.

DynamicImage: Informasi stiker animasi

Nama

Tipe

Deskripsi

VideoId

String

ID video.

DynamicImageId

String

ID stiker animasi.

FileURL

String

URL file stiker animasi.

Width

String

Lebar stiker animasi.

Height

String

Tinggi stiker animasi.

Duration

String

Durasi stiker animasi.

Format

String

Format gambar animasi. Nilai yang valid: gif atau webp.

FileSize

String

Ukuran file stiker animasi.

Fps

String

Laju frame stiker animasi.

Watermark video

WatermarkInfo: Informasi watermark

Nama

Tipe

Diperlukan

Deskripsi

CreationTime

String

Ya

Waktu saat watermark dibuat.

Name

String

Ya

Nama dari watermark.

IsDefault

String

Ya

Menentukan apakah watermark adalah default. Nilai yang valid:

  • Default: Watermark yang digunakan secara default.

  • NotDefault: Menentukan watermark non-default.

Type

String

Ya

Tipe dari watermark. Nilai yang valid:

  • Image

  • Text

WatermarkId

String

Ya

ID dari watermark.

FileUrl

String

Tidak

URL file watermark. URL dapat berupa URL OSS atau CDN. Parameter ini tidak dikembalikan untuk watermark teks.

WatermarkConfig

WatermarkConfig

Ya

Konfigurasi untuk watermark teks atau gambar, seperti posisi dan efeknya. Nilainya adalah string JSON.

Transkoding audio dan video

TranscodeJob: informasi tentang pekerjaan transkoding

Nama

Type

Deskripsi

JobId

String

ID pekerjaan transkoding.

TranscodeTemplateGroup: Kelompok template transkoding

Nama

Jenis

Diperlukan

Deskripsi

Nama

String

Ya

Nama kelompok template.

TranscodeTemplateGroupId

String

Ya

ID kelompok template transkoding.

IsDefault

String

Ya

Menentukan apakah ini adalah kelompok template default. Nilai yang valid:

  • Default: Kelompok template adalah default.

  • NotDefault: Kelompok template bukan default.

CreationTime

String

Ya

Waktu pembuatan kelompok template transkoding.

ModifyTime

String

Ya

Waktu terakhir kelompok template dimodifikasi.

TranscodeTemplateList

TranscodeTemplate[]

Ya

Daftar konfigurasi template transkoding.

TranscodeTemplate: Konfigurasi template transkoding

Nama

Tipe

Diperlukan

Deskripsi

Tipe

String

Tidak

Jenis template. Nilai yang valid:

  • Normal: Template transkoding normal.

    Anda tidak dapat mengatur parameter PackageSetting untuk jenis template ini.

  • VideoPackage: Template pengemasan aliran video.

    Jenis template ini pertama-tama mentranskoding video dan kemudian membuat aliran bitrate adaptif. Anda harus mengonfigurasi parameter PackageSetting.

  • SubtitlePackage: Template pengemasan keterangan.

    Jenis template ini tidak mentranskode video. Template ini hanya mengemas informasi caption yang ditentukan ke dalam file output bitrate adaptif. Anda harus mengatur parameter PackageSetting. Jenis template ini tidak dapat digunakan sendiri dalam kelompok template. Template ini harus dikonfigurasi dengan template jenis VideoPackage & kelompok template hanya dapat berisi satu template jenis ini.

Nilai default: Normal.

Video

Video

Ya

Parameter transkoding untuk aliran video. Nilainya adalah string JSON.

Audio

Audio

Ya

Parameter transkoding untuk aliran audio. Nilainya adalah string JSON.

Definition

String

Ya

Penanda definisi untuk template transkoding normal. Nilai yang valid:

  • LD: Definisi rendah.

  • SD: Definisi standar.

  • HD: Definisi tinggi.

  • FHD: Ultra definisi tinggi.

  • OD: Kualitas asli. Nilai ini digunakan untuk konversi format kontainer.

  • 2K

  • 4K

  • SQ: Audio kualitas standar.

  • HQ: Audio kualitas tinggi.

Catatan
  • Definisi ini adalah penanda data untuk template transkoding. Definisi ini tidak merepresentasikan spesifikasi output aktual, seperti rentang resolusi, dari video. Untuk informasi selengkapnya tentang pemetaan antara definisi dan spesifikasi output, lihat Spesifikasi.

  • Penanda definisi ini tidak memengaruhi penagihan transkoding. Untuk informasi selengkapnya tentang spesifikasi penagihan transkoding, seperti rentang resolusi, lihat Paket durasi transkoding ApsaraVideo VOD.

Penanda definisi untuk template transkoding Narrowband HD 1.0 bawaan. Nilai yang valid:

  • LD-NBV1: Definisi rendah.

  • SD-NBV1: Definisi standar.

  • HD-NBV1: Definisi tinggi.

  • FHD-NBV1: Ultra definisi tinggi.

  • 2K-NBV1

  • 4K-NBV

Catatan
  • Anda tidak dapat memodifikasi penanda definisi untuk template transkoding apa pun.

  • Resolusi audio, resolusi video, bitrate, dan parameter lainnya dari template transkoding Narrowband HD 1.0 bersifat bawaan dan tidak dapat dimodifikasi. Untuk informasi selengkapnya tentang parameter tersebut, lihat Transkoding Narrowband HD.

  • Anda hanya dapat membuat template transkoding Narrowband HD 1.0 untuk format output FLV, M3U8 (HLS), dan MP4.

Container

Container

Ya

Format kontainer untuk mengenkapsulasi aliran audio dan video. Nilainya adalah string JSON.

MuxConfig

MuxConfig

Tidak

Konfigurasi sharding untuk transkoding. Parameter ini diperlukan untuk transkoding HLS. Nilainya adalah string JSON.

TransConfig

TransConfig

Tidak

Parameter transkoding kondisional. Atur parameter ini untuk melakukan pemeriksaan logis berdasarkan bitrate dan resolusi file sumber sebelum menghasilkan video output. Nilainya adalah string JSON.

TranscodeFileRegular

String

Tidak

Jalur output kustom untuk file yang ditranskoding.

Catatan
  • Karakter wildcard berikut didukung: {MediaId} (ID video), {JobId} (ID pekerjaan transkoding), dan {PlayDefinition} (penanda definisi yang dikembalikan oleh operasi GetPlayInfo).

  • Nilainya hanya dapat berisi digit, huruf, tanda kurung kurawal ({}), garis miring (/), tanda hubung (-), dan garis bawah (_). Nilainya dapat mencapai panjang 128 karakter.

  • Jalur output kustom harus dimulai dengan {MediaId}.

Contoh konfigurasi

{MediaId}/watermark-{PlayDefinition}. Selama transkoding, {MediaId} diganti dengan ID video, seperti 8ff5cc93f6da4079a47a77bf71d, dan {PlayDefinition} diganti dengan penanda definisi, seperti fd.

Contoh output

8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4. Ekstensi file, seperti .mp4, .m3u8, atau .flv, ditambahkan secara otomatis.

Clip

Clip

Tidak

Konfigurasi pemotongan video. Nilainya adalah string JSON.

Sebagai contoh, atur parameter ini untuk mengekstrak klip 5 detik dari video untuk menghasilkan video baru.

Rotate

String

Tidak

Sudut rotasi video, dalam derajat. Nilai yang valid: [0, 360].

Sebagai contoh, nilai 180 membalik video secara terbalik.

EncryptSetting

EncryptSetting

Tidak

Konfigurasi enkripsi untuk transkoding.

PackageSetting

PackageSetting

Tidak

Konfigurasi pengemasan. Hanya pengemasan aliran bitrate adaptif HLS dan pengemasan DASH yang didukung. Nilainya adalah string JSON.

SubtitleList

SubtitleConfig

Tidak

Konfigurasi keterangan. Nilainya adalah string JSON.

WatermarkIds

String[]

Tidak

ID watermark yang akan dikaitkan dengan video output. Anda dapat mengaitkan maksimal empat watermark. Kata kunci `USER_DEFAULT_WATERMARK` merepresentasikan ID watermark default.

TranscodeTemplateId

String

Tidak

ID template transkoding. Parameter ini diperlukan saat Anda memodifikasi template.

TemplateName

String

Tidak

Nama template transkoding. Parameter ini diperlukan saat Anda menambahkan template.

Contoh Parameter TranscodeTemplate

{
        "Type":"VideoPackage",
        "Video":{
                "Codec":"H.264",
                "Bitrate":"900",
                "Width":"960",
                "Remove":"false",
                "Fps":"30"
        },
        "Audio":{
                "Codec":"AAC",
                "Bitrate":"128",
                "Samplerate":"44100"
        },
        "Container":{
                "Format":"m3u8"
        },
        "MuxConfig":{
                "Segment":{
                        "Duration":"6"
                }
        },
        "EncryptSetting":{
                "EncryptType":"AliyunVoDEncryption"
        },
        "PackageSetting":{
                "PackageType":"HLSPackage"
                "PackageConfig":{
                        "BandWidth":"900000"
                }
        },
       "SubtitleUrl": "http://outin-40564284ef058b2163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****-cn.ass",
        "CharEncode": "UTF-8",
        "WatermarkIds":["USER_DEFAULT_WATERMARK","ddddddddd"],
        "Definition":"SD",
        "TemplateName":"test"
}
                        

Video: Konfigurasi aliran video transkoding

Catatan
  • Dalam kebanyakan kasus, Anda cukup mengatur parameter Codec, Bitrate, Height, dan Width serta menyetel parameter Remove ke false.

  • Untuk mempertahankan rasio aspek video sumber, atur hanya salah satu parameter Width atau Height untuk video output.

Nama

Tipe

Diperlukan

Deskripsi

Codec

String

Ya

Format encoding video. Nilai yang valid: H.264 dan H.265.

Remove

String

Ya

Menentukan apakah aliran video dihapus dari file output. Nilai yang valid:

  • true: Aliran video dihapus.

  • false: Aliran video dipertahankan.

Default: false.

Bitrate

String

Tidak

Bitrate target video output, dalam Kbps. Jika tidak ditentukan, bitrate ditentukan oleh nilai Crf.

Rentang nilai: 10 hingga 50.000.

Height

String

Tidak

Tinggi video output dalam piksel. Nilainya harus kelipatan 2 dalam rentang 128 hingga 4096. Jika parameter ini tidak ditentukan, tinggi file sumber digunakan.

Width

String

Tidak

Lebar video output dalam piksel. Nilai harus kelipatan 2 dalam rentang [128, 4096]. Jika tidak ditentukan, lebar video sumber digunakan.

Fps

String

Tidak

Jika Anda tidak menentukan parameter ini, laju frame file sumber digunakan. Nilainya harus lebih besar dari 0 dan tidak lebih dari 60 FPS.

Gop

String

Tidak

Interval antara keyframe yang berdekatan dalam frame. Rentang yang valid adalah 1 hingga 100.000.

LongShortMode

String

Tidak

Mengaktifkan rotasi otomatis untuk video lanskap dan potret (pola tepi panjang/pendek). Lebar output yang ditranskoding sesuai dengan tepi panjang video input (tinggi video potret), dan tinggi sesuai dengan tepi pendek (lebar video potret). Nilai:

  • true: Diaktifkan.

  • false: Dinonaktifkan.

Default: true. Pengaturan ini direkomendasikan untuk video potret.

Crf

String

Tidak

Parameter ini menentukan faktor kontrol kualitas-bitrate dan menggantikan parameter `Bitrate`. Nilai yang lebih tinggi menghasilkan kualitas video yang lebih rendah dan ukuran file yang lebih kecil. Sebaliknya, nilai yang lebih rendah menghasilkan kualitas video yang lebih tinggi dan ukuran file yang lebih besar, tetapi meningkatkan waktu transkoding. Nilainya dapat berkisar dari 0 hingga 51.

Default: 26. Mengubah nilai ini tidak disarankan.

Profile

String

Tidak

Profil encoding. Nilai yang valid adalah:

  • baseline: Cocok untuk perangkat seluler.

  • main: Cocok untuk perangkat definisi standar.

  • high: Cocok untuk perangkat definisi tinggi.

Nilai default adalah high. Saat ini, hanya H.264 yang mendukung parameter ini.

Praktik terbaik

Jika Anda membuat beberapa output dengan definisi berbeda, atur profil untuk definisi terendah ke baseline. Ini memastikan kompatibilitas dengan perangkat lama. Gunakan main atau high untuk definisi lainnya.

Preset

String

Tidak

Nilai yang valid: veryfast, fast, medium, slow, slower.

Default: medium. Mengubah nilai ini tidak disarankan.

ScanMode

String

Tidak

Mode pemindaian. Nilai valid:

  • interlaced: Pemindaian interlaced.

  • progressive: Pemindaian progresif.

Bufsize

String

Tidak

Ukuran buffer dalam KB. Nilainya harus dari 1000 hingga 128000.

Default: 6.000.

Maxrate

String

Tidak

Bitrate puncak video dalam kbps. Nilainya harus bilangan bulat dari 1000 hingga 50000.

PixFmt

String

Tidak

Format warna video. Nilai yang valid mencakup format standar, seperti yuv420p dan yuvj420p.

Nilai default: yuv420p atau format warna video input.

Contoh Parameter Video

{
        "Codec":"H.264",
        "Bitrate":"128",
        "Remove":"false",
        "Width":"640",
        "Fps":"30"
}

Audio: Konfigurasi transkoding untuk aliran audio

Catatan

Dalam kebanyakan kasus, Anda cukup mengatur parameter Codec dan Bitrate serta menyetel parameter Remove ke false.

Nama

Tipe

Diperlukan

Deskripsi

Codec

String

Ya

Format coding audio. Nilai yang valid: AAC dan MP3.

Bitrate

String

Ya

Bitrate output audio. Satuan: Kbps. Nilainya harus bilangan bulat dari 8 hingga 1000.

Remove

String

Ya

Menentukan apakah aliran audio dihapus.

  • true: Menghapus aliran audio dari file output yang ditranskoding.

  • false: Menyimpan aliran audio dalam file output yang ditranskoding.

Nilai default: false.

Samplerate

String

Ya

Sample rate. Satuan: Hz. Nilai valid: 22050, 32000, 44100, 48000, dan 96000.

Nilai default: 44100.

Jika format kontainer video adalah FLV dan format coding audio adalah MP3, laju sampel 32000, 48000, dan 96000 tidak didukung.

Jika format coding audio adalah MP3, laju sampel 96000 tidak didukung.

Channels

String

Tidak

Jumlah saluran suara. Nilai default: 2.

  • Jika Codec diatur ke MP3, jumlah saluran hanya bisa 1 atau 2.

  • Jika Codec diatur ke AAC, jumlah saluran bisa 1, 2, 4, 5, 6, atau 8.

Profile

String

Tidak

Profil coding audio. Jika Codec diatur ke AAC, nilai yang valid adalah aac_low, aac_he, aac_he_v2, aac_ld, dan aac_eld.

Volume

Volume

Tidak

Parameter volume.

Contoh Parameter Audio

{
        "Codec":"AAC",
        "Bitrate":"128",
        "Remove":"false",
        "Samplerate":"44100"
}

Container: format kontainer

Nama

Tipe

Diperlukan

Deskripsi

Format

String

Ya

Format kontainer.

  • Transkoding video mendukung FLV, MP4, dan HLS (M3U8 dan TS).

  • Transkoding audio mendukung MP3 dan MP4.

  • Jika format kontainer adalah FLV, kodek video tidak dapat diatur ke H.265.

Contoh Parameter Container

{
        "Format":"mp4"
}

MuxConfig: konfigurasi segmen untuk HLS

Catatan

Anda harus menentukan parameter ini jika format kontainer diatur ke M3U8.

Nama

Type

Diperlukan

Deskripsi

Segment

Segment

Ya

Konfigurasi segmen. Nilainya harus berupa objek JSON.

Segment: Konfigurasi segmen terperinci

Nama

Tipe

Diperlukan

Deskripsi

Duration

String

Ya

Durasi segmen TS. Nilainya harus berupa bilangan bulat. Nilai valid: [1,60]. Satuan: detik.

Contoh: {"Duration":"10"}.

Contoh Parameter MuxConfig

{
        "Segment":{
                "Duration":"10"
        }
}

TransConfig: konfigurasi transkoding kondisional

Nama

Type

Diperlukan

Deskripsi

TransMode

String

Tidak

Mode transkoding. Nilai valid:

  • onepass: Mode bitrate rata-rata (ABR). Mode ini memberikan kecepatan encoding yang lebih cepat daripada mode twopass. Ini adalah codec default untuk Alibaba Cloud.

  • twopass: Mode bitrate variabel (VBR). Encoder berjalan dua kali untuk menetapkan bitrate secara akurat. Ini menghasilkan file yang lebih kecil dengan kualitas lebih tinggi. Mode twopass membutuhkan waktu lebih lama daripada mode onepass. Oleh karena itu, mode ini tidak cocok untuk skenario yang sensitif terhadap waktu seperti streaming langsung dan komunikasi real-time. Jangan gunakan mode twopass jika video input sudah sangat terkompresi. Hal ini dapat menyebabkan artefak blocking.

  • CBR: Mode bitrate konstan (CBR). File memiliki bitrate konstan dari awal hingga akhir. Dibandingkan dengan VBR dan ABR, mode ini menghasilkan file yang lebih besar tanpa peningkatan signifikan dalam kualitas video.

Default: onepass.

IsCheckReso

String

Tidak

Menentukan apakah akan memeriksa resolusi sumber untuk menentukan apakah transkoding harus menggunakan resolusi asli. Nilai yang valid:

  • true: Memeriksa resolusi. Jika resolusi output lebih tinggi daripada resolusi sumber, berdasarkan lebar atau tinggi, resolusi output diatur ke resolusi sumber.

  • false: Tidak dilakukan pemeriksaan.

Default: false.

IsCheckResoFail

String

Tidak

Menentukan apakah transkoding gagal berdasarkan resolusi video sumber. Nilai:

  • true: Memeriksa resolusi. Jika resolusi output lebih tinggi daripada resolusi sumber, berdasarkan lebar atau tinggi, tugas transkoding gagal.

  • false: Tidak dilakukan pemeriksaan.

Default: false.

IsCheckVideoBitrate

String

Tidak

Menentukan apakah akan memeriksa bitrate aliran video sumber untuk menentukan apakah transkoding harus menggunakan bitrate video asli. Nilai yang valid:

  • true: Memeriksa bitrate video. Jika bitrate video output lebih tinggi daripada bitrate video sumber, bitrate video output diatur ke bitrate video sumber.

  • false: Tidak melakukan pemeriksaan.

Default: false.

IsCheckVideoBitrateFail

String

Tidak

Anda dapat menentukan apakah transkoding gagal dengan memeriksa bitrate aliran video sumber. Nilai yang mungkin:

  • true: Memeriksa bitrate video. Jika bitrate video output lebih tinggi daripada bitrate video sumber, tugas transkoding gagal.

  • false: Tidak melakukan pemeriksaan.

Default: false. Parameter ini memiliki prioritas lebih tinggi daripada IsCheckVideoBitrate.

IsCheckAudioBitrate

String

Tidak

Menentukan apakah akan memeriksa bitrate aliran audio sumber untuk menentukan apakah transkoding harus menggunakan bitrate audio asli. Nilai yang valid:

  • true: Memeriksa bitrate audio. Jika bitrate audio output lebih tinggi daripada bitrate audio sumber, bitrate audio output diatur ke bitrate audio sumber.

  • false: Tidak melakukan pemeriksaan.

Default: false.

IsCheckAudioBitrateFail

String

Tidak

Anda dapat memeriksa bitrate aliran audio sumber untuk menentukan apakah transkoding gagal. Nilai yang valid:

  • true: Memeriksa bitrate audio. Jika bitrate audio output lebih tinggi daripada bitrate audio sumber, tugas transkoding gagal.

  • false: Tidak melakukan pemeriksaan.

Default: false. Parameter ini memiliki prioritas lebih tinggi daripada IsCheckAudioBitrate.

Contoh Parameter TransConfig

{
        "IsCheckReso":"true",
        "IsCheckResoFail":"false",
        "IsCheckVideoBitrate":"false",
        "IsCheckVideoBitrateFail":"false",
        "IsCheckAudioBitrate":"false",
        "IsCheckAudioBitrateFail":"false"
}

Clip: Pengaturan Pemotongan Video

Nama

Tipe

Diperlukan

Deskripsi

TimeSpan

TimeSpan

Ya

Parameter waktu yang digunakan untuk memotong video.

TimeSpan: Pengaturan Pemotongan Video

Nama

Tipe

Diperlukan

Deskripsi

Seek

String

Ya

Waktu mulai untuk pemotongan video.

  • Format 1: sssss[.SSS]. Nilai yang valid: [0.000, 86399.999].

    Contoh: 12000.55.

  • Format 2: hh:mm:ss[.SSS]. Nilai yang valid: [00:00:00.000, 23:59:59.999]. Contoh: 00:00:05.003.

Gunakan Format 1.

Duration

String

Tidak

Durasi pemotongan video.

  • Format 1: sssss[.SSS]. Nilai yang valid: [0.000, 86399.999].

    Contoh: 12000.55.

  • Format 2: hh:mm:ss[.SSS]. Nilai yang valid: [00:00:00.000, 23:59:59.999]. Contoh: 00:00:05.003.

Gunakan Format 1.

Catatan

Atur salah satu parameter Duration atau End. Jika Anda mengatur keduanya, End yang diutamakan.

End

String

Tidak

Durasi yang dipangkas dari akhir video.

  • Format 1: sssss[.SSS]. Nilai yang valid: [0.000, 86399.999].

    Contoh: 12000.55.

  • Format 2: hh:mm:ss[.SSS]. Nilai yang valid: [00:00:00.000, 23:59:59.999]. Contoh: 00:00:05.003.

Gunakan Format 1.

Catatan
  • Atur salah satu parameter Duration atau End. Jika Anda mengatur keduanya, End yang diutamakan.

  • Durasi antara waktu mulai dan waktu akhir tidak boleh melebihi durasi total video.

EncryptSetting: konfigurasi enkripsi untuk transkoding

Catatan

Untuk menggunakan enkripsi HLS, atur parameter EncryptType ke AliyunVoDEncryption dalam template transkoding. Kemudian, konfigurasikan parameter EncryptConfig saat Anda memanggil API untuk mengirimkan pekerjaan transkoding media.

Nama

Tipe

Diperlukan

Deskripsi

EncryptType

String

Ya

Jenis enkripsi. Nilai valid:

  • AliyunVoDEncryption: Enkripsi pribadi atau enkripsi HLS untuk video dalam format M3U8.

  • AliyunVoDLicenseEncryption: Enkripsi pribadi untuk video dalam format MP4.

Contoh Parameter EncryptSetting

{
        "EncryptType":"AliyunVoDEncryption"
}

PackageSetting: Pengaturan transkoding dan pengemasan

Catatan
  • Pengemasan aliran audio dan video setelah ekstraksi tidak didukung.

  • Hanya pengemasan bitrate adaptif HLS yang didukung.

Nama

Tipe

Diperlukan

Deskripsi

PackageType

String

Ya

Jenis pengemasan. Atur nilainya ke HLSPackage untuk pengemasan bitrate adaptif HLS.

PackageConfig

PackageConfig

Tidak

Konfigurasi pengemasan. Parameter ini diperlukan untuk template VideoPackage.

SubtitleExtractConfigList

SubtitleExtractConfig[]

Tidak

Konfigurasi pengemasan keterangan. Parameter ini diperlukan untuk template SubtitlePackage. Jangan tentukan parameter ini untuk jenis template lainnya.

PackageConfig: konfigurasi pengemasan video

Catatan

Parameter ini hanya diperlukan untuk pengemasan aliran HLS adaptif.

Nama

Tipe

Diperlukan

Deskripsi

BandWidth

String

Ya

Bandwidth maksimum. Parameter ini diperlukan untuk pengemasan HLS. Satuan: bit/detik.

Konfigurasikan parameter ini hanya untuk VideoPackage.

Contoh Parameter PackageSetting

Kode contoh untuk mengonfigurasi template pengemasan aliran video:
{
        "PackageType":"HLSPackage",
        "PackageConfig":{
                "BandWidth":"400000"
        }
}
                        

SubtitleExtractConfig: Konfigurasi pengemasan keterangan

Nama

Tipe

Diperlukan

Deskripsi

SubtitleUrlList

String[]

Ya

URL file subtitle. Hanya URL OSS HTTP yang didukung. URL CDN HTTP dan HTTPS tidak didukung.

Catatan
  • Hanya satu URL HTTP yang didukung.

  • Simpan file subtitle hanya di bucket sistem yang dialokasikan oleh video-on-demand.

Bahasa

String

Ya

Bahasa subtitle, seperti en-US. Untuk informasi lebih lanjut, lihat RFC 5646.

Format

String

Ya

Format file subtitle. Hanya format VTT yang didukung. Misalnya, subtitle.vtt.

Nama

String

Ya

Nama tampilan trek subtitle di pemutar, seperti Bahasa Tiongkok atau Bahasa Inggris.

Contoh Parameter SubtitlePackage

Contoh kode untuk mengonfigurasi template pengemasan subtitle:
 {
      "PackageType": "HLSPackage",
      "SubtitleExtractConfigList": [
        {
          "SubtitleUrlList": [
            "http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4bff3675-79a5-40fa-8c86-1f98169d****-eng.vtt"
          ],
          "Language": "en-US",
          "Format": "vtt",
          "Name": "Inggris"
        },
        {
          "SubtitleUrlList": [
            "http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/a3f50b08-11c3-4511-94cf-7fd4f7a5****-jpn.vtt"
          ],
          "Language": "ja",
          "Format": "vtt",
          "Name": "Jepang"
        },
        {
          "SubtitleUrlList": [
            "http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4dba87c2-a787-42cd-8328-2369aeb8****-cn.vtt"
          ],
          "Language": "cn",
          "Format": "vtt",
          "Name": "Cina"
        }
      ]
    }

SubtitleConfig: Konfigurasi subtitle

Nama

Tipe

Diperlukan

Deskripsi

SubtitleUrl

String

Ya

URL OSS file subtitle. URL HTTPS dan nama domain yang dipercepat CDN tidak didukung. Format subtitle yang didukung: srt dan ass.

Catatan

File subtitle dan file sumber video harus disimpan di bucket yang sama di wilayah yang sama, seperti wilayah Tiongkok (Shanghai).

CharEncode

String

Ya

Format encoding. Nilai yang valid:

  • auto: Deteksi otomatis.

  • UTF-8

  • GBK

  • BIG5

Nilai default: UTF-8.

Catatan

Untuk informasi selengkapnya tentang cara mengunggah file subtitle, lihat CreateUploadAttachedMedia dan Unggahan file OSS.

Contoh Parameter SubtitleConfig

{
        "SubtitleUrl": "http://outin-40564284ef058b2d300163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****.ass",
        "CharEncode": "UTF-8"
}

Konfigurasi volume

Nama

Tipe

Diperlukan

Deskripsi

Method

String

Tidak

Metode penyesuaian volume. Nilai yang valid: auto, dynamic, dan linear.

IntegratedLoudnessTarget

String

Tidak

Volume target. Nilainya harus angka dari -70 hingga -5. Parameter ini hanya diperlukan ketika Method diatur ke dynamic.

Nilai default: -6.

TruePeak

String

Tidak

Volume puncak. Nilainya harus angka dari -9 hingga 0. Parameter ini hanya diperlukan ketika Method diatur ke dynamic.

Nilai default: -1.

LoudnessRangeTarget

String

Tidak

Rentang volume. Nilainya harus angka dari 1 hingga 20. Parameter ini hanya diperlukan ketika Method diatur ke dynamic.

Nilai default: 8.

Contoh Parameter Volume

{
        "Method":"dynamic",
        "IntegratedLoudnessTarget":"-6",
        "TruePeak":"-1",
        "LoudnessRangeTarget":"8"
}

Kombinasi format kontainer dan format penyandian audio yang didukung

Kontainer

Codec Audio

mp3

MP3

mp4

AAC

ogg

VORBIS dan FLAC

flac

FLAC

Kombinasi format kontainer, format penyandian audio, dan format penyandian video yang didukung

Kontainer

Codec Video

Codec Audio

flv

H.264

AAC dan MP3

mp4

H.264 dan H.265

AAC dan MP3

ts

H.264 dan H.265

AAC dan MP3

m3u8

H.264 dan H.265

AAC dan MP3

gif

GIF

Tidak didukung

Kombinasi format penyandian video dan parameter aliran video yang didukung

Codec Video

H.264

H.265

GIF

Profile

×

×

Bitrate

×

Crf

×

Width

Height

Fps

Gop

×

Preset

×

×

ScanMode

Bufsize

×

Maxrate

×

PixFmt

bgr8

TranscodeSummary: Ringkasan transkoding

Nama

Tipe

Deskripsi

VideoId

String

ID video.

TranscodeTemplateGroupId

String

ID kelompok template transkoding.

TranscodeStatus

String

Status tugas transkoding. Nilai yang valid:

  • Processing: Operasi sedang berjalan.

  • Partial: Beberapa pekerjaan transkoding selesai.

  • CompleteAllSucc: Semua pekerjaan transkoding berhasil diselesaikan.

  • CompleteAllFail: Semua pekerjaan transkoding gagal. Jika file sumber tidak valid, tidak ada pekerjaan transkoding yang dimulai, dan seluruh tugas transkoding gagal.

  • CompletePartialSucc: Semua pekerjaan transkoding selesai, tetapi hanya sebagian yang berhasil.

TranscodeJobInfoSummaryList

TranscodeJobInfoSummary[]

Ringkasan pekerjaan transkoding.

CreationTime

String

Waktu pembuatan pekerjaan transkoding. Waktu dalam UTC. Formatnya adalah yyyy-MM-ddTHH:mm:ssZ.

CompleteTime

String

Waktu saat pekerjaan transkoding selesai. Waktu dalam UTC dan mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ.

TranscodeJobInfoSummary: ringkasan dari pekerjaan transkoding

Nama

Tipe

Deskripsi

TranscodeTemplateId

String

ID dari template transkoding.

Width

String

Lebar video output. Satuan: piksel.

Height

String

Tinggi video output. Satuan: piksel.

Durasi

String

Durasi video keluaran. Satuan: detik.

Filesize

String

Ukuran file video keluaran. Satuan: byte.

Bitrate

String

Bitrate rata-rata video output. Satuan: kbps.

Fps

String

Tingkat frame video keluaran. Satuan: frame per detik.

Format

String

Format kontainer video keluaran.

WatermarkIdList

String[]

Daftar ID watermark yang digunakan untuk transkoding.

TranscodeProgress

Long

Kemajuan transkoding. Nilainya berkisar dari 0 hingga 100.

TranscodeJobStatus

String

Status pekerjaan transkoding. Nilai valid:

  • Transcoding: Pekerjaan sedang berlangsung.

  • TranscodeSuccess: Pekerjaan berhasil.

  • TranscodeFail: Pekerjaan gagal.

CreationTime

String

Waktu saat pekerjaan transkoding dibuat. Waktu dalam UTC dan menggunakan format yyyy-MM-ddTHH:mm:ssZ.

CompleteTime

String

Waktu saat pekerjaan transkoding selesai. Waktu dalam UTC dan menggunakan format yyyy-MM-ddTHH:mm:ssZ.

ErrorCode

String

Kode kesalahan yang dikembalikan jika pekerjaan transkoding gagal.

ErrorMessage

String

Pesan kesalahan yang dikembalikan jika pekerjaan transkoding gagal.

TranscodeTask: Informasi pekerjaan transkoding

Nama

Tipe

Deskripsi

TranscodeTaskId

String

ID tugas transkoding.

TranscodeTemplateGroupId

String

ID kelompok template transkoding.

VideoId

String

ID video.

TaskStatus

String

Status tugas transkoding. Nilai yang valid:

  • Processing...

  • Partial: Beberapa pekerjaan transkoding selesai.

  • CompleteAllSucc: Semua pekerjaan transkoding selesai dan berhasil.

  • CompleteAllFail: Semua pekerjaan transkoding gagal. Jika file sumber tidak valid, tidak ada pekerjaan transkoding yang dimulai, dan seluruh tugas transkoding gagal.

  • CompletePartialSucc: Semua pekerjaan transkoding selesai, tetapi hanya sebagian yang berhasil.

CreationTime

String

Waktu saat tugas transkoding dibuat. Waktu dalam UTC dan mengikuti format yyyy-MM-ddTHH:mm:ssZ.

CompleteTime

String

Waktu saat tugas transkoding selesai. Waktu dalam UTC dan mengikuti format yyyy-MM-ddTHH:mm:ssZ.

Trigger

String

Jenis pemicu. Nilai yang valid:

  • Auto: Unggah video dan secara otomatis memicu.

  • Manual: Transkoding dipicu dengan memanggil operasi SubmitTranscodeJobs.

TranscodeJobInfoList

TranscodeJobInfo

Informasi tentang pekerjaan transkoding.

TranscodeJobInfo: Informasi pekerjaan transkoding

Nama

Tipe

Deskripsi

TranscodeTaskId

String

ID tugas transkoding.

TranscodeJobId

String

ID dari pekerjaan transkoding.

VideoId

String

ID video.

TranscodeProgress

Panjang

Kemajuan pekerjaan transkoding. Nilai yang valid: [0, 100].

Status Pekerjaan Transkode

String

Status pekerjaan transkoding. Nilai yang valid:

  • Transcoding: Pekerjaan transkoding sedang berlangsung.

  • TranscodeSuccess: Pekerjaan transkoding berhasil.

  • TranscodeFail: Pekerjaan transkoding gagal.

Prioritas

String

Prioritas tugas transkoding.

Definisi

String

Definisi.

Catatan

Tanda definisi yang dikonfigurasi dalam template transkoding. Nilai ini tidak merepresentasikan resolusi aktual file output.

TranscodeTemplateId

String

ID dari template transkoding.

CreationTime

String

Waktu saat pekerjaan transkoding dibuat.

CompleteTime

String

Waktu saat pekerjaan transkoding selesai.

InputFileUrl

String

URL OSS dari file sumber.

OutputFile

OutputFile

Informasi tentang file output.

KodeKesalahan

String

Kode kesalahan yang dikembalikan jika pekerjaan transkoding gagal.

ErrorMessage

String

Pesan kesalahan yang dikembalikan jika pekerjaan transkoding gagal.

OutputFile: File output transkoding

Nama

Tipe

Deskripsi

OutputFileUrl

String

URL OSS dari file output.

Format

String

Format kontainer file output.

Width

String

Lebar gambar file output. Satuan: piksel.

Height

String

Tinggi gambar file output. Satuan: piksel.

Duration

String

Durasi file output. Satuan: detik.

Bitrate

String

Bitrate rata-rata file output. Satuan: kbps.

Fps

String

Frame rate file output. Satuan: frame per detik.

Filesize

Long

Ukuran file output. Satuan: byte.

EncryptType

String

Jenis enkripsi file output. Nilainya adalah string JSON.

WatermarkIdList

String

Daftar ID watermark yang diterapkan pada file output.

VideoStreamList

String

Daftar aliran video. Untuk informasi selengkapnya, lihat VideoStream: Informasi aliran video.

AudioStreamList

String

Daftar aliran audio. Untuk informasi selengkapnya, lihat AudioStream: Informasi aliran audio.

Statistik Data

TopPlayVideoStatis: Statistik Pemutaran Video Harian Teratas

Nama

Tipe

Deskripsi

VideoId

String

ID video.

PlayDuration

String

Durasi pemutaran video. Satuan: milidetik.

Title

String

Judul video.

VV

String

Jumlah tayangan video.

UV

String

Jumlah pengguna pemutaran.

VideoPlayStatisDetail: Statistik pemutaran harian video tertentu

Nama

Tipe

Deskripsi

Date

String

Tanggal dalam format yyyyMMdd.

Contoh: 20170120.

PlayDuration

String

Durasi pemutaran video. Satuan: milidetik.

Title

String

Judul video.

VV

String

Jumlah tayangan video.

UV

String

Jumlah pengguna yang menggunakan pemutaran.

PlayRange

String

Distribusi durasi pemutaran.

UserPlayStatisTotals: statistik total pemutaran per hari

Nama

Tipe

Deskripsi

Date

String

Tanggal dalam format yyyyMMdd.

Contoh: 20170120.

PlayDuration

String

Durasi pemutaran total. Satuan: milidetik.

PlayRange

String

Distribusi durasi pemutaran.

VV

VV

Jumlah total tayangan video.

UV

UV

Jumlah total pengguna pemutaran.

UserPlayStatisAvgs: Statistik rata-rata pemutaran harian per pengguna

Nama

Tipe

Deskripsi

Date

String

Tanggal dalam format yyyyMMdd.

Contoh: 20170120.

AvgPlayDuration

String

Rata-rata durasi pemutaran video. Satuan: milidetik.

AvgPlayCount

String

Rata-rata jumlah tayangan video.

Distribusi Jumlah Tayangan VV

Hanya mendukung statistik untuk pemutaran video yang menggunakan ApsaraVideo Player SDK.

Nama

Tipe

Deskripsi

Android

String

Jumlah total pemutaran pada pemutar Android.

iOS

String

Jumlah total pemutaran dari pemutar iOS.

Flash

String

Jumlah total pemutaran dari pemutar Flash.

HTML5

String

Jumlah total pemutaran dari pemutar HTML5.

Distribusi UV berdasarkan jumlah pemutaran

Hanya mendukung statistik untuk pemutaran video yang menggunakan ApsaraVideo Player SDK.

Nama

Tipe

Deskripsi

Android

String

Jumlah total pengguna yang melakukan pemutaran pada pemutar Android.

iOS

String

Jumlah total pengguna unik untuk pemutaran menggunakan SDK Pemutar Video Apsara untuk iOS.

Flash

String

Jumlah total pengguna untuk pemutaran Pemutar Flash.

HTML5

String

Jumlah total pengguna yang menggunakan pemutar HTML5 untuk pemutaran.

Notifikasi

MessageCallback: Konfigurasi notifikasi event

Nama

Tipe

Deskripsi

CallbackType

String

Metode callback. Nilai yang valid: HTTP dan MNS.

CallbackURL

String

Alamat webhook untuk callback HTTP.

MnsEndpoint

String

Titik akhir Internet publik untuk callback MNS.

MnsQueueName

String

Nama antrian MNS untuk callback MNS.

EventTypeList

String

Tipe acara callback.

AuthSwitch

String

Saklar autentikasi untuk callback HTTP. Nilai yang valid:

  • on: Diaktifkan.

  • off: Dinonaktifkan.

AuthKey

String

Kunci autentikasi untuk callback HTTP.

Sistem Multi-aplikasi

AppInfo: Informasi aplikasi

Nama

Tipe

Deskripsi

AppId

String

ID aplikasi.

AppName

String

Nama aplikasi.

Deskripsi

String

Deskripsi aplikasi.

Tipe

String

Jenis aplikasi. Nilai yang valid:

  • System: Default

  • Custom: dibuat oleh Anda.

Status

String

Status aplikasi. Nilai yang valid:

  • Normal: Menunjukkan status normal.

  • Disable: Aplikasi tidak aktif.

CreationTime

String

Waktu saat aplikasi dibuat, dalam UTC.

ModificationTime

String

Waktu pembaruan dalam UTC.

AppPolicy: Informasi kebijakan otorisasi aplikasi

Nama

Tipe

Deskripsi

AppId

String

ID aplikasi.

PolicyType

String

Jenis kebijakan. Nilai yang valid:

  • System: Kebijakan sistem.

  • Custom: Kebijakan yang ditentukan pengguna.

PolicyName

String

Nama kebijakan.

CreationTime

String

Waktu UTC saat sumber daya dibuat.

Deskripsi

String

Deskripsi kebijakan.