ApsaraVideo VOD:Referensi API Aliplayer

Name

Type

Description

id

String

ID elemen DOM dari kontainer luar pemutar.

source

String

Saat menggunakan pemutaran berbasis URL, tentukan URL video dengan properti ini.

vid

String

ID media untuk layanan ApsaraVideo Media Processing.

playauth

String

Kredensial pemutaran. Untuk petunjuk cara mendapatkan kredensial pemutaran, lihat Dapatkan Kredensial Pemutaran.

customVodServer

String

Domain kustom untuk proxy VOD (didukung dalam mode pemutaran VidAuth versi 2.32.0 dan yang lebih baru). Anda harus men-deploy layanan proxy permintaan khusus. Saat domain VOD default (*.aliyuncs.com) tidak dapat dijangkau, pemutar secara otomatis beralih ke layanan proxy Anda. Hal ini menghindari pembajakan ISP dan meningkatkan stabilitas serta tingkat keberhasilan pemutaran.

playConfig

JSON

Pengaturan kustom yang digunakan saat memutar dengan Vid (VidAuth atau VidSts). Nilai-nilai ini diteruskan ke API VOD. Untuk bidang yang didukung dan deskripsi parameter, lihat Pengaturan PlayConfig Kustom untuk Pemutaran Media. Contoh nilai:

{"PlayDomain":"vod.test_domain","PreviewTime":"20","MtsHlsUriToken":"yqCD7******oVjslp5Q"}

authTimeout

Number

Periode validitas URL pemutaran video yang diperoleh menggunakan Vid (VidAuth atau VidSts). Satuan: detik. Default: 7200.

Pastikan nilai ini melebihi durasi video aktual untuk mencegah URL pemutaran kedaluwarsa sebelum pemutaran selesai.

height

String

Tinggi pemutar. Nilai yang valid:

• 100%

• 100px

width

String

Lebar pemutar. Nilai yang valid:

• 100%

• 100px

autoSize

Boolean | String

Menyesuaikan ukuran pemutar secara otomatis agar sesuai dengan konten video. Nilai yang valid: 'height' atau 'width'.

Misalnya, atur width: '500px' dan autoSize: 'height'. Pemutar mempertahankan lebar tetap 500px dan menyesuaikan tingginya berdasarkan rasio aspek video.

Atau atur height: '500px' dan autoSize: 'width'. Pemutar mempertahankan tinggi tetap 500px dan menyesuaikan lebarnya berdasarkan rasio aspek video.

Catatan: autoSize: true sama dengan autoSize: 'height'. Penyesuaian tinggi otomatis adalah default.

videoWidth

String

Lebar video. Untuk informasi lebih lanjut, lihat Atur Mode Tampilan.

videoHeight

String

Tinggi video. Untuk informasi lebih lanjut, lihat Atur Mode Tampilan.

preload

Boolean

Pemutar dimuat secara otomatis.

cover

String

Gambar sampul default untuk pemutar. Masukkan URL gambar yang valid. Pengaturan ini hanya berlaku ketika autoplay diatur ke false.

isLive

Boolean

Menunjukkan apakah kontennya merupakan streaming langsung. Saat diaktifkan, pengguna tidak dapat menyeret bilah progres. Default: false. Atur ke true untuk streaming langsung.

autoplay

Boolean

Aktifkan putar otomatis untuk pemutar. Putar otomatis gagal pada perangkat seluler. Nilai yang valid:

• true (default): Aktifkan putar otomatis.

• false: Nonaktifkan putar otomatis.

autoplayPolicy

Object

Pemutar mendukung kebijakan adaptif untuk putar otomatis tanpa suara. Properti ini hanya berlaku ketika autoplay diatur ke true. Contoh konfigurasi sebagai berikut:

autoplayPolicy: {
  fallbackToMute: true, // Beralih ke putar otomatis tanpa suara jika putar otomatis bersuara gagal. Default: false.
  showUnmuteBtn: true, // Tampilkan tombol unmute besar saat putar otomatis tanpa suara aktif. Default: true.
}

