Topik ini menjelaskan properti, metode, dan event yang didukung oleh Aliplayer.
Jika Anda mengalami masalah saat menggunakan Aliplayer, lihat FAQ Web Player atau Troubleshooting Mandiri untuk Error Pemutaran.
Properti
Saat melakukan inisialisasi Aliplayer, Anda dapat mengatur berbagai properti, termasuk otorisasi lisensi, informasi sumber media, pengaturan UI player, dan perilaku pemutaran.
Name | Type | Description |
id | String | ID elemen DOM dari kontainer luar player. |
source | String | Saat menggunakan pemutaran berbasis URL, tentukan URL video dengan properti ini. Catatan
|
vid | String | ID media untuk layanan ApsaraVideo Media Processing. |
playauth | String | Kredensial pemutaran. Untuk petunjuk cara memperoleh kredensial pemutaran, lihat Memperoleh 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, player 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 dan deskripsi parameter yang didukung, lihat Pengaturan PlayConfig Kustom untuk Pemutaran Media. Contoh nilai: |
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 player. Nilai yang valid:
|
width | String | Lebar player. Nilai yang valid:
|
autoSize | Boolean | String | Secara otomatis menyesuaikan ukuran player agar sesuai dengan konten video. Nilai yang valid: 'height' atau 'width'. Misalnya, atur width: '500px' dan autoSize: 'height'. Player mempertahankan lebar tetap 500px dan menyesuaikan tingginya berdasarkan rasio aspek video. Atau atur height: '500px' dan autoSize: 'width'. Player mempertahankan tinggi tetap 500px dan menyesuaikan lebarnya berdasarkan rasio aspek video. Catatan: autoSize: true sama dengan autoSize: 'height'. Penyesuaian ukuran tinggi adalah default. |
videoWidth | String | Lebar video. Untuk informasi lebih lanjut, lihat Mengatur Mode Tampilan. |
videoHeight | String | Tinggi video. Untuk informasi lebih lanjut, lihat Mengatur Mode Tampilan. |
preload | Boolean | Player memuat secara otomatis. |
cover | String | Gambar sampul default untuk player. Masukkan URL gambar yang valid. Pengaturan ini hanya berlaku saat autoplay diatur ke false. |
isLive | Boolean | Menunjukkan apakah kontennya adalah streaming langsung. Saat diaktifkan, pengguna tidak dapat menyeret bilah kemajuan. Default: false. Atur ke true untuk streaming langsung. |
autoplay | Boolean | Aktifkan autoplay untuk player. Autoplay gagal pada perangkat seluler. Nilai yang valid:
Catatan Karena pembatasan browser, autoplay mungkin gagal di Web Player SDK. Untuk detailnya, lihat Fitur Lanjutan. |
autoplayPolicy | Object | Player mendukung kebijakan adaptif untuk autoplay senyap. Properti ini hanya berlaku saat Catatan
|
rePlay | Boolean | Aktifkan putar ulang berulang otomatis. |
useH5Prism | Boolean | Gunakan player 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 Menyesuaikan Skin Player. |
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 Mengonfigurasi Properti skinLayout. |
skinLayoutIgnore | Array | Daftar komponen UI yang akan disembunyikan. Lihat Referensi Parameter Komponen VOD untuk nama komponen. Contoh konfigurasi: Catatan skinLayoutIgnore memiliki prioritas lebih tinggi daripada skinLayout. |
controlBarVisibility | String | Implementasi panel kontrol. Nilai yang valid meliputi:
|
showBarTime | Number | Waktu dalam milidetik sebelum bilah kontrol disembunyikan secara otomatis. |
enableSystemMenu | Boolean | Aktifkan menu klik kanan sistem. Default: false. |
format | String | Tentukan format URL pemutaran. Nilai yang valid:
Default: kosong. |
mediaType | String | Tentukan apakah akan mengembalikan audio atau video. Hanya didukung saat menggunakan pemutaran berbasis vid. Default: video. Nilai yang valid:
|
qualitySort | String | Tentukan urutan pengurutan. Hanya didukung saat menggunakan pemutaran Vid + PlayAuth. Nilai yang valid:
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:
|
defaultDefinition | String | Atur definisi video default. Ini harus merupakan salah satu definisi yang tersedia untuk vid yang ditentukan. Nilai yang valid:
|
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:
|
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 player HTML5. |
useHlsPluginForSafari | Boolean | Aktifkan plugin HLS untuk browser Safari, kecuali Safari 11. Nilai yang valid:
|
enableStashBufferForFlv | Boolean | Aktifkan caching pemutaran untuk FLV di player HTML5. Hanya berlaku untuk streaming langsung. Nilai yang valid:
|
stashInitialSizeForFlv | Number | Ukuran cache awal untuk FLV di player 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:
|
disableSeek | Boolean | Nonaktifkan pencarian dengan bilah kemajuan. Nilai yang valid:
|
encryptType | Number | Aktifkan enkripsi video Alibaba Cloud (enkripsi privat). Default: 0. Nilai yang valid:
Catatan
|
progressMarkers | Array | Array objek penanda kemajuan. Untuk informasi lebih lanjut, lihat Penanda Bilah Kemajuan. |
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 pengejaran frame untuk streaming langsung HLS. Nilai yang valid:
Catatan Hanya Web Player SDK versi sebelum 2.21.0 yang mendukung pengaturan parameter ini. Untuk versi 2.21.0 dan yang lebih baru, untuk mengaktifkan sinkronisasi frame dalam mode streaming langsung HLS, lihat properti |
chasingFirstParagraph | Number | Durasi segmen pengejaran frame pertama. Satuan: detik. Default: 20. Catatan Anda hanya dapat mengatur parameter ini di Web Player SDK versi sebelum 2.21.0. Untuk versi 2.21.0 dan yang lebih baru, untuk mengatur sinkronisasi frame dalam mode streaming langsung HLS, lihat properti |
chasingSecondParagraph | Number | Durasi segmen pengejaran frame kedua. Satuan: detik. Default: 40. Catatan Hanya Web Player SDK versi sebelum 2.21.0 yang mendukung pengaturan parameter ini. Untuk versi 2.21.0 dan yang lebih baru, untuk mengatur sinkronisasi frame dalam mode streaming langsung HLS, lihat properti |
chasingFirstSpeed | Number | Kecepatan pemutaran untuk segmen pengejaran frame pertama. Default: 1.1×. Catatan Hanya Web Player SDK versi sebelum 2.21.0 yang mendukung konfigurasi parameter ini. Untuk versi 2.21.0 dan yang lebih baru, untuk mengonfigurasi sinkronisasi frame dalam mode streaming langsung HLS, lihat properti |
chasingSecondSpeed | Number | Kecepatan pemutaran untuk segmen pengejaran frame kedua. Default: 1.2×. Catatan Hanya Web Player SDK versi di bawah 2.21.0 yang mendukung pengaturan parameter ini. Untuk versi 2.21.0 dan yang lebih baru, untuk mengonfigurasi sinkronisasi frame dalam mode streaming langsung HLS, lihat properti |
hlsOption.maxLiveSyncPlaybackRate | Number | Atur kecepatan pemutaran untuk pengejaran frame dalam streaming langsung HLS. Default: 1 (tanpa pengejaran frame).
Catatan Parameter ini hanya didukung di Web Player SDK versi 2.21.0 dan yang lebih baru. |
flvFrameChasing | Boolean | Aktifkan pengejaran frame untuk streaming langsung FLV. Nilai yang valid:
Default: false. |
keyShortCuts | Boolean | Aktifkan pintasan keyboard. Nilai yang valid:
Default: false. Catatan Tombol panah (kiri/kanan) mengontrol maju cepat dan mundur cepat. Tombol panah (atas/bawah) mengontrol volume. Spasi mengaktifkan/menonaktifkan putar/jeda. |
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, player secara otomatis beralih ke FLV atau HLS. Player lebih memilih FLV untuk latensi yang lebih rendah. Jika browser tidak mendukung FLV, player 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, player memilih secara otomatis, lebih memilih FLV untuk latensi yang lebih rendah. Jika browser tidak mendukung FLV, player beralih ke HLS. |
rtsFallbackSource | String | Kami merekomendasikan menggunakan strategi fallback default player. 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. Catatan Didukung di Web Player SDK versi 2.10.0 dan yang lebih baru. |
textTracks | Array | Konfigurasikan teks terjemahan WebVTT eksternal. Contoh: Deskripsi bidang:
Catatan
|
ratio | Number | Atur player untuk diskalakan pada rasio aspek tetap. Misalnya, diberikan rasio aspek video 16:9, atur parameter player ke |
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 definisi tinggi menjadi 1080p: |
speedLevels | Array | Menyesuaikan daftar kecepatan pemutaran. Setiap objek berisi kunci (nilai kecepatan) dan teks (label UI). Jika diabaikan, daftar default akan digunakan. Contoh: |
logo | Array | Konfigurasikan gambar logo kustom. Contoh: Deskripsi bidang:
|
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 memperoleh lisensi. Kemudian integrasikan lisensi sebagai berikut: |
mute | Boolean | Aktifkan pemutaran senyap. Konfigurasikan parameter ini untuk mengaktifkan autoplay senyap saat browser memblokir autoplay. Untuk detailnya, lihat Fitur Lanjutan. |
clickPause | Boolean | Klik area video untuk menjeda atau melanjutkan pemutaran.
Default: true di desktop, false di seluler. Jangan gunakan bersama dbClickSkip untuk menghindari konflik interaksi. |
disablePip | Boolean | Sembunyikan tombol Picture-in-Picture (PiP) asli browser. Catatan
|
env | String | Secara default, data telemetri player 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 bersama watchEndTime untuk mengaktifkan pemutaran rentang waktu. Pengguna hanya dapat memutar dan mencari dalam rentang waktu yang ditentukan. Satuan: detik |
watchEndTime | Number | Gunakan bersama 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 bersama end untuk mengekstrak segmen dari video. Misalnya, jika video asli berdurasi 60 detik dan Anda mengatur start: 10 dan end: 30, player menampilkan video 20 detik yang dimulai dari detik ke-10 video asli. |
end | Number | Gunakan bersama start untuk mengekstrak segmen dari video. Misalnya, jika video asli berdurasi 60 detik dan Anda mengatur start: 10 dan end: 30, player 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:
|
dbClickSkip | Boolean | Klik ganda sisi kiri untuk mundur cepat, klik ganda sisi kanan untuk maju cepat (hanya seluler). Nilai yang valid:
Jangan gunakan bersama clickPause untuk menghindari konflik interaksi. |
enableMockFullscreen | Boolean | Aktifkan fullscreen semu berbasis CSS. Secara default, player memanggil API fullscreen browser. Di iOS dan beberapa browser Android, player sistem mengambil alih layar penuh, menyebabkan masalah UI. Aktifkan parameter ini untuk menghindari pengambilalihan. Default: false. |
watermark | Object | Konfigurasikan watermark dinamis. Contoh: Deskripsi bidang:
|
memoryPlay | Object | Untuk mengaktifkan melanjutkan pemutaran, tambahkan opsi Deskripsi bidang:
|
menuMode | String | Atur tempat menampilkan kontrol kecepatan pemutaran, definisi, teks terjemahan, dan trek audio. Nilai yang valid:
|
Metode
Anda dapat memanggil metode-metode berikut setelah event ready terjadi atau dalam callback ready saat membuat player. Contoh:
// Metode 1:
var player = new Aliplayer({}, function (player) {
player.play();
});
// Metode 2:
var player = new Aliplayer({});
function handleReady(player) {
player.play();
};
player.on('ready', handleReady);Metode yang tersedia untuk instans Aliplayer:
play()
Mulai pemutaran.
Definisi Fungsi
() => Playerpause()
Jeda pemutaran.
(showPlayButton?: boolean) => PlayerParameter
Name | Type | Required | Description |
showPlayButton | Boolean | No | Tampilkan tombol play. |
replay()
Mulai ulang pemutaran.
Definisi Fungsi
() => Playerseek()
Lompat ke waktu tertentu.
Definisi Fungsi
(time: number) => Player Parameter
Name | Type | Required | Description |
time | number | Yes | Waktu untuk dilompati. Satuan: detik. |
dispose()
Hancurkan pemain.
Definisi Fungsi
() => voidgetCurrentTime()
Peroleh waktu pemutaran saat ini dalam satuan detik.
Definisi Fungsi
() => numbergetDuration()
Peroleh durasi total video dalam satuan detik. Metode ini dapat dipanggil setelah video dimuat atau setelah event play.
Definisi Fungsi
() => numbergetVolume()
Peroleh volume saat ini. Mengembalikan bilangan real antara 0 dan 1. Tidak didukung di iOS dan beberapa perangkat Android.
Definisi Fungsi
() => number | undefinedsetVolume()
Atur volume.
Definisi Fungsi
(volume: number) => voidParameter
Name | Type | Required | Description |
volume | number | Yes | Volume sebagai bilangan real antara 0 dan 1. Tidak didukung di iOS dan beberapa perangkat Android. |
mute()
Matikan suara pemutaran.
Definisi Fungsi
(quiet?: boolean) => PlayerParameter
Name | Type | Required | Description |
quiet | boolean | No | Sembunyikan teks status mute/unmute di pojok kiri bawah. |
unMute()
Nyalakan kembali suara pemutaran.
Definisi Fungsi
(quiet?: boolean) => PlayerParameter
Name | Type | Required | Description |
quiet | boolean | No | Apakah akan menyembunyikan prompt teks di pojok kiri bawah saat Anda menyalakan kembali suara. |
getPlayTime()
Peroleh waktu pemutaran aktual (tidak termasuk waktu jeda). Untuk pemutaran dengan kecepatan variabel, metode ini mengembalikan waktu berlalu aktual dalam satuan detik.
Definisi Fungsi
() => numberloadByUrl()
Beralih ke video lain. Hanya mendukung peralihan antara video dengan format yang sama, seperti MP4, HLS, atau FLV. Untuk beralih antar format berbeda, Anda harus menghapus player dan membuat instans baru.
Definisi fungsi
(url: string, seconds?: number, autoPlay?: boolean) => voidParameter
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. |
replayByVidAndPlayAuth()
Beralih ke video VOD lain. Hanya mendukung peralihan antara video dengan format yang sama.
Definisi Fungsi
(vid: string, playauth: string) => voidParameter
Name | Type | Required | Description |
vid | string | Yes | ID video. |
playauth | string | Yes | Kredensial pemutaran. |
replayByVidAndAuthInfo()
Beralih ke video MPS lain. Hanya mendukung peralihan antara video dengan format yang sama.
Definisi Fungsi
(vid: string, accId: string, accSecret: string, stsToken: string, authInfo: string, domainRegion: string) => voidUntuk informasi detail parameter, lihat Pemutaran MPS.
replayByMediaAuth()
Beralih ke video Layanan Media Universal lain. Hanya mendukung peralihan antara video dengan format yang sama.
Definisi fungsi
(mediaAuth: string) => voidParameter
Name | Type | Required | Description |
mediaAuth | string | Yes | Kredensial pemutaran. |
getBuildInComponent()
Peroleh komponen UI bawaan (seperti tombol layar penuh atau bilah kemajuan).
Definisi Fungsi
(name: string) => BuildInComponent;Parameter
Name | Type | Required | Description |
name | string | Yes | Nama komponen bawaan (misalnya, fullScreenButton). Lihat Mengonfigurasi Properti skinLayout untuk daftar nama komponen. Setiap komponen mendukung metode hide dan show. |
setPlayerSize()
Atur ukuran player.
Definisi fungsi
(width: string, height: string) => voidParameter
Name | Type | Required | Description |
width | string | Yes | Atur ukuran player. Nilai yang valid:
|
height | string | Yes |
setSpeed()
Atur kecepatan pemutaran secara manual. Fitur ini mungkin tidak berfungsi di perangkat seluler (seperti WeChat di Android). Kontrol kecepatan diaktifkan secara default.
Definisi Fungsi
(speed: number) => voidParameter
Name | Parameter type | Required | Description |
speed | number | Yes | Mendukung kecepatan pemutaran dari 0.5× hingga 2×. |
Untuk menonaktifkan kontrol kecepatan:
Kontrol kecepatan tidak dapat dinonaktifkan atau disesuaikan secara individual; Anda harus menonaktifkannya secara global.
Untuk menonaktifkan kontrol kecepatan melalui penggantian CSS:
.prism-setting-speed { display: none !important; }
setTraceId()
Teruskan instrumentasi umum untuk pelacakan log.
Definisi fungsi
(traceId: string) => voidParameter
Name | Type | Required | Description |
traceId | string | Yes | Identifier unik. |
Didukung di Web Player SDK versi 2.10.0 dan yang lebih baru.
setSanpshotProperties()
Konfigurasikan pengaturan tangkapan layar.
Definisi Fungsi
(width: number, height: number, rate: number) => voidParameter
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 |
fullscreenService.requestFullScreen()
Masuk layar penuh.
Definisi Fungsi
() => PlayerfullscreenService.cancelFullScreen()
Keluar layar penuh. Tidak didukung di iOS.
Definisi fungsi
() => PlayerfullscreenService.getIsFullScreen()
Peroleh status layar penuh.
Definisi Fungsi
() => booleangetStatus()
Peroleh status player dalam bentuk string. Nilai yang mungkin dikembalikan:
init: Menginisialisasi.
ready: Siap.
loading: Memuat.
play: Memutar.
pause: Dijeda.
playing: Sedang diputar.
waiting: Buffering.
error: Error.
ended: Selesai.
Definisi Fungsi
() => stringliveShiftSerivce.setLiveTimeRange()
Atur waktu mulai dan akhir untuk streaming langsung guna mengaktifkan pergeseran waktu.
Definisi Fungsi
(start: string, end: string) => voidParameter
Name | Type | Required | Description |
start | string | Yes | Waktu mulai untuk streaming langsung. |
end | string | Yes | Waktu akhir untuk streaming langsung. |
Contoh
player.liveShiftSerivce.setLiveTimeRange('2025/03/21 12:43:00', '2025/03/21 23:31:00')setRotate()
Atur sudut rotasi player.
Definisi Fungsi
(rotate: number) => voidParameter
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 Mengatur Mode Tampilan. |
getRotate()
Peroleh sudut rotasi player.
Definisi Fungsi
() => numberUntuk informasi lebih lanjut, lihat Mengatur Mode Tampilan.
setImage()
Terapkan pencerminan.
Definisi Fungsi
(type: string) => voidParameter
Name | Type | Required | Description |
type | string | Yes | Nilai yang valid:
Contoh: setImage('horizon'). Untuk informasi lebih lanjut, lihat Mengatur Mode Tampilan. |
setCover()
Atur gambar sampul.
Definisi Fungsi
(coverUrl: string) => voidParameter
Name | Type | Required | Description |
coverUrl | string | Yes | URL thumbnail. |
setProgressMarkers()
Atur penanda kemajuan.
Definisi fungsi
(markers: Array<{ time: number, text: string }>) => voidParameter
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. |
setPreviewTime()
Atur durasi pratinjau.
Definisi Fungsi
(time: number) => voidParameter
Name | Type | Required | Description |
time | number | Yes | Satuan: detik. Untuk informasi lebih lanjut, lihat Pratinjau. |
getPreviewTime()
Peroleh durasi pratinjau.
Definisi fungsi
() => numberisPreview()
Periksa apakah mode pratinjau aktif.
Definisi Fungsi
() => booleangetCurrentPDT()
Peroleh ProgramDateTime saat ini untuk aliran video HLS.
Definisi Fungsi
() => number | undefinedsetTextTracks()
Mengatur array caption WebVTT.
Definisi fungsi
(textTracks: Array<{ kind: string, label: string, src: string, srclang: string }>) => voidParameter
Name | Type | Required | Description |
textTracks | Array<object> | Yes | Contoh: Catatan Didukung di Web Player SDK versi 2.12.0 dan yang lebih baru. |
setLogo()
Atur gambar logo kustom.
Definisi fungsi
(logoList: Array<{ width: number, position: string, origin: string, src: string }>) => voidParameter
Name | Type | Required | Description |
logoList | Array<object> | Yes | Contoh: Untuk deskripsi bidang, lihat properti: logo. |
setWatchTime()
Perbarui watchStartTime/watchEndTime video saat ini secara dinamis.
Definisi fungsi
(start: number, end: number) => voidParameter
Name | Type | Required | Description |
start | string | Yes | Waktu mulai. |
end | string | Yes | Waktu akhir. |
setNextWatchTime()
Atur watchStartTime/watchEndTime video berikutnya. Jika Anda menggunakan loadByUrl atau replayByVidAndPlayAuth untuk beralih video, dan video berikutnya memiliki rentang waktu berbeda dari video saat ini, Anda harus memanggil setNextWatchTime terlebih dahulu.
Definisi fungsi
(start: number, end: number) => voidParameter
Name | Type | Required | Description |
start | string | Yes | Waktu mulai. |
end | string | Yes | Waktu akhir. |
setStartEnd()
Perbarui start/end video saat ini secara dinamis.
Definisi Fungsi
(start: number, end: number) => voidParameter
Name | Type | Required | Description |
start | string | Yes | Waktu mulai. |
end | string | Yes | Waktu akhir. |
setNextStartEnd()
Atur start/end video berikutnya. Jika Anda menggunakan loadByUrl atau replayByVidAndPlayAuth untuk beralih video, dan video berikutnya memiliki rentang segmen berbeda dari video saat ini, Anda harus memanggil setNextStartEnd terlebih dahulu.
Definisi Fungsi
(start: number, end: number) => voidParameter
Name | Type | Required | Description |
start | string | Yes | Waktu mulai. |
end | string | Yes | Waktu akhir. |
takeSnapshot()
Ambil tangkapan layar. String base64 yang dikembalikan dapat digunakan langsung sebagai nilai img.src. Anda dapat menggunakan setSnapshotProperties untuk mengonfigurasi kualitas tangkapan layar dan snapshotWatermark untuk menambahkan watermark.
Catatan: Fungsi tangkapan layar mungkin tidak berfungsi di beberapa browser seluler tempat tag video dibajak (seperti UC Browser atau QQ Browser).
Definisi Fungsi
() => { time: number, base64: string, binary: string, error: Error | null }Nilai kembalian
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 error tangkapan layar apa pun. |
showControlBar()
Tampilkan bilah kontrol.
Definisi Fungsi
() => voidhideControlBar()
Sembunyikan bilah kontrol.
Definisi Fungsi
() => voidEvent
Peristiwa Pemutar
Name | Description |
ready | UI player selesai dirender. Picu logika inisialisasi UI setelah event ini untuk menghindari ditimpa oleh inisialisasi default. Catatan Anda hanya dapat memanggil metode player setelah event ini terjadi. |
play | Dipicu saat pemutaran dilanjutkan dari jeda. |
pause | Dipicu saat pemutaran dijeda. |
canplay | Dipicu saat audio atau video dapat mulai diputar. Event ini mungkin dipicu beberapa kali. Hanya untuk player HTML5. |
playing | Dipicu berulang kali selama pemutaran. |
ended | Dipicu saat video saat ini selesai diputar. |
liveStreamStop | Dipicu saat streaming langsung berhenti. Untuk streaming langsung HLS, ini dipicu setelah lima kali percobaan ulang gagal. Beri tahu lapisan aplikasi bahwa stream telah berhenti atau perlu dimuat ulang. Catatan Jika streaming langsung HLS gagal atau terputus, player secara otomatis mencoba ulang lima kali. Jangan menerapkan logika percobaan ulang tambahan di lapisan aplikasi. |
onM3u8Retry | Dipicu sekali setiap kali player mencoba ulang setelah gangguan streaming langsung HLS. |
hideBar | Dipicu saat bilah kontrol disembunyikan secara otomatis. |
showBar | Bilah kontrol secara otomatis menampilkan (event). |
waiting | Dipicu saat buffering data. |
timeupdate | Dipicu saat posisi pemutaran berubah. Panggil getCurrentTime() untuk mendapatkan waktu pemutaran saat ini. |
snapshoted | Dipicu saat tangkapan layar selesai. |
requestFullScreen | Dipicu saat masuk layar penuh. |
cancelFullScreen | Dipicu saat keluar layar penuh. Tidak dipicu di iOS. |
error | Dipicu saat terjadi error. |
startSeek | Parameter mengembalikan waktu pembuatan titik seret pada awal operasi seret. |
completeSeek | Saat Anda menyelesaikan operasi seret, parameter menunjukkan timestamp titik seret. |
resolutionChange | Dipicu saat sumber streaming langsung mengubah resolusi. |
seiFrame | Dipicu saat menerima pesan SEI melalui HLS atau FLV. |
rtsFallback | Dipicu saat RTS beralih. Parameter |
settingSelected | Dipicu saat pengaturan (misalnya, kecepatan pemutaran, definisi, teks terjemahan) dipilih. Catatan Karena plugin kecepatan open-source tidak disinkronkan dengan player, menggunakannya memerlukan kode kustom dan rekompilasi. Definisikan listener event Anda sendiri. Untuk menggunakan event |
rtsTraceId | Event ini dipicu ketika penarikan aliran RTS berhasil, dan Anda dapat Berlangganan ke event ini untuk memperoleh RTS TraceId. Dalam keluaran log, bidang `traceId` dari parameter |
autoplay | Dipicu saat autoplay berhasil atau gagal. Parameter callback |
mutedAutoplay | Dipicu saat autoplay senyap berhasil dan |
videoUnavailable | Dipicu saat pemutaran video gagal karena encoding tidak didukung, menyebabkan Layar hitam. Misalnya, memutar video H.265 di browser yang tidak mendukung H.265 menghasilkan layar hitam dengan audio saja. |
Langganan Event
Anda dapat berlangganan event menggunakan metode on pada instans player. Contoh:
function handleReady() {}; player.on('ready', handleReady); // Beberapa event dipicu secara sering. Gunakan player.one untuk mendengarkan sekali. player.one('canplay', () => {});Anda dapat berhenti berlangganan event menggunakan metode off pada instans player. Contoh:
player.off('ready',handleReady);