All Products
Search
Document Center

ApsaraVideo VOD:Referensi API

Last Updated:Sep 10, 2026

AliPlayerWidget menyediakan serangkaian API lengkap untuk mengontrol perilaku pemutar. AliPlayerWidgetController mengekspos API tersebut guna mendukung fitur seperti kontrol pemutaran, kueri status, dan pembaruan data.

API Umum

Konfigurasi dan inisialisasi

Nama API

Deskripsi

configure

Konfigurasikan sumber data dan inisialisasi pemutar.

prepare

Memicu proses persiapan pemutar secara manual.

destroy

Hapus instans pemutar dan lepas semua sumber daya terkait.

Kontrol pemutaran

Nama API

Deskripsi

play

Memulai pemutaran video.

pause

Menghentikan sementara pemutaran.

stop

Menghentikan pemutaran dan mengatur ulang pemutar.

seek

Melompat ke posisi pemutaran tertentu.

togglePlayState

Beralih antara status memutar dan jeda.

replay

Memutar ulang video. Biasanya digunakan untuk memulai ulang pemutaran setelah selesai.

Properti pemutaran

Nama API

Deskripsi

setSpeed

Mengatur kecepatan pemutaran.

setVolume

Mengatur volume.

setVolumeWithDelta

Menyesuaikan volume berdasarkan delta yang ditentukan.

setBrightness

Mengatur kecerahan layar. (Developer harus mengimplementasikan logika dasarnya.)

setBrightnessWithDelta

Menyesuaikan kecerahan layar berdasarkan delta yang ditentukan. (Developer harus mengimplementasikan logika dasarnya.)

setLoop

Mengatur apakah video diputar berulang.

setMute

Mengatur apakah pemutar dalam mode bisu.

setMirrorMode

Mengatur mode pencerminan, seperti pencerminan horizontal atau vertikal.

setRotateMode

Mengatur sudut rotasi, seperti 90° atau 180°.

setScaleMode

Mengatur mode penskalaan, seperti stretch atau crop.

Pengalihan kualitas video

Nama API

Deskripsi

selectTrack

Mengalihkan kualitas video.

Gambar mini

Nama API

Deskripsi

requestThumbnailBitmap

Meminta gambar mini untuk timestamp tertentu.

Fitur lainnya

Catatan

API berikut telah dipindahkan ke AliPlayerWidgetGlobalSetting. Gunakan langsung:

  • Nomor versi: AliPlayerWidgetGlobalSetting.kWidgetVersion.

  • Bersihkan cache: AliPlayerWidgetGlobalSetting.clearCaches().

Notifikasi peristiwa

AliPlayerWidgetController menyediakan serangkaian objek ValueNotifier yang mengirimkan notifikasi real-time mengenai perubahan status pemutar dan interaksi pengguna.

Manajemen status pemutaran

Notifier

Deskripsi

playStateNotifier

Memberi notifikasi perubahan status pemutaran (misalnya, sedang memutar, dijeda, atau dihentikan).

playErrorNotifier

Memberi notifikasi kesalahan pemutaran, menyertakan kode kesalahan dan pesan.

isRenderedNotifier

Memberi notifikasi saat frame pertama dirender.

Manajemen progres pemutaran

Notifier

Deskripsi

currentPositionNotifier

Memberi notifikasi posisi pemutaran saat ini secara real-time, dalam milidetik.

bufferedPositionNotifier

Memberi notifikasi progres buffering, menunjukkan rentang konten yang telah di-cache.

totalDurationNotifier

Memberi notifikasi durasi total video, yang dapat digunakan untuk menghitung progres atau menampilkan panjang video.

Kontrol volume dan kecerahan

Notifier

Deskripsi

volumeNotifier

Memberi notifikasi perubahan volume. Level berkisar dari 0,0 hingga 1,0.

brightnessNotifier

Memberi notifikasi perubahan kecerahan layar. Level berkisar dari 0,0 hingga 1,0.

speedNotifier

Memberi notifikasi perubahan kecepatan pemutaran.

Status properti pemutaran

Notifier

Deskripsi

isLoopNotifier

Memberi notifikasi perubahan status loop.

isMuteNotifier

Memberi notifikasi perubahan status bisu.

mirrorModeNotifier

Memberi notifikasi perubahan mode pencerminan.

rotateModeNotifier

Memberi notifikasi perubahan sudut rotasi.

scaleModeNotifier

Memberi notifikasi perubahan mode penskalaan.

Kualitas video dan gambar mini

Notifier

Deskripsi

currentTrackInfoNotifier

Memberi notifikasi perubahan kualitas video saat ini (misalnya, SD, HD, atau UHD) dan menyediakan detail setelah pengalihan.

trackInfoListNotifier

Menyediakan daftar semua track kualitas video yang tersedia.

thumbnailNotifier

Memberi notifikasi status pemuatan gambar mini, yang memungkinkan pratinjau real-time saat melakukan seek.

Subtitel

Notifier

Deskripsi

subtitleNotifier

Memberi notifikasi perubahan informasi subtitle eksternal.

subtitleTrackIndexNotifier

Memberi notifikasi perubahan indeks track subtitle saat ini.

isSubtitleVisibleNotifier

Memberi notifikasi perubahan visibilitas subtitle.

Status lainnya

Notifier

Deskripsi

videoSizeNotifier

Memberi notifikasi perubahan dimensi video.

snapFileStateNotifier

Memberi notifikasi perubahan status file snapshot.

downloadStateNotifier

Memberi notifikasi perubahan status unduhan.

Penggunaan

Untuk memperbarui UI atau menjalankan logika secara real-time, gunakan ValueListenableBuilder guna mendengarkan perubahan dari ValueNotifier.

// Dengarkan kesalahan pemutaran
ValueListenableBuilder<Map<int?, String?>?>(
  valueListenable: _controller.playErrorNotifier,
  builder: (context, error, _) {
    if (error != null) {
      final errorCode = error.keys.firstOrNull;
      final errorMsg = error.values.firstOrNull;
      return Text("Kesalahan pemutaran: [$errorCode] $errorMsg");
    }
    return const SizedBox.shrink();
  },
);

Dokumentasi API

Untuk dokumentasi API lengkap dan petunjuk penggunaan, lihat dokumentasi resmi di Pub:

  • Sumber resmi: Referensi API di pub.dev.

  • Mirror domestik: Referensi API di pub.flutter-io.cn.

Dokumentasi resmi menyediakan penjelasan rinci untuk setiap API, termasuk parameter, nilai kembali, dan contoh penggunaan tambahan.