rePlay

Boolean

Aktifkan putar ulang berulang secara otomatis.

useH5Prism

Boolean

Gunakan pemutar HTML5.

playsinline

Boolean

Aktifkan pemutaran inline untuk HTML5. Beberapa browser Android tidak mendukung fitur ini.

skinRes

Url

URL gambar skin. Kami tidak merekomendasikan mengubah bidang ini. Untuk menyesuaikan skin, lihat Sesuaikan Skin Pemutar.

skinLayout

Array | Boolean

Konfigurasikan tata letak komponen UI. Abaikan properti ini untuk menggunakan tata letak default. Atur ke false untuk menyembunyikan semua komponen UI. Untuk informasi lebih lanjut, lihat Konfigurasikan Properti skinLayout.

skinLayoutIgnore

Array

Daftar komponen UI yang akan disembunyikan. Lihat Referensi Parameter Komponen VOD untuk nama komponen. Contoh konfigurasi:

skinLayoutIgnore: [
  'bigPlayButton', // Sembunyikan tombol play besar.
  'controlBar.fullScreenButton' // Sembunyikan tombol full-screen di control bar (gunakan notasi titik untuk komponen bersarang).
]

controlBarVisibility

String

Implementasi panel kontrol. Nilai yang valid meliputi:

• click: Anda dapat mengklik area pemutar.

• hover (default): Tampilkan saat pengguna mengarahkan kursor ke area pemutar.

• always: Selalu tampilkan control bar.

• Never: Menyembunyikan seluruh panel kontrol.

showBarTime

Number

Waktu dalam milidetik sebelum control bar disembunyikan secara otomatis.

enableSystemMenu

Boolean

Aktifkan menu klik kanan sistem. Default: false.

format

String

Tentukan format URL pemutaran. Nilai yang valid:

• mp4

• hls atau m3u8

• flv

• mp3

Default: kosong.

mediaType

String

Tentukan apakah akan mengembalikan audio atau video. Hanya didukung saat menggunakan pemutaran berbasis vid. Default: video. Nilai yang valid:

• video: Video.

• audio: Format audio saja, seperti file MP4 yang hanya berisi audio.

qualitySort

String

Tentukan urutan pengurutan. Hanya didukung saat menggunakan pemutaran Vid + PlayAuth. Nilai yang valid:

• desc: Urutkan secara menurun (dari besar ke kecil).

• asc: Urutkan secara menaik (dari kecil ke besar).

Default: asc.

definition

String

Tentukan definisi video mana yang akan ditampilkan. Pisahkan beberapa definisi dengan koma (,). Contoh: 'FD,LD'. Ini adalah subset dari definisi yang tersedia untuk vid yang ditentukan. Nilai yang valid:

• FD (definisi rendah)

• LD (definisi standar)

• HD (definisi tinggi)

• HD (resolusi ultra-tinggi)

• OD (kualitas asli)

• 2K (2K)

• 4K (4K)

defaultDefinition

String

Atur definisi video default. Ini harus salah satu dari definisi yang tersedia untuk vid yang ditentukan. Nilai yang valid:

• FD (definisi rendah)

• LD (definisi standar)

• SD (Definisi Standar)

• HD (resolusi ultra-tinggi)

• OD (kualitas asli)

• 2K (2K)

• 4K (4K)

autoPlayDelay

Number

Penundaan sebelum pemutaran dimulai. Satuan: detik.

language

String

Atur bahasa untuk internasionalisasi. Default: zh-cn. Jika diabaikan, bahasa browser akan digunakan. Nilai yang valid:

• zh-cn: Bahasa Tiongkok

• en-us: Bahasa Inggris

languageTexts

JSON

Teks internasionalisasi kustom dalam format JSON. Kunci harus sesuai dengan nilai properti language. Contoh: {jp:{Play:"Play"}}. Untuk daftar lengkap kunci, lihat Struktur JSON.

snapshotWatermark

Object

Konfigurasikan watermark tangkapan layar untuk pemutar HTML5.

