ApsaraVideo Live：Antarmuka AliRtcEngine

Bergabung dengan saluran menggunakan beberapa parameter.

public abstract int joinChannel(AliRtcAuthInfo authInfo, String userName);

Metode ini digunakan untuk bergabung ke saluran. Alibaba Real-Time Communication (ARTC) menggunakan saluran untuk mengelompokkan pengguna. Pengguna harus bergabung ke saluran agar dapat memublikasikan atau berlangganan aliran audio dan video. Anda dapat menggunakan metode ini, joinChannel[1/3], atau joinChannel[3/3] untuk bergabung ke saluran. Ketiganya berbeda dalam metode autentikasi dan informasi pengguna yang dikirimkan. Perbedaannya adalah sebagai berikut:

• joinChannel[1/3] adalah metode untuk bergabung ke saluran dengan satu parameter. Untuk bergabung ke saluran, Anda harus mengirimkan token yang dihasilkan untuk autentikasi satu parameter. Untuk informasi selengkapnya, lihat Autentikasi berbasis token. Metode ini direkomendasikan untuk skenario RTC.

• Metode ini digunakan untuk bergabung ke saluran dengan beberapa parameter. Untuk bergabung, Anda harus mengirimkan token yang dihasilkan untuk autentikasi multi-parameter beserta informasi pengguna yang digunakan untuk menghasilkan token tersebut. Untuk informasi selengkapnya, lihat Autentikasi berbasis token.

• joinChannel[3/3] digunakan untuk skenario interaksi real-time berbasis AI. Untuk bergabung ke saluran, Anda harus mengirimkan token untuk autentikasi satu parameter dan mengatur properti pengguna capabilityProfile sesuai dengan skenario yang digunakan.

Batas Pemanggilan

• Jika Anda sedang berada di dalam suatu saluran dan ingin bergabung ke saluran lain, Anda harus terlebih dahulu memanggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="e2525ba6a0k3s">leaveChannel</a> dan menunggu callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="6aefdfedb0op3">onLeaveChannelResult</a> dari AliRtcEngineEventListener sebelum dapat bergabung ke saluran baru.

• Anda hanya dapat bergabung ke satu saluran dalam satu waktu.

• Aplikasi dengan ID Aplikasi yang berbeda tidak dapat berkomunikasi satu sama lain.

Callbacks

Pemanggilan sukses metode ini memicu callback berikut:

• Hasil dari klien lokal yang bergabung ke saluran dikembalikan melalui callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#89f5ad2d0bnd1" id="fb41cdcfc6acj">onJoinChannelResult</a> di AliRtcEngineEventListener.

• Setelah Anda berhasil bergabung ke saluran, callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7298cad465wnd" id="8e9d69ebe54sr">onRemoteUserOnLineNotify</a> akan dipicu untuk pengguna jarak jauh.

Parameter

Pengembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai bukan nol menunjukkan bahwa pemanggilan metode gagal.

Bergabung ke saluran menggunakan autentikasi parameter tunggal.

public abstract int joinChannel(String token, AliRTCSdkChannelParam channelParam);

Metode ini bergabung dengan saluran. Alibaba Real-Time Communication (ARTC) menggunakan saluran untuk mengatur pengguna. Pengguna harus bergabung dengan saluran untuk memublikasikan atau berlangganan aliran audio dan video. Anda dapat menggunakan metode ini, joinChannel[1/3], atau joinChannel[2/3] untuk bergabung dengan saluran. Metode-metode ini berbeda dalam metode autentikasi dan informasi pengguna yang mereka teruskan, seperti yang dijelaskan di bawah ini:

• joinChannel[1/3] adalah metode untuk bergabung ke saluran dengan satu parameter dalam skenario Komunikasi Waktu Nyata (RTC). Untuk bergabung ke saluran, Anda harus meneruskan token yang dihasilkan untuk autentikasi satu parameter. Untuk informasi selengkapnya, lihat Token authentication. Metode ini direkomendasikan untuk bergabung ke saluran dalam skenario RTC.

• joinChannel[2/3] adalah metode untuk bergabung dengan saluran dengan beberapa parameter. Untuk bergabung dengan saluran, Anda harus menyertakan token yang dihasilkan untuk autentikasi multi-parameter dan informasi pengguna yang digunakan untuk menghasilkan token tersebut. Untuk informasi selengkapnya, lihat Autentikasi token.

• Metode ini digunakan untuk skenario interaksi real-time berbasis AI. Anda harus meneruskan token untuk autentikasi parameter tunggal dan mengatur properti pengguna capabilityProfile berdasarkan skenario tersebut. Jika Anda ingin berkomunikasi dengan Agen AI, atur properti ini ke AliCapabilityProfileAiHuman.

Batasan

• Setelah Anda berhasil bergabung ke saluran, untuk bergabung ke saluran lain, Anda harus terlebih dahulu memanggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="719d580348a95">leaveChannel</a> untuk meninggalkan saluran saat ini. Anda hanya dapat bergabung ke saluran baru setelah menerima callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="d128acfee2fpd">onLeaveChannelResult</a> dari AliRtcEngineEventListener.

• Metode ini hanya mendukung bergabung ke satu saluran dalam satu waktu.

• Aplikasi yang menggunakan App ID berbeda tidak dapat saling berkomunikasi.

• Jangan memanggil metode ini untuk mencoba kembali bergabung ke saluran jika upaya awal gagal.

Callbacks

Panggilan yang berhasil ke metode ini memicu callback berikut:

• Hasil dari klien lokal yang bergabung ke dalam saluran dikembalikan oleh callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#89f5ad2d0bnd1" id="879ae2fa04zjd">onJoinChannelResult</a> di AliRtcEngineEventListener.

• Setelah Anda berhasil bergabung ke dalam saluran, callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7298cad465wnd" id="9b5662c5a0nvf">onRemoteUserOnLineNotify</a> dipicu untuk pengguna jarak jauh.

Parameter

Pengembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai bukan nol menunjukkan bahwa pemanggilan metode gagal.

Meninggalkan saluran. Saat Anda memanggil metode ini, SDK menghentikan semua interaksi audio dan video serta meninggalkan saluran saat ini.

public abstract int leaveChannel();

Kapan harus memanggil

• Anda dapat memanggil metode ini saat perlu meninggalkan saluran yang telah Anda masuki.

• Jika Anda telah bergabung ke suatu saluran dan ingin bergabung ke saluran lain, Anda harus memanggil metode ini terlebih dahulu untuk meninggalkan saluran saat ini.

Callback terkait

• Pengguna lokal: Setelah Anda memanggil metode ini, callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="80f5e30245vfn">onLeaveChannelResult</a> dipicu untuk mengembalikan hasil proses meninggalkan saluran.

• Pengguna jarak jauh: Setelah metode ini berhasil dipanggil, callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#75c700a2376c1" id="69bf5ff199oda">onRemoteUserOffLineNotify</a> dipicu untuk pengguna jarak jauh.

Pengembalian

Nilai 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai bukan nol menunjukkan bahwa pemanggilan metode gagal.

Memeriksa apakah Anda berada dalam saluran.

public abstract boolean isInCall();

Mengembalikan

true: Anda berada dalam saluran. false: Anda tidak berada dalam saluran.

Menetapkan peran pengguna.

public abstract int setClientRole(AliRTCSdkClientRole clientRole);

Metode ini menetapkan peran pengguna menjadi Streamer atau viewer.

Sebelum Anda bergabung ke saluran dalam mode interaktif:

• Streamer: Secara default, kit pengembangan perangkat lunak (SDK) secara otomatis memublikasikan aliran audio dan video lokal serta menerima aliran dari Streamer lainnya.

• Viewer: SDK tidak memublikasikan aliran audio dan video lokal. SDK hanya menerima aliran dari Streamer lainnya.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran. Jika Anda memanggil metode ini sebelum bergabung, Anda dapat menetapkan peran pengguna awal. Jika Anda memanggil metode ini setelah bergabung, Anda dapat mengganti peran pengguna.

Batasan

Metode ini hanya berlaku dalam mode aliran interaktif. Untuk mengaktifkan mode aliran interaktif, Anda dapat memanggil metode setChannelProfile dan menyetel profil saluran ke AliRTCSdkInteractiveLive.

Dalam mode aliran interaktif, Anda harus secara eksplisit memanggil metode ini untuk menetapkan peran pengguna sebelum bergabung ke saluran.

Parameter

Mengambil peran dari pengguna saat ini.

public abstract AliRTCSdkClientRole getCurrentClientRole();

Pengembalian

Peran dari pengguna saat ini.

Memperbarui informasi autentikasi.

public abstract int refreshAuthInfo(AliRtcAuthInfo authInfo);

Metode ini memperbarui informasi autentikasi. Token akan kedaluwarsa setelah periode tertentu. Setelah token kedaluwarsa, SDK tidak dapat lagi terhubung ke server.

Kapan harus memanggil

Dalam skenario berikut:

• Saat Anda menerima callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e9acb46a25uym" id="7e1510bec7s3s">onAuthInfoWillExpire</a>, yang menunjukkan bahwa informasi autentikasi akan segera kedaluwarsa, kami menyarankan agar Anda membuat ulang token di server Anda dan kemudian memanggil metode ini untuk meneruskan token baru tersebut.

• Jika Anda tidak memperbarui token tepat waktu, callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8fa7e60f9f5qq" id="97664f9e46fhp">onAuthInfoExpired</a> akan dipicu untuk menunjukkan bahwa autentikasi telah kedaluwarsa. Dalam kasus ini, Anda harus membuat ulang token dan kemudian memanggil joinChannel untuk bergabung kembali ke saluran.

Deskripsi parameter

Nilai kembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan metode gagal.

Memperbarui informasi autentikasi.

public abstract int refreshAuthInfo(String token);

Metode ini memperbarui token. Token kedaluwarsa setelah periode tertentu. Ketika token kedaluwarsa, kit pengembangan perangkat lunak (SDK) tidak dapat lagi terhubung ke server.