useHlsPluginForSafari

Boolean

Aktifkan plugin HLS untuk browser Safari, kecuali Safari 11. Nilai yang valid:

• true: Aktifkan.

• false (default): Nonaktifkan.

enableStashBufferForFlv

Boolean

Aktifkan caching pemutaran untuk FLV di pemutar HTML5. Hanya berlaku untuk streaming langsung. Nilai yang valid:

• true (default): Aktifkan.

• false: Nonaktifkan.

stashInitialSizeForFlv

Number

Ukuran cache awal untuk FLV di pemutar HTML5. Hanya berlaku untuk streaming langsung. Default: 32 KB.

Nilai yang lebih kecil meningkatkan kecepatan startup. Namun, jika terlalu kecil, pemutaran mungkin tersendat setelah waktu singkat.

loadDataTimeout

Number

Waktu dalam detik sebelum meminta pengguna untuk beralih ke definisi yang lebih rendah karena buffering. Default: 20.

waitingTimeout

Number

Timeout buffering maksimum. Pesan error muncul jika waktu ini terlampaui. Satuan: detik. Default: 60.

diagnosisButtonVisible

Boolean

Tampilkan tombol diagnosis. Nilai yang valid:

• true (default): Tampilkan tombol.

• false: Sembunyikan tombol.

disableSeek

Boolean

Nonaktifkan pencarian dengan bilah progres. Nilai yang valid:

• true: Nonaktifkan.

• false (default): Jangan nonaktifkan.

encryptType

Number

Aktifkan enkripsi video Alibaba Cloud (enkripsi privat). Default: 0. Nilai yang valid:

• 0: Putar video tanpa enkripsi.

• 1: Putar video yang dienkripsi secara privat.

progressMarkers

Array

Array objek penanda progres.

vodRetry

Number

Jumlah percobaan ulang untuk kegagalan pemutaran VOD. Default: 3.

liveRetry

Number

Jumlah percobaan ulang untuk kegagalan pemutaran streaming langsung. Default: 5.

hlsFrameChasing

Boolean

Aktifkan frame chasing untuk streaming langsung HLS. Nilai yang valid:

• true: Aktifkan frame chasing.

• false (default): Nonaktifkan frame chasing.

chasingFirstParagraph

Number

Durasi segmen frame-chasing pertama. Satuan: detik. Default: 20.

chasingSecondParagraph

Number

Durasi segmen frame-chasing kedua. Satuan: detik. Default: 40.

chasingFirstSpeed

Number

Kecepatan pemutaran untuk segmen frame-chasing pertama. Default: 1.1×.

chasingSecondSpeed

Number

Kecepatan pemutaran untuk segmen frame-chasing kedua. Default: 1.2×.

hlsOption.maxLiveSyncPlaybackRate

Number

Atur kecepatan pemutaran untuk frame chasing dalam streaming langsung HLS. Default: 1 (tanpa frame chasing).

• Contoh konfigurasi:

  hlsOption: {
    maxLiveSyncPlaybackRate: 1.5, // Atur kecepatan pemutaran frame-chasing.
    liveSyncDurationCount: 3 // Atur jumlah segmen yang memicu frame chasing.
  }

• Makna contoh: Saat latensi streaming langsung melebihi durasi 3 segmen, pemutar diputar dengan kecepatan 1.5× untuk mengejar ketinggalan hingga 3 segmen (karena pemutar memerlukan buffer untuk menangani fluktuasi jaringan, Anda harus memodifikasi nilai liveSyncDurationCount dengan hati-hati — mengatur nilai ini terlalu rendah dapat menyebabkan tersendat).

flvFrameChasing

Boolean

Aktifkan frame chasing untuk streaming langsung FLV. Nilai yang valid:

• true: Aktifkan frame chasing.

• false: Nonaktifkan frame chasing.

Default: false.

keyShortCuts

Boolean

Aktifkan pintasan keyboard. Nilai yang valid:

• true: Aktifkan pintasan keyboard.

• false: Nonaktifkan pintasan keyboard.

Default: false.

keyFastForwardStep

Number

Interval waktu untuk maju cepat dan mundur cepat. Satuan: detik. Default: 10.

rtsFallback

Boolean

Saat browser tidak mendukung RTS atau penarikan aliran RTS gagal, pemutar secara otomatis beralih ke FLV atau HLS. Pemutar lebih memilih FLV untuk latensi yang lebih rendah. Jika browser tidak mendukung FLV, pemutar beralih ke HLS.

Fitur ini diaktifkan secara default. Untuk menonaktifkannya, atur parameter ini ke false.

rtsFallbackType

String

Tentukan protokol yang akan dialihkan dari RTS. Nilai yang valid: HLS atau FLV. Secara default, pemutar memilih secara otomatis, lebih memilih FLV untuk latensi yang lebih rendah. Jika browser tidak mendukung FLV, pemutar beralih ke HLS.

rtsFallbackSource

String

Kami merekomendasikan menggunakan strategi fallback default pemutar. Namun, jika Anda ingin menentukan URL aliran tetap untuk fallback, gunakan parameter ini.

traceId

String

Identifier pengguna unik Anda. Teruskan nilai ini ke titik instrumentasi publik untuk melacak pelaporan log. Secara default, Web Player SDK mengaktifkan pelaporan log. Meneruskan traceId membantu mengidentifikasi pengguna. Jika diabaikan, Web Player SDK menghasilkan dan menyimpan UUID di cache browser.

textTracks

Array

Konfigurasikan teks terjemahan WebVTT eksternal. Contoh:

textTracks: [
  { kind: 'subtitles', label: 'Chinese', src: 'caption-url', srclang: 'zh-CN', default: true },
  { kind: 'subtitles', label: 'English (US)', src: 'caption-url', srclang: 'en-US' }
],

ratio

Number

Atur pemutar untuk diskalakan pada rasio aspek tetap. Misalnya, diberikan rasio aspek video 16:9, atur parameter pemutar ke width: "100%", ratio: 16/9. Ini menjaga rasio aspek pemutar konsisten dengan konten video dan memungkinkannya diskalakan secara proporsional saat halaman diskalakan.

extLanguageTexts

Object

Web Player SDK menyertakan teks UI bawaan dalam bahasa Tiongkok dan Inggris. Gunakan properti ini untuk menyesuaikan teks untuk elemen UI tertentu. Misalnya, untuk mengubah tampilan HD dari high definition menjadi 1080p:

extLanguageTexts: {
    'zh-cn': {
      'HD': '1080p'
    }
}

speedLevels

Array

Menyesuaikan daftar kecepatan pemutaran. Setiap objek berisi kunci (nilai kecepatan) dan teks (label UI). Jika diabaikan, daftar default digunakan. Contoh:

speedLevels: [
  {"key": 0.25, "text": "0.25"},
  {"key": 0.5, "text": "0.5"},
  {"key": 1, "text": "Normal"},
  {"key": 1.25, "text": "1.25"},
  {"key": 1.5, "text": "1.5"},
  {"key": 2,"text": "2"}
]

logo

Array

Konfigurasikan gambar logo kustom. Contoh:

    logo: [{
      width: 30,
      position: 'bottom-right',
      origin: 'content',
      src: 'a.png'
    },
    {
      width: 20,
      position: 'bottom-right',
      offsetY: -20,
      origin: 'content',
      src: 'b.png'
    }]

Deskripsi bidang:

• src: URL gambar logo.

• origin: Titik referensi untuk pemosisian. Nilai yang valid:

  • box: Kontainer pemutar

  • content: Konten video

• width/height: Dimensi logo sebagai persentase (dihitung relatif terhadap origin). Jika hanya satu dimensi yang ditentukan, dimensi lainnya diskalakan secara proporsional.

• position: Posisi relatif dalam origin. Nilai yang valid:

  • top-left: Sudut kiri atas

  • top-right: Sudut kanan atas

  • bottom-left: Sudut kiri bawah

  • bottom-right: Sudut kanan bawah