Kapan harus memanggil

Dalam situasi berikut, Anda harus membuat ulang token di server Anda lalu memanggil metode ini dengan token baru:

• Saat Anda menerima callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e9acb46a25uym" id="d708af68eevs9">onAuthInfoWillExpire</a>, yang menunjukkan bahwa informasi autentikasi akan segera kedaluwarsa.

• Jika Anda tidak memperbarui token tepat waktu, callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8fa7e60f9f5qq" id="3fd674e985gl8">onAuthInfoExpired</a> dipicu untuk memberi tahu Anda bahwa autentikasi telah kedaluwarsa. Anda kemudian harus memanggil joinChannel untuk bergabung kembali ke saluran.

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Anda dapat menghentikan atau melanjutkan publikasi aliran video lokal.

public abstract int publishLocalAudioStream(boolean enable);

Metode ini mengontrol apakah akan menerbitkan aliran audio lokal. Secara default, kit pengembangan perangkat lunak (SDK) menerbitkan aliran audio. Untuk mencegah aliran audio diterbitkan secara default, Anda dapat memanggil publishLocalAudioStream(false) sebelum bergabung ke saluran.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran. Jika Anda memanggilnya sebelum bergabung, Anda dapat mengubah konfigurasi default. Konfigurasi baru akan berlaku saat Anda bergabung ke saluran.

Callback terkait

Saat status pengambilan aliran audio lokal berubah, klien lokal memicu callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b7e3bb51c2ga9" id="4ced92c3f5hmj">onAudioPublishStateChanged</a> untuk melaporkan status terbaru pengambilan aliran audio. Klien jarak jauh memicu callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7078e15087a0z" id="2b5460d448ga9">onRemoteTrackAvailableNotify</a> untuk melaporkan perubahan pada aliran audio dan video pengguna jarak jauh.

Parameter

Mengembalikan

0 menunjukkan bahwa metode berhasil dipanggil. Nilai selain 0 menunjukkan bahwa pemanggilan gagal.

Memeriksa apakah aliran audio lokal telah dipublikasikan.

public abstract boolean isLocalAudioStreamPublished();

Pengembalian

true: Aliran audio telah dipublikasikan. false: Aliran audio belum dipublikasikan.

Mengatur apakah akan berlangganan ke semua aliran audio jarak jauh secara default.

public abstract int setDefaultSubscribeAllRemoteAudioStreams(boolean sub);

Metode ini mengatur perilaku default untuk berlangganan aliran audio jarak jauh. Pengaturan ini memengaruhi langganan aliran audio bagi pengguna yang bergabung ke saluran setelahnya. Atur parameter ini ke true kecuali Anda memiliki persyaratan khusus.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

• Sebelum Anda bergabung ke saluran:

  • Secara default, kit pengembangan perangkat lunak (SDK) berlangganan ke semua aliran audio jarak jauh ketika pengguna bergabung ke saluran. Untuk mengubah perilaku ini, Anda dapat memanggil metode ini sebelum bergabung ke saluran.

• Setelah Anda bergabung ke saluran:

  • Untuk menghentikan langganan default, Anda dapat memanggil setDefaultSubscribeAllRemoteAudioStreams(false). SDK tidak akan berlangganan ke aliran audio pengguna yang bergabung ke saluran setelah itu.

  • Setelah Anda menghentikan langganan default, Anda dapat memanggil metode subscribeRemoteAudioStream untuk berlangganan aliran audio pengguna tertentu. Untuk berlangganan aliran beberapa pengguna, Anda harus memanggil metode ini untuk masing-masing pengguna.

  • Setelah Anda menghentikan langganan default, memanggil setDefaultSubscribeAllRemoteAudioStreams(true) hanya memengaruhi pengguna yang bergabung ke saluran setelahnya. SDK tidak akan berlangganan ke aliran audio dari pengguna jarak jauh yang telah bergabung saat langganan default dinonaktifkan.

Parameter

Pengembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lain menunjukkan bahwa kode kesalahan dikembalikan.

Berlangganan atau berhenti berlangganan aliran audio dari pengguna jarak jauh tertentu.

public abstract int subscribeRemoteAudioStream(String uid, boolean sub);

Anda dapat menggunakan metode ini untuk berlangganan atau berhenti berlangganan aliran audio dari pengguna jarak jauh tertentu. Untuk sebagian besar skenario, Anda harus mengatur parameter sub ke true.

Parameter

Pengembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai bukan nol menunjukkan bahwa pemanggilan gagal.

Berlangganan atau berhenti berlangganan dari semua aliran audio remote.

public abstract int subscribeAllRemoteAudioStreams(boolean sub);

Metode ini merupakan sakelar utama untuk berlangganan aliran audio jarak jauh. Kami menyarankan Anda mengatur parameter ini ke true. Jika Anda mengatur parameter ini ke false:

• SDK berhenti berlangganan dari semua aliran audio jarak jauh di saluran saat ini.

• Pengguna baru tidak akan lagi berlangganan.

• Anda tidak dapat menggunakan <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="a56b5f2a3f56k">subscribeRemoteAudioStream</a> untuk mengontrol secara individual aliran audio pengguna tertentu.

Untuk berlangganan kembali, Anda dapat memanggil metode ini lagi dan mengatur parameter ke true.

Parameter

Nilai kembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai selain 0 menunjukkan bahwa pemanggilan gagal.

Mengatur apakah akan memublikasikan aliran kamera.

public abstract int publishLocalVideoStream(boolean enable);

Metode ini mengontrol apakah akan memublikasikan aliran video yang ditangkap secara lokal.

Kapan harus dipanggil

Anda dapat memanggil metode ini sebelum atau sesudah Anda bergabung dengan saluran.

Jika Anda memanggil metode ini sebelum bergabung ke saluran, Anda dapat mengubah konfigurasi default. Konfigurasi baru akan berlaku saat Anda bergabung ke saluran.

Callback terkait

Ketika status pengambilan aliran audio lokal berubah, Klien lokal memicu callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#afe6d3c4b1rvg" id="8b70bc353aj68">onVideoPublishStateChanged</a> untuk memberikan status terbaru pengambilan aliran audio, sedangkan Klien jarak jauh memicu callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7078e15087a0z" id="176ee94b46lb7">onRemoteTrackAvailableNotify</a> guna memberi tahu perubahan pada aliran audio dan video pengguna jarak jauh.

Parameter

Mengembalikan

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Memeriksa apakah aliran video lokal telah dipublikasikan.

public abstract boolean isLocalVideoStreamPublished();

Mengembalikan

Mengembalikan true jika aliran kamera telah dipublikasikan, atau false jika tidak.

Mengatur apakah akan berlangganan ke semua aliran video jarak jauh secara default.

public abstract int setDefaultSubscribeAllRemoteVideoStreams(boolean sub);

Metode ini mengatur perilaku default untuk berlangganan aliran video. Secara default, kit pengembangan perangkat lunak (SDK) berlangganan ke semua aliran video jarak jauh.

Kapan harus memanggil

Anda dapat memanggil metode ini baik sebelum maupun setelah bergabung ke saluran. Jika Anda bergabung ke saluran lalu memanggil setDefaultSubscribeAllRemoteVideoStreams(false), Anda tidak akan menerima aliran video dari pengguna yang bergabung ke saluran setelah pemanggilan tersebut.

Setelah berhenti menerima aliran video, Anda dapat memanggil subscribeRemoteVideoStream dan menentukan ID pengguna jarak jauh untuk melanjutkan penerimaan aliran mereka. Jika ingin melanjutkan penerimaan aliran video dari beberapa pengguna, Anda harus memanggil subscribeRemoteVideoStream beberapa kali. Metode `setDefaultSubscribeAllRemoteVideoStreams(true)` hanya melanjutkan penerimaan aliran video dari pengguna yang kemudian bergabung ke saluran.

API ini digunakan untuk mengatur apakah akan berlangganan aliran video dari pengguna jarak jauh secara default.

Parameter

Nilai Kembali

0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Berlangganan atau berhenti berlangganan aliran video jarak jauh tertentu.

public abstract int subscribeRemoteVideoStream(String uid, AliRtcVideoTrack track, boolean sub);

Anda dapat menggunakan metode ini untuk berlangganan atau berhenti berlangganan aliran video dari pengguna tertentu.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau sesudah Anda bergabung dengan saluran.

Parameter

Mengembalikan

• 0: Metode berhasil dijalankan.

• Nilai bukan nol: Metode gagal dijalankan.

Menghentikan atau melanjutkan penerimaan semua aliran video remote.

public abstract int subscribeAllRemoteVideoStreams(boolean sub);

Metode ini merupakan sakelar utama untuk Berlangganan aliran video jarak jauh. Jika Anda mengatur parameter ke false, hal berikut terjadi:

• SDK berhenti Berlangganan semua aliran video jarak jauh di saluran saat ini.

• Pengguna baru yang bergabung ke saluran nanti juga tidak akan dilanggani, meskipun Anda telah memanggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#c90127d90d22o" id="8661e30c89dum">setDefaultSubscribeAllRemoteVideoStreams</a>(true) untuk Berlangganan secara default.

• Anda tidak dapat menggunakan <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b738a1b498bc1" id="19b0cea8593i5">subscribeRemoteVideoStream</a> untuk mengontrol secara individual aliran video pengguna tertentu.

Untuk kembali Berlangganan, Anda dapat memanggil metode ini lagi dan mengatur parameter ke true.

Deskripsi parameter

Nilai kembalian

0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Menghentikan atau melanjutkan aliran media pengguna jarak jauh.

public abstract int subscribeRemoteMediaStream(String uid, AliRtcVideoTrack videoTrack, boolean subVideo, boolean subAudio);

Metode ini berlangganan aliran audio dan video jarak jauh.

Metode terkait