• offsetX/offsetY: Offset dari posisi, sebagai persentase (dihitung relatif terhadap origin).

license

Object

Untuk menggunakan fitur bernilai tambah seperti Pemantauan Kualitas Pemutaran (Lama), Troubleshooting Titik Tunggal, atau Pemutaran Video H.265/H.266, pertama-tama kirimkan Formulir Permohonan Layanan Bernilai Tambah Web Player SDK untuk mendapatkan lisensi. Kemudian integrasikan lisensi sebagai berikut:

// domain adalah domain yang Anda masukkan saat mengajukan lisensi.
// key adalah kunci lisensi.
license: {
    domain: "example.com",
    key: "example-key"
  }

mute

Boolean

Aktifkan pemutaran tanpa suara. Konfigurasikan parameter ini untuk mengaktifkan putar otomatis tanpa suara saat browser memblokir putar otomatis. Untuk detailnya, lihat Fitur Lanjutan.

clickPause

Boolean

Klik area video untuk menjeda atau melanjutkan pemutaran.

• true: Aktifkan.

• false: Nonaktifkan.

Default: true di desktop, false di seluler. Jangan gunakan dengan dbClickSkip untuk menghindari konflik interaksi.

disablePip

Boolean

Sembunyikan tombol Picture-in-Picture (PiP) asli browser.

env

String

Secara default, data telemetri pemutar diunggah ke pusat data Tiongkok. Jika Anda memiliki persyaratan kepatuhan untuk data di luar Tiongkok, atur env: 'SEA' untuk mengunggah data ke pusat data Singapura.

watchStartTime

Number

Gunakan sendiri untuk mengatur waktu mulai pemutaran.

Gunakan dengan watchEndTime untuk mengaktifkan pemutaran rentang waktu. Pengguna hanya dapat memutar dan mencari dalam rentang waktu yang ditentukan.

Satuan: detik

watchEndTime

Number

Gunakan dengan watchStartTime untuk mengaktifkan pemutaran rentang waktu. Pengguna hanya dapat memutar dan mencari dalam rentang waktu yang ditentukan.

Jika nilai ini kurang dari watchStartTime, watchStartTime diabaikan.

Satuan: detik

start

Number

Gunakan dengan end untuk mengekstrak segmen dari video. Misalnya, jika video asli berdurasi 60 detik dan Anda mengatur start: 10 dan end: 30, pemutar menampilkan video 20 detik yang dimulai dari detik ke-10 video asli.

end

Number

Gunakan dengan start untuk mengekstrak segmen dari video. Misalnya, jika video asli berdurasi 60 detik dan Anda mengatur start: 10 dan end: 30, pemutar menampilkan video 20 detik yang dimulai dari detik ke-10 video asli.

dbClickFullscreen

Boolean

Aktifkan klik ganda untuk masuk layar penuh. Diaktifkan secara default di desktop.

longPressFastForward

Boolean

Aktifkan maju cepat tekan lama (hanya seluler). Nilai yang valid:

• true (default): Aktifkan.

• false: Nonaktifkan.

dbClickSkip

Boolean

Klik ganda sisi kiri untuk mundur cepat, klik ganda sisi kanan untuk maju cepat (hanya seluler). Nilai yang valid:

• true (default): Aktifkan.

• false: Nonaktifkan.

Jangan gunakan dengan clickPause untuk menghindari konflik interaksi.

enableMockFullscreen

Boolean

Aktifkan pseudo-layar penuh berbasis CSS. Secara default, pemutar memanggil API fullscreen browser. Di iOS dan beberapa browser Android, pemutar sistem mengambil alih layar penuh, menyebabkan masalah UI. Aktifkan parameter ini untuk menghindari pengambilalihan. Default: false.

watermark

Object

Konfigurasikan watermark dinamis. Contoh:

watermark: {
  enable: true,
  text: 'Copyright ©2026',
  mode: 'BULLET'
}

Deskripsi bidang:

• enable: Aktifkan watermark dinamis.