Dibandingkan dengan <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#4cec275051vr6" id="faff82a053mev">subscribeRemoteMediaStream[2/2]</a>, API ini menggunakan dua parameter Boolean, subVideo dan subAudio, untuk menentukan apakah akan berlangganan aliran audio dan video jarak jauh, serta parameter videoTrack untuk mengontrol aliran video mana yang ditarik.

Parameter

Mengembalikan

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Menghentikan atau melanjutkan langganan untuk aliran audio dan video pengguna jarak jauh.

public abstract int subscribeRemoteMediaStream(String uid, AliRtcVideoTrack videoTrack, AliRtcAudioTrack audioTrack);

Metode ini menggabungkan langganan untuk aliran audio dan video jarak jauh.

Metode terkait

Dibandingkan dengan subscribeRemoteMediaStream[1/2], antarmuka ini menggunakan parameter videoTrack dan audioTrack untuk menginformasikan SDK tentang status langganan yang diinginkan dalam satu panggilan. Sebagai contoh:

• Untuk Berlangganan aliran Kamera dan mikrofon, atur `videoTrack` ke AliRtcVideoTrackCamera dan `audioTrack` ke AliRtcAudioTrackMic.

• Jika Anda ingin berhenti Berlangganan aliran Kamera tetapi tetap mempertahankan mikrofon, atur videoTrack dan audioTrack masing-masing ke AliRtcVideoTrackNo dan AliRtcAudioTrackMic saat memanggil metode tersebut lagi.

• Jika Anda ingin membatalkan keduanya, atur videoTrack dan audioTrack masing-masing ke AliRtcVideoTrackNo dan AliRtcAudioTrackNo pada pemanggilan berikutnya.

• Untuk berlangganan baik aliran Kamera maupun aliran berbagi layar, atur videoTrack ke AliRtcVideoTrackBoth. Logika yang sama berlaku untuk aliran audio.

Parameter

Nilai kembali

• 0: Panggilan metode berhasil.

• <0: Gagal menerapkan pengaturan.

Berlangganan ke aliran pengguna tertentu di saluran lain.

public abstract int subscribeRemoteDestChannelStream(String channelId, String uid, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

Parameter

Pengembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Jika tidak, kode kesalahan dikembalikan.

Berlangganan atau berhenti berlangganan dari semua aliran pengguna di saluran jarak jauh.

public abstract int subscribeRemoteDestChannelAllStream(String channelId, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

Parameter

Pengembalian

• 0: Metode berhasil dipanggil.

• Nilai bukan nol: Pemanggilan metode gagal.

Menyesuaikan volume pemutaran aliran audio jarak jauh.

public abstract int setRemoteAudioVolume(String uid, int volume);

Metode ini menyesuaikan volume pemutaran aliran audio pengguna jarak jauh pada perangkat lokal.

Parameter

Returns

• 0: Pemanggilan metode berhasil.

• Nilai bukan nol: Pemanggilan metode gagal, misalnya karena nilai volume tidak valid.

Menghentikan atau melanjutkan pengiriman aliran audio lokal.

public abstract int muteLocalMic(boolean mute, AliRtcMuteLocalAudioMode mode);

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Callback terkait

Setelah pemanggilan berhasil, pengguna jarak jauh memicu callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#ea457055e4izi" id="cce3d390a3xud">onUserAudioMuted</a> untuk menunjukkan apakah mereka dimatikan suaranya.

Parameter

Nilai kembalian

Mengembalikan 0 jika berhasil, atau nilai bukan nol jika gagal. Mematikan suara hanya mengirimkan frame diam. Modul perekaman dan pengkodean audio tetap berjalan.

Menghentikan atau melanjutkan pemutaran aliran audio jarak jauh.

public abstract int muteRemoteAudioPlaying(String uid, boolean mute);

API ini hanya menghentikan atau melanjutkan pemutaran audio dari pengguna jarak jauh tertentu. Operasi ini tidak memengaruhi penarikan aliran atau decoding audio jarak jauh. Untuk berhenti berlangganan aliran audio pengguna, Anda dapat memanggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="66a2ef0919jjg">subscribeRemoteAudioStream</a>.

Kapan harus dipanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Parameter

Mengembalikan

Nilai 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Menghentikan atau melanjutkan pemutaran semua audio remote.

public abstract int muteAllRemoteAudioPlaying(boolean mute);

API ini digunakan untuk menghentikan atau melanjutkan pemutaran semua audio jarak jauh.

Kapan harus memanggil metode ini

Anda dapat memanggil metode ini sebelum atau setelah bergabung dengan saluran.

Parameter

Nilai kembalian

Mengembalikan 0 jika pemanggilan metode berhasil, atau nilai selain 0 jika pemanggilan gagal.

Memulai penangkapan audio.

public abstract int startAudioCapture();

Metode ini memulai pengambilan audio. Anda dapat memanggil metode ini sebelum bergabung ke saluran untuk memulai pengambilan audio lebih awal. Jika tidak, SDK secara otomatis mengontrol perangkat pengambilan audio. Setelah Anda menghentikan pengambilan audio dengan memanggil stopAudioCapture, Anda dapat memanggil metode ini lagi untuk memulainya kembali.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Metode terkait

Antarmuka <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b71a48f4b84n0" id="4565abdceeq8i">startAudioCapture[2/2]</a> menggunakan parameter untuk mengontrol apakah perangkat pengambilan audio tetap diaktifkan setelah Anda meninggalkan saluran.

Callback terkait

Setelah Anda memanggil metode ini untuk mengubah status pengambilan audio lokal, callback onLocalAudioStateChanged melaporkan perubahan status tersebut.

Mengembalikan nilai

0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Memulai penangkapan audio.

public abstract int startAudioCapture(boolean keepAlive);

Muting mematikan pengambilan mikrofon.

Anda dapat menggunakan metode ini untuk memulai pengambilan audio. Anda dapat memanggil metode ini sebelum bergabung ke saluran untuk memulai pengambilan audio lebih awal. Jika Anda tidak memanggil metode ini, kit pengembangan perangkat lunak (SDK) secara otomatis mengontrol perangkat pengambilan audio.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Metode terkait

Berbeda dengan startAudioCapture[1/2], metode ini memungkinkan Anda menggunakan parameter keepAlive untuk menentukan apakah perangkat pengambilan tetap menyala setelah Anda meninggalkan saluran.

Callback terkait

Setelah Anda memanggil metode ini untuk mengubah status pengambilan audio lokal, callback onLocalAudioStateChanged dipicu untuk melaporkan perubahan status tersebut.

Deskripsi parameter

Pengembalian

Mengembalikan 0 jika pemanggilan metode berhasil. Mengembalikan nilai bukan nol jika pemanggilan gagal.

Menghentikan penangkapan audio.

public abstract int stopAudioCapture();

SDK mengaktifkan pengambilan audio secara default. Memulai pratinjau atau bergabung ke saluran akan secara otomatis memulai pengambilan audio. Untuk menghentikan perangkat audio dari pengambilan audio, Anda dapat memanggil metode ini.

Callback terkait

Setelah Anda memanggil metode ini, callback onLocalAudioStateChanged melaporkan perubahan status pengambilan audio lokal.

Mengembalikan

0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Mengatur output audio default ke speakerphone.

public abstract int setDefaultAudioRoutetoSpeakerphone(boolean defaultToSpeakerphone);

Anda dapat memanggil metode ini sebelum bergabung ke saluran untuk mengatur perangkat routing audio default. Anda dapat mengatur output audio default ke earpiece atau speakerphone. Secara default, SDK menggunakan speakerphone. Untuk mengubah pengaturan default ini, Anda dapat memanggil metode ini sebelum bergabung ke saluran.

SDK memiliki prioritas yang telah ditentukan untuk routing audio. SDK secara otomatis mengalihkan rute audio berdasarkan periferal yang terhubung. Prioritasnya adalah sebagai berikut: Headset berkabel > Headset Bluetooth > Pengaturan pengguna > Pengaturan default. Jika tidak ada periferal yang terhubung dan Anda tidak memanggil metode enableSpeakerphone, maka pengaturan default akan digunakan.

Untuk informasi selengkapnya tentang routing audio, lihat Pengaturan routing audio.

Perangkat seluler biasanya memiliki dua perangkat output audio: earpiece dan speakerphone.

• Earpiece: Audio-nya pelan. Anda harus memegang perangkat dekat telinga agar dapat mendengar dengan jelas. Opsi ini memberikan privasi yang lebih baik dan cocok untuk panggilan telepon.

• Speakerphone: Audio-nya keras. Anda dapat mendengar dengan jelas tanpa perlu menempelkan perangkat ke telinga. Opsi ini mengaktifkan fitur hands-free.

Metode terkait

Metode ini mengubah pengaturan routing audio default. Metode enableSpeakerphone mengatur perangkat routing audio saat ini.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Parameter

Mengembalikan

• 0: Metode berhasil dipanggil.

• <0: Pemanggilan metode gagal.

Mengatur output audio ke earpiece atau speaker.

public abstract int enableSpeakerphone(boolean enable);

Metode ini mengatur perangkat pemutaran audio ke earpiece atau speaker setelah Anda bergabung ke saluran. Jika Anda tidak memanggil metode ini, perangkat yang ditentukan oleh routing audio default akan digunakan untuk pemutaran.

SDK memiliki prioritas routing audio yang telah ditentukan sebelumnya dan secara otomatis mengalihkan rute berdasarkan status koneksi perangkat periferal. Prioritasnya adalah sebagai berikut: Wired headset>Bluetooth headset>User settings>Default settings. Oleh karena itu, pemanggilan metode ini tidak berpengaruh ketika perangkat periferal terhubung. Untuk informasi selengkapnya, lihat Audio routing settings.

Kapan harus memanggil

Anda dapat memanggil metode ini baik sebelum maupun setelah bergabung ke saluran.

Metode terkait

Metode <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#d4dab00b21ebx" id="944fb5797e773">setDefaultAudioRoutetoSpeakerphone</a> memodifikasi pengaturan rute audio default dan menetapkan perangkat routing saat ini.

Parameter

Mengembalikan

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Memeriksa apakah output audio saat ini adalah speaker atau earpiece.

public abstract boolean isSpeakerOn();

Mengembalikan

true jika output audio adalah speaker. false jika output audio adalah earpiece.

Mengaktifkan notifikasi volume audio.

public abstract int enableAudioVolumeIndication(int interval, int smooth, int reportVad);

Metode ini memungkinkan SDK melaporkan secara berkala volume audio pengguna lokal yang melakukan publikasi dan pengguna jarak jauh dengan volume instan tertinggi. Untuk menerima laporan tersebut, Anda harus mengimplementasikan kelas AliRtcAudioVolumeObserver dan memanggil metode registerAudioVolumeObserver untuk mendaftarkan objek pendengar.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Callback terkait

Setelah Anda memanggil metode ini, SDK memicu callback berikut pada interval yang ditentukan jika ada pengguna yang mempublikasikan aliran di saluran:

• Volume audio setiap pembicara dilaporkan melalui callback AliRtcAudioVolumeObserver#onAudioVolume. Frekuensi callback ini ditentukan oleh parameter interval.

• UID pembicara aktif dilaporkan melalui callback AliRtcAudioVolumeObserver#onActiveSpeaker ketika pembicara aktif terdeteksi.

Parameter

Nilai kembali

Mengembalikan 0 jika pemanggilan metode berhasil. Mengembalikan nilai selain 0 jika pemanggilan gagal.

Mengaktifkan pemantauan in-ear.

public abstract int enableEarBack(boolean enable);

Metode ini mengaktifkan atau menonaktifkan pemantauan in-ear. Untuk pengalaman terbaik, aktifkan fitur ini saat Anda menggunakan headphone, baik yang berkabel maupun Bluetooth.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Parameter

Returns

0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa panggilan gagal.

Menetapkan volume pemantauan in-ear.

public abstract int setEarBackVolume(int volume) ;

Pengaturan ini hanya berlaku setelah Anda mengaktifkan fitur pemantauan in-ear dengan memanggil enableEarBack.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Parameter

Nilai kembalian

• 0: Metode berhasil dipanggil.

• <0: Pemanggilan metode gagal.

Memulai perangkat pemutaran audio.

public abstract int startAudioPlayer();

Metode ini memungkinkan Anda memulai perangkat pemutaran audio terlebih dahulu. Jika Anda tidak memanggil metode ini, SDK akan secara otomatis memulai perangkat pemutaran audio setelah berlangganan ke aliran audio.

Pengembalian

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal. Nilai tersebut adalah kode kesalahan.

Menghentikan perangkat pemutaran audio.

 public abstract int stopAudioPlayer();

Metode ini merupakan pasangan dari startAudioPlayer.

Deskripsi respons

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal. Kode kesalahan dikembalikan.

Mengatur volume pemutaran lokal.

public abstract int setPlayoutVolume(int volume);

Parameter

Returns

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal.

Mengatur volume rekaman.

public abstract int setRecordingVolume(int volume);

Parameter

Mengembalikan

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal.

Memainkan file audio.

public abstract int playAudioFileTest(String filePath) ;

Metode ini memutar file audio untuk menguji pemutaran audio sebelum Anda bergabung ke saluran.

Kapan harus memanggil

Anda hanya dapat memanggil metode ini sebelum bergabung ke saluran.

Batasan

Setiap pemanggilan metode ini akan menimpa pemanggilan sebelumnya. Pemanggilan baru akan menghentikan file audio apa pun yang sedang diputar.

Parameter

Mengembalikan

• 0: Pemanggilan metode berhasil.

• Nilai bukan nol: Pemanggilan metode gagal.

Menghentikan pemutaran file audio.

public abstract int stopAudioFileTest();

Metode ini merupakan pasangan dari playAudioFileTest.

Batasan

Anda hanya dapat memanggil metode ini sebelum bergabung ke saluran.

Pengembalian

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal.

Memulai pengujian perangkat penangkapan audio sebelum panggilan.

public abstract int startAudioCaptureTest();

Anda dapat menggunakan metode ini sebelum panggilan untuk memeriksa apakah perangkat tangkapan audio lokal berfungsi dengan benar. Setelah Anda memanggil metode ini, SDK melaporkan volume perangkat tangkapan melalui callback AliRtcAudioVolumeObserver::OnTestAudioVolume.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum bergabung ke saluran. Setelah pengujian selesai, Anda harus memanggil stopAudioCaptureTest untuk menghentikan pengujian perangkat. Hal ini mencegah perangkat tetap terpakai.

Mengembalikan

• 0: Panggilan berhasil.

• Nilai bukan nol: Pemanggilan gagal. Kode kesalahan dikembalikan.

Menghentikan pendeteksian perangkat perekaman audio.

public abstract int stopAudioCaptureTest();

Setelah Anda memanggil startAudioCaptureTest, Anda harus memanggil metode ini untuk menghentikan pengujian.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum bergabung ke saluran.

Nilai kembalian

• 0: Pemanggilan berhasil.

• Nilai bukan nol: Pemanggilan gagal. Kode kesalahan dikembalikan.

Mengatur mode efek pengubah suara.

public abstract int setAudioEffectVoiceChangerMode(AliRtcAudioEffectVoiceChangerMode mode);

Parameter

Mengembalikan

Nilai kembali 0 menunjukkan panggilan berhasil. Nilai lainnya menunjukkan panggilan gagal.

Mengatur pitch audio.

public abstract int setAudioEffectPitchValue(double value);

Parameter

Pengembalian

Nilai 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Menetapkan mode efek suara gema.

public abstract int setAudioEffectReverbMode(AliRtcAudioEffectReverbMode mode);

Parameter

Mengembalikan

Mengembalikan 0 jika pemanggilan metode berhasil. Mengembalikan nilai selain 0 jika pemanggilan metode gagal.

Mengatur jenis dan parameter efek suara reverb.

public abstract int setAudioEffectReverbParamType(AliRtcAudioEffectReverbParamType type, float value);

Parameter

Pengembalian

0 menunjukkan panggilan berhasil. Nilai lainnya menunjukkan panggilan gagal.

Menambahkan aliran audio eksternal.

public abstract int addExternalAudioStream(AliRtcExternalAudioStreamConfig config);

Metode ini menambahkan aliran audio eksternal. Langkah-langkahnya adalah sebagai berikut:

1. Panggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="20c33a9acb0ui">addExternalAudioStream</a> untuk menambahkan aliran audio eksternal dan mendapatkan ID aliran audio eksternal tersebut.

2. Panggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="d3deb62b2fl0f">pushExternalAudioStreamRawData</a> untuk mendorong data audio ke aliran audio yang telah dibuat.

3. Saat panggilan berakhir, panggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="16d826dedcli6">removeExternalAudioStream</a> untuk menghapus aliran audio eksternal tersebut.

Untuk memublikasikan audio hasil tangkapan kustom dalam saluran, lihat Custom Audio Capture.

Parameter

Nilai kembali

Nilai kembali >0 menunjukkan keberhasilan dan merupakan ID dari aliran audio eksternal tersebut. Nilai lainnya menunjukkan kegagalan.

Mendorong data aliran audio eksternal.

public abstract int pushExternalAudioStreamRawData(int streamId, AliRtcAudioFrame rawData);

Anda dapat menggunakan metode ini untuk meneruskan data ke aliran audio tertentu. Langkah-langkahnya adalah sebagai berikut:

1. Panggil metode <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="8822f2932e9ep">addExternalAudioStream</a> untuk menambahkan aliran audio eksternal dan mendapatkan ID aliran audio eksternal tersebut.

2. Panggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="880fe8cd02j10">pushExternalAudioStreamRawData</a> untuk meneruskan data audio ke aliran audio yang telah dibuat.

3. Saat panggilan berakhir, Anda perlu memanggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="106c7aefa27c0">removeExternalAudioStream</a> untuk menghapus aliran audio eksternal tersebut.

Untuk memublikasikan audio hasil tangkapan kustom dalam saluran, lihat Custom audio capture.

Kapan harus memanggil

Anda dapat memanggil metode ini setelah bergabung ke dalam saluran.

Parameter

Pengembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lain menunjukkan bahwa pemanggilan gagal.

Mengatur volume publikasi aliran audio eksternal.

public abstract int setExternalAudioStreamPublishVolume(int streamId, int publishVolume);

Parameter

Pengembalian

Nilai kembali 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Mendapatkan volume publikasi dari aliran audio eksternal.

public abstract int getExternalAudioStreamPublishVolume(int streamId);

Parameter

Return value

Bilangan bulat dari 0 hingga 100 yang menunjukkan volume publikasi. Nilai < 0 menunjukkan bahwa operasi gagal.

Menetapkan volume pemutaran aliran audio eksternal.

public abstract int setExternalAudioStreamPlayoutVolume(int streamId, int playoutVolume);

Parameter

Nilai kembali

0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa pemanggilan metode gagal.

Mendapatkan volume pemutaran aliran audio eksternal.

public abstract int getExternalAudioStreamPlayoutVolume(int streamId);

Parameter

Return value

Volume pemutaran, yang berkisar antara 0 hingga 100. Nilai < 0 menunjukkan bahwa panggilan gagal.

Menghapus aliran audio eksternal.

public abstract int removeExternalAudioStream(int streamId);

Metode ini menghapus aliran audio eksternal yang sesuai dengan streamId yang ditentukan. Metode ini merupakan pasangan dari metode addExternalAudioStream.

Penggunaan

Untuk menggunakan fitur input audio kustom, Anda dapat memanggil metode addExternalAudioStream untuk menambahkan aliran audio dan mendapatkan ID-nya. Kemudian, Anda dapat memanggil metode pushExternalAudioStreamRawData untuk mendorong data audio Anda ke SDK. Saat Anda ingin menghentikan input audio kustom, Anda dapat memanggil metode ini untuk menghapus aliran audio eksternal yang sesuai dan melepaskan sumber daya.

Parameter

Nilai kembali

• 0: Pemanggilan berhasil.

• <0: Pemanggilan gagal. Kode kesalahan dikembalikan.

Anda dapat memperoleh informasi berkas audio.

public abstract int getAudioFileInfo(String fileName);

Anda dapat memanggil API ini untuk mengambil informasi durasi berkas secara asinkron. Ini adalah API asinkron, dan Anda dapat mengambil informasi berkas audio melalui onAudioFileInfo.

Deskripsi parameter

Kembali ke Pendahuluan

• 0: Pemanggilan berhasil.

• Nilai bukan nol: Kode kesalahan.

Memulai pencampuran musik pengiring.

public abstract int startAudioAccompany(String fileName, AliRtcAudioAccompanyConfig config) ;

Metode ini memutar file iringan audio lokal atau daring. Ini merupakan panggilan asinkron. Setelah Anda memanggil metode ini, Anda dapat mendengarkan status pemutaran iringan melalui callback AliRtcEngineNotify#onAudioAccompanyStateChanged.

Kapan harus memanggil

Anda dapat memanggil metode ini setelah bergabung ke dalam saluran.

Batasan

Berbeda dengan efek suara, hanya satu iringan audio yang dapat diputar dalam satu waktu. Pemanggilan berikutnya terhadap metode ini akan menimpa iringan saat ini.

Parameter

Pengembalian

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal. Kode kesalahan dikembalikan.

Menghentikan pencampuran iringan audio.

public abstract int stopAudioAccompany() ;

Metode ini menghentikan pemutaran iringan audio dan dipasangkan dengan startAudioAccompany.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Nilai kembalian

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal. Kode kesalahan dikembalikan.

Mengatur volume iringan audio, yang mencakup volume pemutaran lokal dan volume pengambilan aliran.

public abstract int setAudioAccompanyVolume( int volume) ;

Metode ini mengatur volume untuk pemutaran lokal maupun pengambilan aliran. Sebagai perbandingan, setAudioAccompanyPlayoutVolume hanya mengatur volume pemutaran lokal, dan setAudioAccompanyPublishVolume hanya mengatur volume pengambilan aliran.

Parameter

Mengembalikan

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal. Nilai tersebut merupakan kode kesalahan.

Mengatur volume pengambilan aliran untuk iringan audio.

public abstract int setAudioAccompanyPublishVolume(int volume) ;

Parameter

Mengembalikan

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal dan kode kesalahan dikembalikan.

Mendapatkan volume pengambilan aliran dari iringan audio.

public abstract int getAudioAccompanyPublishVolume() ;

Mengembalikan

Volume pengambilan aliran dari musik latar.

• Nilai dalam rentang 0 hingga 100 menunjukkan panggilan berhasil.

• Nilai lainnya menunjukkan kode kesalahan.

Menetapkan volume pemutaran lokal dari audio iringan.

public abstract int setAudioAccompanyPlayoutVolume(int volume) ;

Parameter

Pengembalian

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal dan kode kesalahan dikembalikan.

Mendapatkan volume pemutaran lokal untuk audio iringan.

public abstract int getAudioAccompanyPlayoutVolume() ;

Pengembalian

Volume pemutaran lokal dari audio iringan.

• Nilai dari 0 hingga 100 menunjukkan keberhasilan.

• Nilai lainnya menunjukkan kode kesalahan.

Menghentikan sementara pencampuran iringan audio.

public abstract int pauseAudioAccompany();

Mengembalikan

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal. Nilai tersebut adalah kode kesalahan.

Melanjutkan pencampuran audio pendamping.

public abstract int resumeAudioAccompany();

Pengembalian

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal. Nilai tersebut merupakan kode kesalahan.

Mendapatkan durasi file iringan dalam milidetik.

public abstract int getAudioAccompanyDuration();

Metode ini mendapatkan durasi file iringan saat ini.

Mengembalikan

• >= 0: Durasi file iringan.

• < 0: Kode kesalahan jika panggilan gagal.

Mendapatkan progres pemutaran file iringan audio dalam milidetik.

public abstract int getAudioAccompanyCurrentPosition();

Metode ini mendapatkan progres pemutaran file iringan audio saat ini dalam milidetik.

Mengembalikan

• >=0: Progres pemutaran file iringan audio.

• <0: Kode kesalahan yang menunjukkan panggilan gagal.

Menetapkan posisi pemutaran file iringan audio.

public abstract int setAudioAccompanyPosition(int posMs);

Metode ini berguna untuk mengimplementasikan fitur seperti bilah progres yang dapat diseret. Setelah panggilan berhasil, file iringan audio mulai diputar dari posisi yang ditentukan oleh posMs.

Parameter

Pengembalian

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal dan kode kesalahan dikembalikan.

Memuat terlebih dahulu file efek suara.

public abstract int preloadAudioEffect(int soundId, String filePath);

Parameter

Pengembalian

0 menunjukkan bahwa metode dipanggil berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Membongkar file efek suara yang telah dimuat sebelumnya.

public abstract int unloadAudioEffect(int soundId);

Parameter

Pengembalian

Nilai 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai bukan nol menunjukkan bahwa pemanggilan metode gagal.

Memainkan efek suara.

public abstract int playAudioEffect(int soundId, String filePath, int cycles, boolean publish);

Parameter

Returns

Mengembalikan 0 jika pemanggilan metode berhasil, atau nilai bukan nol jika pemanggilan gagal.

Menghentikan pemutaran efek suara.

public abstract int stopAudioEffect(int soundId);

Parameter

Pengembalian

Mengembalikan 0 jika pemanggilan metode berhasil. Mengembalikan nilai bukan nol jika pemanggilan metode gagal.

Menghentikan semua efek suara.

public abstract int stopAllAudioEffects();

Pengembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai selain 0 menunjukkan bahwa pemanggilan metode gagal.

Mengatur volume publikasi untuk efek suara.

public abstract int setAudioEffectPublishVolume(int soundId, int volume);

Parameter

Returns

Mengembalikan 0 jika metode dipanggil berhasil. Mengembalikan nilai lain jika panggilan gagal.

Mendapatkan volume efek suara untuk pengambilan aliran.

public abstract int getAudioEffectPublishVolume(int soundId);

Parameter

Returns

Mengembalikan 0 jika metode dipanggil berhasil. Mengembalikan nilai selain 0 jika pemanggilan metode gagal.

Menetapkan volume pemutaran lokal dari efek suara.

public abstract int setAudioEffectPlayoutVolume(int soundId, int volume);

Parameter

Pengembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan metode gagal.

Mendapatkan volume pemutaran lokal dari efek suara di Android dan iOS.

public abstract int getAudioEffectPlayoutVolume(int soundId);

Parameter

Returns

Nilai kembali 0 menunjukkan bahwa metode dipanggil dengan sukses. Nilai lainnya menunjukkan bahwa panggilan gagal.

Mengatur volume pencampuran semua efek suara untuk dipublikasikan.

public abstract int setAllAudioEffectsPublishVolume(int volume);

Parameter

Mengembalikan

Nilai 0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa panggilan gagal.

Mengatur volume pemutaran lokal untuk semua efek suara di Android dan iOS.

public abstract int setAllAudioEffectsPlayoutVolume(int volume);

Parameter

Nilai kembali

0 menunjukkan pemanggilan metode berhasil. Nilai bukan nol menunjukkan pemanggilan metode gagal.

Memulai perekaman file media.

public abstract boolean startRecord(AliRtcRecordType recordType, AliRtcRecordFormat recordFormat, String filePath, AliRtcRecordAudioConfig audioConfig, AliRtcRecordVideoConfig videoConfig, long maxSize, long maxDuration);

Parameter

Nilai kembalian

Nilai TRUE menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan perekaman file media.

  public abstract void stopRecord();

Parameter

Tidak ada.

Menghentikan sementara efek suara.

public abstract int pauseAudioEffect(int soundId);

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Menghentikan sementara semua efek suara.

public abstract int pauseAllAudioEffects();

Pengembalian

0 menunjukkan bahwa metode dipanggil berhasil. Nilai lainnya menunjukkan bahwa panggilan gagal.

Melanjutkan pemutaran efek suara.

public abstract int resumeAudioEffect(int soundId);

Parameter

Return value

Nilai 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan metode gagal.

Menjalankan kembali pemutaran semua efek suara.

public abstract int resumeAllAudioEffects();

Pengembalian

0 menunjukkan bahwa metode dipanggil dengan sukses. Nilai selain 0 menunjukkan bahwa panggilan gagal.

Membuat tampilan rendering SurfaceView.

public abstract SophonSurfaceView createRenderSurfaceView(Context context);

Anda dapat memanggil metode ini untuk menampilkan tampilan video. Jangan membuat SurfaceView secara langsung. Gunakan tampilan yang dikembalikan sebagai berikut:

• Tetapkan nilai kembali ke AliRtcVideoCanvas#view.

• Panggil setLocalViewConfig untuk mengatur tampilan pratinjau lokal atau panggil setRemoteViewConfig untuk mengatur tampilan pratinjau jarak jauh.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Batasan

Anda harus memanggil metode ini pada thread utama.

Parameter

Menetapkan jendela rendering dan parameter untuk pratinjau lokal.

public abstract int setLocalViewConfig(AliRtcVideoCanvas viewConfig, AliRtcVideoTrack track);

Metode ini mengonfigurasi pratinjau lokal. Metode ini menyambungkan tampilan ke aliran video lokal dan mengatur parameter untuk tampilan pengguna lokal, seperti mode rendering, mode cermin, dan sudut rotasi. Metode ini hanya memengaruhi pratinjau lokal dan tidak memengaruhi aliran video yang diingest. Untuk mengonfigurasi tampilan bagi pengguna jarak jauh, Anda dapat memanggil setRemoteViewConfig.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan bahwa metode berhasil dipanggil. Nilai bukan nol menunjukkan bahwa panggilan gagal.

Menetapkan jendela rendering dan parameter untuk aliran video dari pengguna jarak jauh.

public abstract int setRemoteViewConfig(AliVideoCanvas canvas, String uid,AliRtcVideoTrack track);

Metode ini menyambungkan tampilan ke aliran video tertentu dari pengguna jarak jauh. Metode ini juga menetapkan parameter untuk tampilan lokal dari tampilan jarak jauh tersebut, seperti mode rendering, mode cermin (mirror), dan sudut rotasi. Pengaturan ini hanya memengaruhi video yang dilihat oleh pengguna lokal. Untuk mengatur tampilan pratinjau lokal, Anda dapat memanggil setLocalViewConfig.

• Jika parameter tampilan dalam AliRtcVideoCanvas kosong, rendering akan berhenti.

• Untuk mengatur ulang parameter renderMode dari AliRtcVideoCanvas selama pemutaran, Anda hanya boleh mengubah renderMode dan menjaga parameter lainnya tetap tidak berubah.

• Untuk mengatur ulang parameter mirrorMode dari AliRtcVideoCanvas selama pemutaran, Anda hanya boleh mengubah mirrorMode dan menjaga parameter lainnya tetap tidak berubah.

Kapan harus dipanggil

Anda dapat memanggil metode ini ketika menerima callback onRemoteTrackAvailableNotify. Callback ini menunjukkan bahwa aliran video dari pengguna jarak jauh tersedia.

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Menetapkan preferensi pengambilan gambar kamera.

public abstract int setCameraCapturerConfiguration(AliEngineCameraCapturerConfiguration cameraCapturerConfiguration);

Anda dapat menggunakan metode ini untuk mengonfigurasi preferensi pengambilan gambar kamera, seperti arah kamera dan laju frame pengambilan.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum membuka kamera, misalnya sebelum memanggil metode berikut:

• startPreview

• joinChannel

Deskripsi parameter

Nilai kembalian

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lain menunjukkan bahwa pemanggilan metode gagal.

Menonaktifkan atau mengaktifkan pengambilan video lokal.

public abstract int enableLocalVideo(boolean enable);

Metode ini mengaktifkan atau menonaktifkan pengambilan video lokal. Saat pengambilan video lokal dinonaktifkan, tidak ada data video yang tersedia untuk pratinjau lokal maupun pengambilan aliran. Hal ini tidak memengaruhi penerimaan video jarak jauh. Jika Anda memanggil metode ini untuk menonaktifkan pengambilan kamera lokal, pratinjau lokal dan pengambilan aliran jarak jauh akan membekukan pada bingkai terakhir.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran.

Callback terkait

Setelah pemanggilan metode ini berhasil, callback onUserVideoEnabled memberi tahu pengguna jarak jauh.

Deskripsi parameter

Nilai kembalian

Nilai 0 menunjukkan bahwa metode berhasil dipanggil. Nilai bukan nol menunjukkan bahwa pemanggilan gagal.

Menghentikan atau melanjutkan pengiriman data video lokal.

public abstract int muteLocalCamera(boolean mute, AliRtcVideoTrack track);

Anda dapat memanggil metode ini selama pengambilan aliran untuk mengirim frame video hitam. Pratinjau lokal tidak terpengaruh. Modul pengambilan, pengkodean, dan pengiriman tetap berjalan, tetapi mengirim frame hitam alih-alih video langsung.

Parameter

Nilai kembalian

Nilai 0 menunjukkan bahwa metode berhasil dipanggil.

Memeriksa apakah kamera menyala.

public abstract boolean isCameraOn();

Mengembalikan

true jika kamera menyala, atau false jika kamera mati.

Menetapkan properti pengkodean video.

public abstract void setVideoEncoderConfiguration(AliRtcVideoEncoderConfiguration config);

Metode ini menetapkan parameter video untuk pengodean aliran video, seperti resolusi, laju frame, bitrate, dan orientasi video. Anda dapat memanggil metode ini untuk semua skenario video.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau sesudah bergabung dengan saluran. Untuk menetapkan properti pengkodean aliran kamera hanya sekali untuk setiap sesi, Anda dapat memanggil metode ini sebelum Anda bergabung dengan saluran.

Batasan pemanggilan

Baik parameter mirrorMode dari metode ini maupun metode setVideoMirrorMode dapat mengatur mode cermin untuk pengambilan aliran. Sebaiknya Anda hanya menggunakan salah satu dari metode ini. Menggunakan keduanya secara bersamaan dapat menyebabkan efek cermin tumpang tindih, yang dapat mengakibatkan kegagalan pencerminan atau tampilan yang salah.

Parameter

Mengatur properti decoding video.

    public abstract void setVideoDecoderConfiguration(AliRtcVideoDecoderConfiguration config);

Metode ini mengatur parameter video untuk properti decoding suatu aliran video.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum bergabung ke saluran.

Parameter

Beralih antara kamera depan dan belakang. Kamera depan digunakan secara default.

public abstract int switchCamera();

Metode ini memungkinkan Anda beralih secara dinamis antara kamera aktif saat aplikasi sedang berjalan. Anda tidak perlu me-restart aliran video atau mengonfigurasi ulang sumber video.

Kapan harus memanggil

Anda dapat memanggil metode ini setelah kamera mulai.

Batasan

Metode ini hanya tersedia di Android dan iOS.

Deskripsi respons

Nilai kembali 0 menunjukkan bahwa metode berhasil dipanggil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Mendapatkan arah kamera saat ini.

public abstract AliRTCCameraDirection getCurrentCameraDirection();

Deskripsi Respons

• CAMERA_REAR(0): Kamera belakang.

• CAMERA_FRONT(1): Kamera depan.

• CAMERA_INVALID(-1): Tidak valid.

Memulai pratinjau lokal.

public abstract int startPreview();

Metode ini memulai pratinjau video lokal dan secara otomatis menyalakan kamera. Untuk menghentikan pratinjau lokal, Anda dapat memanggil metode stopPreview.

Kapan harus memanggil

• Sebelum memanggil metode ini, Anda harus memanggil setLocalViewConfig untuk menetapkan tampilan bagi pratinjau lokal. Jika tidak, pratinjau tidak tersedia, tetapi hal ini tidak memengaruhi pengambilan aliran.

• Sesuai kebutuhan, Anda dapat memanggil metode ini untuk memulai pratinjau sebelum bergabung ke dalam saluran dengan memanggil joinChannel. Kamera akan secara otomatis menyala.

Pengembalian

Nilai kembali 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Menghentikan pratinjau lokal.

public abstract int stopPreview();

Metode ini menghentikan pratinjau video lokal dan mematikan kamera. Setelah pratinjau dihentikan, tampilan lokal tetap menampilkan bingkai terakhir. Hal ini tidak memengaruhi pengambilan aliran.

Kapan harus memanggil

Setelah Anda memulai pratinjau, Anda dapat memanggil metode ini untuk menghentikannya.

Pengembalian

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Mengatur faktor zoom kamera.

public abstract int setCameraZoom(float zoom);

Mengatur faktor zoom kamera.

Batasan

Metode ini hanya tersedia di iOS dan Android.

Kapan harus memanggil

Metode ini hanya berlaku setelah kamera dinyalakan. Faktor zoom akan diatur ulang setiap kali kamera dimulai ulang.

Parameter

Pengembalian

• 0: Pemanggilan metode berhasil.

• Nilai bukan nol: Panggilan metode gagal.

Mendapatkan faktor zoom maksimum kamera.

public abstract float GetCameraMaxZoomFactor();

Returns

Faktor zoom maksimum kamera.

Mendapatkan rasio zoom saat ini dari kamera.

public abstract float GetCurrentZoom();

Nilai yang dikembalikan

Rasio zoom saat ini dari kamera.

Menetapkan eksposur kamera.

public abstract int SetExposure(float exposure);

Kondisi pencahayaan yang buruk, seperti lingkungan yang terlalu redup atau terlalu terang, dapat memengaruhi kualitas video. Untuk meningkatkan kualitas video, Anda dapat menggunakan metode ini untuk menyesuaikan eksposur kamera. Anda dapat memanggil GetMinExposure dan GetMaxExposure untuk mendapatkan rentang eksposur yang didukung oleh perangkat saat ini.

Deskripsi parameter

Pengembalian

• 0: Pemanggilan metode berhasil.

• Nilai bukan nol: Panggilan metode gagal.

Mendapatkan eksposur kamera.

public abstract float GetCurrentExposure();

Mendapatkan pengaturan eksposur kamera saat ini.

Pengembalian

Eksposur kamera saat ini.

Mendapatkan eksposur minimum dari Kamera.

public abstract float GetMinExposure();

Pengembalian

Eksposur minimum dari kamera.

Mendapatkan eksposur maksimum yang didukung oleh kamera.

public abstract float GetMaxExposure();

Pengembalian

Eksposur maksimum kamera.

Mengontrol lampu kilat kamera.

public abstract int setCameraFlash(boolean flash);

Mengaktifkan atau menonaktifkan lampu kilat.

Batas panggilan

API ini hanya tersedia di iOS dan Android.

Parameter

Pengembalian

• 0: Berhasil.

• Nilai bukan nol: Gagal.

Memeriksa apakah perangkat mendukung fokus manual.

public abstract boolean isCameraFocusPointSupported();

Anda dapat memanggil metode ini untuk memeriksa apakah titik fokus dapat diatur pada kamera.

Batasan

Metode ini hanya tersedia di iOS dan Android.

Nilai yang dikembalikan

• true: Perangkat mendukung fokus manual.

• false: Perangkat tidak mendukung fokus manual.

Memeriksa apakah perangkat saat ini mendukung pengaturan titik eksposur kamera.

public abstract boolean isCameraExposurePointSupported();

Memeriksa apakah perangkat saat ini mendukung pengaturan titik eksposur.

Keterbatasan

Metode ini hanya tersedia di iOS dan Android.

Nilai kembali

• true: Perangkat mendukung pengaturan titik eksposur kamera.

• false: Perangkat tidak mendukung pengaturan titik eksposur kamera.

Menetapkan titik fokus manual untuk Kamera.

public abstract int setCameraFocusPoint(float x, float y);

Mengatur titik fokus untuk Kamera saat ini. Setelah metode ini dipanggil, Kamera melakukan penyesuaian eksposur satu kali pada titik yang ditentukan dan kemudian mempertahankan nilai fokus tersebut. Sebelum memanggil metode ini, Anda dapat memanggil isCameraFocusPointSupported untuk memeriksa apakah Perangkat mendukung fitur fokus manual.

Batasan

Metode ini hanya tersedia di iOS dan Android.

Parameter

Nilai kembalian

• 0: Pemanggilan metode berhasil.

• Nilai bukan nol: Pemanggilan metode gagal.

Menetapkan titik eksposur kamera.

public abstract int setCameraExposurePoint(float x, float y);

Mengatur titik eksposur kamera. Setelah metode ini dipanggil, kamera melakukan penyesuaian eksposur satu kali untuk titik yang ditentukan, lalu mempertahankan nilai eksposur tersebut. Sebelum memanggil metode ini, Anda dapat memanggil isCameraExposurePointSupported untuk memeriksa apakah perangkat mendukung fitur titik eksposur manual.

Batasan

Metode ini hanya tersedia di iOS dan Android.

Deskripsi parameter

Pengembalian

• 0: Metode berhasil dipanggil.

• Nilai bukan nol: Pemanggilan metode gagal.

Memeriksa apakah Kamera mendukung fokus wajah otomatis.

public abstract boolean isCameraAutoFocusFaceModeSupported();

Memeriksa apakah kamera mendukung fokus wajah otomatis.

Kapan harus dipanggil

Anda dapat memanggil metode ini setelah kamera dinyalakan. Metode ini mengembalikan false secara default jika kamera dimatikan. Metode ini mengembalikan true jika kamera dinyalakan dan mendukung pengenalan wajah serta fokus.

Batasan

API ini hanya tersedia di iOS dan Android.

Nilai kembalian

• true: Fokus wajah otomatis didukung.

• false: Fokus wajah otomatis tidak didukung.

Mengatur autofokus wajah untuk kamera.

public abstract boolean setCameraAutoFocusFaceModeEnabled(boolean enable);

Anda dapat memanggil metode ini untuk mengatur kamera agar memfokuskan pada wajah secara real time. Sebelum memanggil metode ini, Anda dapat memanggil isCameraAutoFocusFaceModeSupported untuk memeriksa apakah perangkat mendukung fitur ini.

Keterbatasan

Metode ini hanya tersedia di iOS dan Android.

Parameter

Pengembalian

• true: Pemanggilan metode berhasil.

• false: Pemanggilan metode gagal.

Mengatur apakah akan mengaktifkan mode cermin untuk pratinjau lokal dan aliran video yang dipublikasikan.

public abstract int setVideoMirrorMode(AliRtcVideoPipelineMirrorMode mirrorMode);

Mengatur apakah akan mengaktifkan mode cermin untuk video pratinjau lokal dan aliran video yang dipublikasikan.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran. SDK mencatat pengaturan tersebut dan menerapkannya pada video ketika pratinjau dan pengkodean (pengambilan aliran) tersedia.

Batasan

Metode ini menyediakan fungsionalitas yang sama dengan parameter mirrorMode dalam setLocalViewConfig&setVideoEncoderConfiguration. Anda hanya boleh menggunakan satu metode saja untuk mengonfigurasi pencerminan.

Parameter

Pengembalian

• 0: Sukses.

• <0: Kegagalan.

  • AliRtcErrInner: Terjadi kesalahan internal SDK. Periksa apakah instans SDK berhasil dibuat.

Mengatur waktu penskalaan pengambilan video.

public abstract void setCapturePipelineScaleMode(AliRtcCapturePipelineScaleMode mode);

Metode ini mengatur apakah penskalaan video terjadi segera saat pengambilan atau selama proses encoding. Misalnya, jika resolusi pengambilan berbeda dari resolusi encoding, Anda dapat mengatur waktu penskalaan untuk memastikan data pratinjau sesuai dengan data untuk pengambilan aliran.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum membuka kamera. Misalnya, Anda dapat memanggilnya sebelum memulai pratinjau dengan startPreview atau bergabung ke saluran dengan joinChannel.

Parameter

Mengembalikan

Tidak ada.

Mengaktifkan sumber input video eksternal.

public abstract void setExternalVideoSource(boolean enable,boolean useTexture,
 AliRtcVideoTrack streamType,AliRtcRenderMode renderMode);

Parameter

Anda dapat memasukkan data video.

public abstract int pushExternalVideoFrame(AliRtcRawDataFrame aliRawDataFrame,AliRtcVideoTrack streameType);

Parameter

Mengembalikan

Mengembalikan 0 jika panggilan berhasil. Mengembalikan nilai yang berbeda jika panggilan gagal.

Memulai aliran langsung bypass.

public abstract int startPublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan metode gagal.

Memperbarui parameter streaming langsung bypass.

public abstract int updatePublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

Parameter

Return value

Nilai kembali 0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan gagal.

Menghentikan aliran langsung bypass.

public abstract int stopPublishLiveStream(String streamUrl);

Parameter

Returns

0 menunjukkan bahwa pemanggilan metode berhasil. Nilai lainnya menunjukkan bahwa pemanggilan metode gagal.

Mendapatkan status aliran langsung bypass.

public abstract AliRtcEngine.AliRtcLiveTranscodingState getPublishLiveStreamState(String streamUrl);

Parameter

Pengembalian

Mengembalikan status streaming langsung bypass.

Memulai pengujian kualitas jaringan.

public abstract int startNetworkQualityProbeTest(AlirtcNetworkQualityProbeConfig config);

Parameter

Returns

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan tes probe kualitas jaringan.

public abstract int stopNetworkQualityProbeTest();

Pengembalian

0 menunjukkan keberhasilan. Nilai lainnya menunjukkan bahwa pengujian gagal.

Mengirim pesan ekstensi media.

public abstract int sendMediaExtensionMsg(byte[]message, int repeatCount, int delay, boolean isKeyFrame);

SDK memungkinkan Anda mengirim dan menerima pesan ekstensi media. Metode ini mengirim pesan tersebut menggunakan protokol ekstensi Supplemental Enhancement Information (SEI). Penerima dapat memperoleh pesan dengan mendengarkan callback onMediaExtensionMsgReceived.

Skenario umum meliputi hal-hal berikut:

• Meneruskan timestamp untuk menghitung latensi jaringan end-to-end atau menyinkronkan data dengan layanan lain.

• Meneruskan informasi deskriptif. Anda dapat mengirim data hingga 4 KB. Anda dapat menggunakan JSON atau string biasa.

Kapan harus memanggil

Anda dapat memanggil metode ini setelah pengambilan aliran dimulai.

Batasan

Pesan ekstensi media menggunakan kembali saluran data audio dan video. Anda harus mengontrol frekuensi dan panjang pesan kustom. Perhatikan batasan berikut:

• Anda dapat mengirim jumlah maksimum pesan per detik yang sama dengan frame per detik (fps) yang ditetapkan dalam profil. Hal ini karena pesan SEI dikirimkan dalam aliran H.264 atau H.265 dan hanya dapat dilampirkan saat frame video dikodekan.

• Isi pesan kustom dibatasi hingga 4 KB untuk menghindari dampak terhadap kualitas data media.

• Parameter repeatCount dalam fungsi sendMediaExtensionMsg menentukan redundansi pesan. Jika repeatCount lebih besar dari 1, pesan dikirim beberapa kali untuk mencegah kehilangan pesan akibat loss paket jaringan. Pengguna lain dalam saluran akan menerima pesan yang sama beberapa kali dan harus menghapus duplikatnya.

• Sistem berupaya mencegah kehilangan pesan akibat loss paket jaringan, yang dapat menyebabkan pengguna lain dalam saluran menerima pesan duplikat. Anda harus menghapus duplikat tersebut.

• Subscriber saluran juga menerima pesan kustom selama live streaming bypass.

• Hanya satu MediaExtensionMsg yang dikirimkan dalam satu waktu. Setiap pemanggilan baru ke sendMediaExtensionMsg akan menimpa data dari pemanggilan sebelumnya.

Callback terkait

Ketika publisher mengirim pesan ekstensi media, subscriber dapat memperoleh pesan tersebut dengan mendengarkan callback onMediaExtensionMsgReceived.

Parameter

Nilai Kembali

• 0: Pemanggilan berhasil.

• <0: Pemanggilan gagal. Kode kesalahan dikembalikan.

  • ERR_INNER(-1): Terjadi kesalahan internal SDK. Hal ini dapat terjadi jika metode dipanggil sebelum SDK diinisialisasi atau setelah SDK dihapus.

Mengirim pesan ekstensi media.

public abstract int sendMediaExtensionMsgEx(byte[]message, int repeatCount, int delay, boolean isKeyFrame, int payloadType);

SDK memungkinkan Anda mengirim dan menerima pesan ekstensi media. Metode ini mengirimkan pesan ekstensi media menggunakan protokol ekstensi Supplemental Enhancement Information (SEI). Penerima dapat memperoleh pesan tersebut dengan mendengarkan callback onMediaExtensionMsgReceived. Jika Anda mengatur payloadType ke 5, metode ini bekerja sama seperti metode sendMediaExtensionMsg.

Skenario umum meliputi hal-hal berikut:

• Kirimkan timestamp dalam pesan ekstensi media untuk menghitung latensi jaringan end-to-end atau menyinkronkan data dengan layanan lain.

• Kirimkan informasi deskriptif dalam pesan ekstensi media. Anda dapat mengirimkan hingga 4 KB data, yang berguna untuk transfer data kecil. Anda dapat menggunakan JSON atau string biasa sebagai format data.

Kapan harus memanggil

Anda dapat memanggil metode ini setelah pengambilan aliran dimulai.

Batasan

Pesan ekstensi media menggunakan kembali saluran data audio dan video. Oleh karena itu, Anda harus mengontrol frekuensi pengiriman dan panjang pesan kustom. Perhatikan batasan berikut:

• Anda dapat mengirimkan jumlah maksimum pesan per detik yang sama dengan frame per detik (fps) yang ditetapkan dalam profil. Hal ini karena pesan SEI dikirim dalam aliran H.264 atau H.265 dan hanya dapat disisipkan selama pengkodean frame video.

• Untuk menghindari dampak pada kualitas data media, Anda harus membatasi isi pesan kustom hingga 4 KB. Hal ini berguna untuk mengirimkan jumlah informasi yang kecil.

• Parameter repeatCount menentukan redundansi pesan. Jika Anda mengaturnya ke nilai lebih besar dari 1, pesan akan dikirim beberapa kali. Hal ini mencegah kehilangan pesan akibat loss paket jaringan. Subscriber lain di saluran akan menerima pesan yang sama beberapa kali dan harus menghapus duplikatnya.

• Untuk mencegah kehilangan pesan akibat loss paket jaringan, pesan mungkin dikirimkan beberapa kali. Hal ini dapat menyebabkan pengguna lain di saluran menerima pesan duplikat, yang harus Anda hapus duplikatnya.

• Subscriber di saluran juga menerima pesan kustom yang dikirim selama live stream bypass.

• Hanya satu MediaExtensionMsg yang ditransmisikan dalam satu waktu. Setiap pemanggilan baru ke sendMediaExtensionMsg akan menimpa data dari pemanggilan sebelumnya.

Parameter

Mengembalikan

• 0: Pemanggilan berhasil.

• <0: Panggilan gagal. Kode kesalahan dikembalikan.

  • ERR_INNER(-1): Terjadi kesalahan internal SDK. Hal ini dapat terjadi jika SDK belum diinisialisasi atau jika metode dipanggil setelah SDK dihapus.

Callback untuk perubahan status koneksi jaringan. Anda harus menangani callback ini.

public void onConnectionStatusChange(AliRtcEngine.AliRtcConnectionStatus status,
 AliRtcEngine.AliRtcConnectionStatusChangeReason reason);

Parameter

Pemicu balikan ini diaktifkan ketika terjadi pengecualian pada perangkat lokal. Anda harus menangani pemicu balikan ini.

public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType deviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType exceptionType, String msg)

Parameter

Callback ini memberi tahu Anda bahwa informasi autentikasi Anda akan segera kedaluwarsa. Autentikasi akan kedaluwarsa 30 detik setelah Anda menerima callback ini. Anda harus menangani callback ini.

public void onAuthInfoWillExpire();

Callback ini menunjukkan bahwa informasi autentikasi Anda akan kedaluwarsa dalam 30 detik. Anda harus memperoleh token baru dan memperbarui informasi autentikasi dengan salah satu cara berikut:

• Panggil <a baseurl="t2309760_v6_4_1.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#975b9af9ecq1a" id="8099ac5a509hn">refreshAuthInfo</a> untuk memperbarui informasi autentikasi.

• Panggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="fe88be037dy4g">leaveChannel</a> untuk meninggalkan saluran saat ini, lalu panggil joinChannel untuk bergabung kembali ke saluran.

Kapan dipicu

SDK memicu callback ini 30 detik sebelum informasi autentikasi Anda kedaluwarsa. Anda harus segera memperbarui informasi autentikasi setelah menerima callback ini.

Menunjukkan bahwa informasi autentikasi telah kedaluwarsa.

public void onAuthInfoExpired();

Callback ini menunjukkan bahwa informasi autentikasi telah kedaluwarsa. Untuk tetap berada di saluran, Anda harus menghasilkan token baru di server dan memperbarui informasi autentikasi sebagai berikut:

• Panggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="c3b0cf2f19dgm">leaveChannel</a> untuk meninggalkan saluran saat ini, lalu panggil joinChannel untuk bergabung kembali ke saluran.

Ketika dipicu

Callback ini dipicu saat informasi autentikasi kedaluwarsa.

Callback untuk hasil bergabung ke saluran.

public void onJoinChannelResult(int result, String channel, String userId, int elapsed);

Parameter

Callback untuk hasil meninggalkan saluran.

public void onLeaveChannelResult(int result, AliRtcEngine.AliRtcStats stats);

Kondisi pemicu

Saat aplikasi berhasil memanggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="7f3d2133c81tx">leaveChannel</a> untuk meninggalkan saluran, callback ini dipicu dan mengembalikan hasil dari proses meninggalkan saluran serta informasi statistik mengenai sesi saluran tersebut.

Parameter

Panggilan balik ketika pengguna jarak jauh offline.

public void onRemoteUserOffLineNotify(String uid, AliRtcUserOfflineReason reason);

Panggilan balik ini dipicu ketika pengguna jarak jauh offline. Panggilan balik ini memberi tahu pengguna lokal bahwa pengguna jarak jauh telah meninggalkan saluran karena alasan apa pun.

Pemicu

• Pengguna remote secara aktif meninggalkan saluran.

• Ketika seorang streamer jarak jauh memanggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#84f350f904s98" id="4c0adbe948tif">setClientRole</a> untuk beralih ke peran penonton (dengan memanggil AliRtcEngine#setClientRole dan mengatur peran menjadi AliRTCSdkLive), sebuah panggilan balik dipicu.

• SDK tidak menerima data dari streamer jarak jauh dalam periode yang lama dan menganggap streamer tersebut offline.

Parameter

Callback yang dipanggil ketika pengguna jarak jauh online.

public void onRemoteUserOnLineNotify(String uid, int elapsed);

Callback ini memberi tahu klien lokal ketika pengguna jarak jauh bergabung ke dalam saluran.

Pemicu

• Pengguna jarak jauh bergabung ke saluran.

• Setelah Anda bergabung ke saluran, Anda menerima callback ini untuk semua pengguna yang sudah berada di saluran tersebut.

Parameter

Panggilan balik ini dipicu ketika status aliran audio atau video pengguna jarak jauh berubah.

public void onRemoteTrackAvailableNotify(String uid, AliRtcAudioTrack audioTrack,
 AliRtcVideoTrack videoTrack);

Panggilan balik ini dipicu ketika status pengambilan aliran pengguna jarak jauh berubah. Anda dapat menggunakan panggilan balik ini untuk mengetahui secara real time apakah pengguna jarak jauh sedang mempublikasikan aliran audio dan video, serta menampilkan atau menyembunyikan informasi audio dan video pengguna jarak jauh tersebut di antarmuka sesuai kebutuhan.

Kondisi Pemicu

Callback ini dipicu dalam skenario berikut:

• Pengguna jarak jauh mulai melakukan pengambilan aliran, termasuk audio dan video.

• Pengguna jarak jauh menghentikan pengambilan aliran, termasuk audio dan video.

• Dalam mode aliran interaktif, pengguna jarak jauh memanggil setClientRole untuk mengganti perannya dari penonton menjadi Streamer dan mengaktifkan pengambilan aliran. Tindakan ini memicu panggilan balik.

Sebagai contoh untuk video, jika pengguna jarak jauh diatur untuk tidak melakukan pengambilan aliran, panggilan balik ini tidak dipicu:

• Jika pengguna jarak jauh mulai mempublikasikan aliran kamera (status pengambilan aliran: tidak ada aliran video -> hanya aliran kamera), klien lokal menerima panggilan balik AliRtcVideoTrackCamera. Hal ini menunjukkan bahwa aliran kamera pengguna jarak jauh aktif.

• Jika pengguna jarak jauh juga mempublikasikan aliran berbagi layar (status pengambilan aliran: hanya aliran kamera -> aliran kamera dan aliran berbagi layar), klien lokal menerima panggilan balik AliRtcVideoTrackBoth. Hal ini menunjukkan bahwa aliran kamera dan aliran berbagi layar dari pengguna jarak jauh keduanya aktif.

• Jika pengguna jarak jauh menghentikan publikasi aliran kamera dan hanya mempertahankan aliran berbagi layar (status pengambilan aliran: aliran kamera dan aliran berbagi layar -> hanya aliran berbagi layar), klien lokal menerima panggilan balik AliRtcVideoTrackScreen. Hal ini menunjukkan bahwa hanya aliran berbagi layar yang saat ini aktif.

• Jika pengguna jarak jauh kemudian menghentikan publikasi aliran berbagi layar (status pengambilan aliran: hanya aliran berbagi layar -> tidak ada aliran video), klien lokal menerima panggilan balik AliRtcVideoTrackNo. Hal ini menunjukkan bahwa tidak ada aliran video yang saat ini aktif.

Deskripsi parameter

Callback yang dipicu ketika Anda dihapus dari saluran oleh server atau ketika saluran ditutup.

public void onBye(int code);

Ketika pengguna terputus karena alasan apa pun atau sesi saluran berakhir, callback ini akan dipicu. Anda dapat menggunakan parameter callback code untuk menentukan alasan pemutusan koneksi dan menanganinya secara sesuai.

Pemicu

• Anda dihapus dari saluran oleh server.

• Saluran berakhir karena server menutup saluran tersebut.

• Anda terputus secara tidak disengaja. Klien harus mencoba melanjutkan sesi atau menyambung ulang.

Parameter

Callback untuk perubahan status penerbitan aliran audio.

public void onAudioPublishStateChanged(AliRtcEngine.AliRtcPublishState oldState , 
 AliRtcEngine.AliRtcPublishState newState,
 int elapseSinceLastState, String channel);

Callback ini dipicu ketika status penerbitan aliran audio pengguna lokal berubah.

Pemicu

Ketika status pengambilan aliran audio untuk pengguna berubah, misalnya:

• Penerbitan aliran berhenti.

• Anda memanggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#84f350f904s98" id="e6c8edfc45xbw">setClientRole</a> untuk beralih ke penonton.

Parameter