• text: Teks yang akan ditampilkan sebagai watermark.

• mode: Mode watermark. Nilai yang valid:

  • BULLET: Marquee (default).

  • GHOST: Kedip acak.

• direction: Arah gerakan. Nilai yang valid:

  • RTL: Kanan ke kiri (default).

  • LTR: Kiri ke kanan.

  • STATIC: Stasioner (hanya berlaku untuk mode GHOST).

• speed: Kecepatan gerakan. Rentang: 0~100. Nilai yang lebih tinggi berarti gerakan lebih cepat. Default: 50 untuk BULLET, 30 untuk GHOST.

• interval: Waktu dalam milidetik antara menghilang dan muncul kembali watermark. Default: 3000.

• duration: Durasi tampilan untuk setiap kemunculan watermark (hanya mode GHOST). Default: 5000 (milidetik).

• opacity: Transparansi teks watermark. Rentang: 0~1. Default: 0.5.

• fontSize: Ukuran font teks watermark. Nilai font-size CSS. Default: 14px.

• fontColor: Warna teks watermark. Semua nilai warna CSS yang valid. Default: #FFFFFF.

• top: Jarak dari atas kontainer ke area watermark. Mendukung nilai piksel (misalnya, 50) atau persentase (misalnya, '20%').

• bottom: Jarak dari bawah kontainer ke area watermark. Mendukung nilai piksel atau persentase.

• left: Jarak dari kiri kontainer ke area watermark. Mendukung nilai piksel atau persentase (hanya mode GHOST).

• right: Jarak dari kanan kontainer ke area watermark. Mendukung nilai piksel atau persentase (hanya mode GHOST).

memoryPlay

Object

Untuk mengaktifkan melanjutkan pemutaran, tambahkan opsi memoryPlay ke konfigurasi pemutar. Contoh:

// Konfigurasi melanjutkan pemutaran
memoryPlay: {
    enable: true, // Aktifkan melanjutkan pemutaran.
    autoSeek: false // Secara otomatis lompat ke posisi yang diingat.
}

Deskripsi bidang:

• enable: Aktifkan melanjutkan pemutaran. Nilai yang valid:

  • false (default): Nonaktifkan melanjutkan pemutaran.

  • true: Aktifkan melanjutkan pemutaran.

• autoSeek: Secara otomatis lompat ke posisi yang diingat. Nilai yang valid:

  • false (default): Tampilkan prompt yang menanyakan kepada pengguna apakah akan melompat (direkomendasikan).

  • true: Lompat ke posisi yang diingat dan tampilkan prompt setelah video dimuat.

getTimeFunction/saveTimeFunction digunakan untuk skenario yang memerlukan kontrol progres pemutaran kustom (seperti sinkronisasi multi-perangkat). Jika diabaikan, pemutar secara default menyimpan progres di localStorage.

• getTimeFunction: Ambil waktu yang diingat dari lokasi penyimpanan kustom. Tanda tangan fungsi: (videoKey) => number｜Promise<number>.

• saveTimeFunction: Simpan waktu pemutaran saat ini. Tanda tangan fungsi: (videoKey, currentTime) => void.

menuMode

String

Atur tempat menampilkan kontrol kecepatan pemutaran, definisi, teks terjemahan, dan trek audio. Nilai yang valid:

• fold (default): Tempatkan di submenu Settings.

• expand: Tampilkan di control bar (menu utama).

Name

Type

Required

Description

showPlayButton

Boolean

No

Tampilkan tombol play.

Name

Type

Required

Description

time

number

Yes

Waktu untuk dilompati. Satuan: detik.

Name

Type

Required

Description

volume

number

Yes

Volume sebagai bilangan real antara 0 dan 1. Tidak didukung di iOS dan beberapa perangkat Android.

Name

Type

Required

Description

quiet

boolean

No

Sembunyikan teks status mute/unmute di pojok kiri bawah.

Name

Type

Required

Description

quiet

boolean

No

Apakah akan menyembunyikan prompt teks di pojok kiri bawah saat Anda menyalakan kembali suara.

Name

Type

Required

Description

url

string

Yes

URL video yang akan dialihkan.

seconds

number

No

Waktu mulai pemutaran setelah beralih.

autoPlay

boolean

No

Mulai pemutaran secara otomatis setelah beralih.

Name

Type

Required

Description

vid

string

Yes

ID video.

playauth

string

Yes

Kredensial pemutaran.

Name

Type

Required

Description

mediaAuth

string

Yes

Kredensial pemutaran.

Name

Type

Required

Description

name

string

Yes

Nama komponen bawaan (misalnya, fullScreenButton). Lihat Konfigurasikan Properti skinLayout untuk daftar nama komponen. Setiap komponen mendukung metode hide dan show.

Name

Type

Required

Description

width

string

Yes

Atur ukuran pemutar. Nilai yang valid:

• 400px

• 60%

height

string

Yes

Name

Parameter type

Required

Description

speed

number

Yes

Mendukung kecepatan pemutaran dari 0.5× hingga 2×.

Name

Type

Required

Description

traceId

string

Yes

Identifier unik.

Name

Type

Required

Description

width

number

Yes

Unit lebar dan tinggi: piksel. Rentang kualitas tangkapan layar: 0–1 (default: 1). Untuk detail lebih lanjut, lihat Tangkapan Layar Video.

height

number

Yes

rate

number

Yes

Name

Type

Required

Description

start

string

Yes

Waktu mulai untuk streaming langsung.

end

string

Yes

Waktu akhir untuk streaming langsung.

Name

Type

Required

Description

rotate

number

Yes

Nilai positif memutar searah jarum jam. Nilai negatif memutar berlawanan arah jarum jam. Contoh: setRotate(90). Untuk informasi lebih lanjut, lihat Atur Mode Tampilan.

Name

Type

Required

Description

type

string

Yes

Nilai yang valid:

• horizon: Balik horizontal.

• Vertical: Mengacu pada orientasi vertikal.

Contoh: setImage('horizon'). Untuk informasi lebih lanjut, lihat Atur Mode Tampilan.

Name

Type

Required

Description

coverUrl

string

Yes

URL thumbnail.

Name

Type

Required

Description

markers

Array<markers>

Yes

markers: Array objek penanda (wajib).

marker.time: Waktu penanda (wajib).

marker.text: Label teks untuk penanda (wajib).

Lihat parameter progressMarkers untuk detailnya.

Name

Type

Required

Description

time

number

Yes

Satuan: detik. Untuk informasi lebih lanjut, lihat Pratinjau.

Name

Type

Required

Description

textTracks

Array<object>

Yes

Contoh:

player.setTextTracks([ { kind: 'subtitles', label: 'Chinese', src: 'caption-url', srclang: 'zh-CN' },{ kind: 'subtitles', label: 'English (US)', src: 'caption-url', srclang: 'en-US' }])

Name

Type

Required

Description

logoList

Array<object>

Yes

Contoh:

player.setLogo([{
      width: 30,
      position: 'bottom-right',
      origin: 'content',
      src: 'a.jpg'
    },
    {
      width: 20,
      position: 'bottom-right',
      offsetY: -20,
      origin: 'content',
      src: 'b.jpg'
    }])

Untuk deskripsi bidang, lihat properti: logo.

Name

Type

Required

Description

start

string

Yes

Waktu mulai.

end

string

Yes

Waktu akhir.

Name

Type

Required

Description

start

string

Yes

Waktu mulai.

end

string

Yes

Waktu akhir.

Name

Type

Required

Description

start

string

Yes

Waktu mulai.

end

string

Yes

Waktu akhir.

Name

Type

Required

Description

start

string

Yes

Waktu mulai.

end

string

Yes

Waktu akhir.

Name

Type

Description

time

string

Waktu tangkapan layar.

base64

string

Konten tangkapan layar yang dikodekan Base64.

binary

string

Representasi string biner dari konten tangkapan layar.

error

Error

Detail kesalahan tangkapan layar apa pun.