ApsaraVideo Live:Antarmuka AliRtcEngine

Bergabung ke saluran untuk konferensi multipihak.

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

Metode ini bergabung ke saluran. ARTC mengelompokkan pengguna ke dalam saluran. Pengguna harus bergabung ke saluran untuk mempublikasikan atau berlangganan aliran audio dan video. Metode ini, joinChannel[1/3], dan joinChannel[3/3] semuanya bergabung ke saluran. Mereka berbeda dalam metode autentikasi dan informasi pengguna yang diteruskan:

• joinChannel[1/3] adalah antarmuka parameter tunggal untuk bergabung ke saluran. Untuk bergabung ke saluran, teruskan token yang dihasilkan menggunakan Autentikasi Token. Antarmuka ini direkomendasikan untuk bergabung ke saluran dalam skenario RTC.

• Antarmuka ini adalah antarmuka bergabung saluran multi-parameter. Anda perlu memberikan token bergabung saluran multi-parameter yang dihasilkan oleh Autentikasi Token, dan informasi pengguna yang digunakan untuk menghasilkan token untuk bergabung ke saluran.

• joinChannel[3/3] ditujukan untuk skenario interaksi real-time AI. Teruskan token parameter tunggal dan atur atribut pengguna capabilityProfile.

Batasan

• Setelah berhasil bergabung ke saluran, untuk bergabung ke saluran lain selama sesi, 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> untuk meninggalkan saluran saat ini dan memastikan bahwa Anda menerima 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. Baru setelah itu Anda dapat bergabung ke saluran lagi.

• Metode ini hanya mendukung bergabung ke satu saluran sekaligus.

• Aplikasi yang menggunakan App ID berbeda tidak dapat berinteroperasi.

Callback terkait

Setelah memanggil metode ini berhasil, callback berikut dipicu:

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

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

Parameter

Deskripsi Nilai Kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Bergabung ke saluran untuk skenario interaksi real-time AI.

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

Metode ini bergabung ke saluran. ARTC mengelompokkan pengguna ke dalam saluran. Pengguna harus bergabung ke saluran untuk mempublikasikan atau berlangganan aliran audio dan video. Metode ini, joinChannel[1/3], dan joinChannel[2/3] semuanya bergabung ke saluran. Mereka berbeda dalam metode autentikasi dan informasi pengguna yang diteruskan:

• joinChannel[1/3] adalah antarmuka bergabung saluran parameter tunggal untuk skenario RTC. Anda dapat bergabung ke saluran dengan meneruskan token yang dihasilkan melalui Autentikasi Token. Kami merekomendasikan menggunakan antarmuka ini untuk bergabung ke saluran dalam skenario RTC.

• joinChannel[2/3] adalah antarmuka untuk bergabung multipartisipan. Anda perlu meneruskan Token yang dihasilkan melalui Autentikasi Token untuk bergabung multipartisipan, dan juga meneruskan informasi pengguna yang digunakan untuk menghasilkan Token untuk bergabung.

• Metode ini ditujukan untuk skenario interaksi real-time AI. Teruskan token parameter tunggal dan atur atribut pengguna capabilityProfile. Atur ke AliCapabilityProfileAiHuman saat berkomunikasi dengan agen AI.

Batasan

• Setelah berhasil bergabung ke saluran, untuk bergabung ke saluran lain saat berada di saluran, 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 dan memastikan bahwa Anda 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. Baru setelah itu Anda dapat bergabung ke saluran lagi.

• Metode ini hanya mendukung bergabung ke satu saluran sekaligus.

• Aplikasi yang menggunakan App ID berbeda tidak dapat berinteroperasi.

• Anda tidak perlu memanggil metode lagi untuk mencoba ulang bergabung ke saluran yang gagal.

Callback terkait

Setelah memanggil metode ini berhasil, callback berikut dipicu:

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

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

Parameter

Deskripsi Nilai Kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Meninggalkan saluran. Setelah memanggil metode ini, SDK mengakhiri komunikasi real-time dan meninggalkan saluran saat ini.

public abstract int leaveChannel();

Kapan harus memanggil

• Panggil metode ini ketika Anda perlu meninggalkan saluran setelah bergabung.

• Jika Anda telah bergabung ke saluran dan perlu bergabung ke saluran lain, panggil metode ini terlebih dahulu.

Callback terkait

• Sisi 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 memberi tahu Anda tentang hasil meninggalkan saluran.

• Sisi jarak jauh: Setelah Anda berhasil memanggil operasi ini, pengguna jarak jauh memicu callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#75c700a2376c1" id="69bf5ff199oda">onRemoteUserOffLineNotify</a>.

Deskripsi Nilai Kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Memeriksa apakah Anda berada di saluran.

public abstract boolean isInCall();

Deskripsi Nilai Kembali

Nilai true menunjukkan bahwa Anda berada di saluran. Nilai false menunjukkan bahwa Anda tidak berada di saluran.

Menentukan peran pengguna.

public abstract int setClientRole(AliRTCSdkClientRole clientRole);

Metode ini menetapkan peran pengguna sebagai streamer atau viewer.

Dalam mode interaktif, sebelum bergabung ke saluran:

• Tetapkan peran pengguna sebagai streamer: SDK secara otomatis mengingest aliran audio dan video lokal serta menarik aliran audio dan video dari streamer lainnya.

• Tetapkan peran pengguna sebagai viewer: SDK tidak mengingest aliran audio dan video lokal tetapi menarik aliran audio dan video dari streamer lainnya.

Kapan Harus Menghubungi

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

Batasan

Metode ini hanya berfungsi dalam mode interaktif—yaitu, ketika setChannelProfile diatur ke AliRTCSdkInteractiveLive.

Kami menyarankan secara eksplisit menetapkan peran pengguna sebelum bergabung ke saluran dalam mode interaktif.

Parameter

Memeriksa peran pengguna.

public abstract AliRTCSdkClientRole getCurrentClientRole();

Deskripsi Nilai Kembali

Mengembalikan peran pengguna saat ini.

Memperbarui informasi autentikasi.

public abstract int refreshAuthInfo(AliRtcAuthInfo authInfo);

Metode ini memperbarui informasi autentikasi. Token kedaluwarsa setelah periode tertentu, sehingga mencegah SDK terhubung ke server.

Kapan dipanggil

Dalam situasi berikut:

• Ketika 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 melaporkan bahwa informasi autentikasi akan segera kedaluwarsa, kami menyarankan Anda membuat ulang token di sisi server dan kemudian memanggil metode ini untuk meneruskan token baru.

• 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> dipicu untuk memberi tahu Anda bahwa autentikasi telah kedaluwarsa. Pada titik ini, Anda perlu membuat ulang Token dan kemudian memanggil joinChannel untuk bergabung kembali ke saluran.

Parameter

Deskripsi Nilai Kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Memperbarui informasi autentikasi.

public abstract int refreshAuthInfo(String token);

Metode ini memperbarui token. Token kedaluwarsa setelah periode tertentu, sehingga mencegah SDK terhubung ke server.

Kapan Harus Menghubungi

Kami menyarankan membuat ulang token di server Anda dan memanggil metode ini dengan token baru dalam kasus berikut:

• Ketika callback <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e9acb46a25uym" id="d708af68eevs9">onAuthInfoWillExpire</a> melaporkan 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 bahwa autentikasi telah kedaluwarsa. Pada titik ini, Anda perlu memanggil joinChannel untuk bergabung kembali ke saluran.

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Anda dapat menghentikan atau melanjutkan publikasi aliran video lokal.

public abstract int publishLocalAudioStream(boolean enable);

Metode ini mengontrol apakah akan mempublikasikan aliran audio yang ditangkap secara lokal. Secara default, SDK mempublikasikan aliran audio. Untuk menonaktifkan publikasi aliran audio, panggil publishLocalAudioStream(false) sebelum bergabung ke saluran.

Kapan Harus Menelepon

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran. Memanggilnya sebelum bergabung memodifikasi konfigurasi default dan berlaku saat bergabung.

Callback terkait

Ketika hasil ingest 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 memberi tahu Anda bahwa status ingest aliran audio lokal telah berubah, dan 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 memberi tahu Anda bahwa aliran audio dan video pengguna jarak jauh telah berubah.

Parameter

Deskripsi Nilai Kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Memeriksa apakah aliran audio dipublikasikan.

public abstract boolean isLocalAudioStreamPublished();

Instruksi Pengembalian

Nilai true menunjukkan bahwa aliran audio dipublikasikan. Nilai false menunjukkan bahwa aliran audio tidak dipublikasikan.

Menentukan apakah akan berlangganan ke aliran audio pengguna jarak jauh secara default.

public abstract int setDefaultSubscribeAllRemoteAudioStreams(boolean sub);

Metode ini mengonfigurasi apakah sistem berlangganan ke aliran audio pengguna jarak jauh secara default. Pengaturan ini memengaruhi perilaku langganan aliran audio pengguna baru yang bergabung ke saluran. Kecuali Anda memiliki persyaratan khusus, kami merekomendasikan menyetel ini ke true.

Kapan Harus Menghubungi

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

• Sebelum bergabung:

  • Secara default, SDK berlangganan ke aliran audio pengguna jarak jauh saat bergabung ke saluran. Untuk mengubah perilaku ini, panggil metode ini sebelum bergabung.

• Setelah bergabung:

  • Untuk menghentikan langganan default, panggil setDefaultSubscribeAllRemoteAudioStreams(false). Kemudian, aliran audio pengguna yang baru bergabung tidak akan dilanggan.

  • Setelah Anda menghentikan langganan default, Anda dapat memanggil API subscribeRemoteAudioStream untuk melanjutkan langganan ke aliran audio pengguna tertentu, dan memanggilnya beberapa kali untuk melanjutkan langganan untuk beberapa pengguna.

  • Setelah menghentikan langganan default, memanggil setDefaultSubscribeAllRemoteAudioStreams(true) hanya melanjutkan langganan untuk pengguna yang bergabung setelah pemanggilan tersebut. Langganan tidak dilanjutkan untuk pengguna jarak jauh yang telah bergabung selama periode dihentikan.

Parameter

Deskripsi pengembalian

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan atau melanjutkan penarikan aliran audio pengguna jarak jauh tertentu.

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

Metode ini menghentikan atau melanjutkan langganan ke aliran audio pengguna jarak jauh tertentu. Kecuali Anda memiliki persyaratan khusus, kami merekomendasikan menyetel ini ke true.

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menentukan apakah akan menerima aliran audio semua pengguna jarak jauh.

public abstract int subscribeAllRemoteAudioStreams(boolean sub);

Metode ini adalah sakelar utama untuk berlangganan aliran audio jarak jauh. Kami merekomendasikan menyetelnya ke true. Jika diatur ke false, hal ini menyebabkan:

• Semua aliran audio jarak jauh dalam sesi saat ini berhenti dilanggan.

• Pengguna baru yang bergabung kemudian juga tidak 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 melanjutkan langganan, panggil metode ini lagi dan atur ke true.

Parameter

Deskripsi Pengembalian

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menentukan apakah akan mempublikasikan aliran kamera.

public abstract int publishLocalVideoStream(boolean enable);

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

Kapan Harus Menelepon

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

Memanggilnya sebelum bergabung memodifikasi konfigurasi default dan berlaku saat bergabung.

Callback terkait

Ketika status pengambilan aliran audio lokal berubah, sisi 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 memberi tahu status terbaru pengambilan aliran audio tersebut, sedangkan sisi 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> untuk memberi tahu bahwa aliran audio dan video pengguna jarak jauh telah berubah.

Parameter

Deskripsi Nilai Kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Memeriksa apakah aliran kamera dipublikasikan.

public abstract boolean isLocalVideoStreamPublished();

Deskripsi Kembalian

Nilai true menunjukkan bahwa aliran kamera dipublikasikan. Nilai false menunjukkan bahwa aliran kamera tidak dipublikasikan.

Menentukan apakah akan berlangganan ke aliran video pengguna jarak jauh secara default.

public abstract int setDefaultSubscribeAllRemoteVideoStreams(boolean sub);

Metode ini menentukan apakah akan berlangganan ke aliran video pengguna jarak jauh secara default. SDK secara default berlangganan.

Kapan harus memanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran. Jika Anda memanggil setDefaultSubscribeAllRemoteVideoStreams(false) setelah bergabung, Anda tidak akan menerima aliran video dari pengguna yang bergabung setelahnya.

Setelah Anda berhenti menerima aliran video, panggil subscribeRemoteVideoStream dan tentukan ID pengguna jarak jauh untuk melanjutkan menerima aliran video mereka. Untuk melanjutkan menerima aliran video dari beberapa pengguna, Anda perlu memanggil subscribeRemoteVideoStream beberapa kali. setDefaultSubscribeAllRemoteVideoStreams(true) hanya melanjutkan menerima aliran video dari pengguna yang bergabung ke saluran kemudian.

Metode ini menentukan apakah akan berlangganan ke aliran video pengguna jarak jauh secara default.

Parameter

Deskripsi Nilai Kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan atau melanjutkan langganan ke aliran video jarak jauh tertentu.

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

Berlangganan atau berhenti berlangganan ke aliran video pengguna tertentu.

Kapan Harus Menghubungi

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

Parameter

Deskripsi nilai kembali

• 0: metode dieksekusi dengan sukses.

• Bukan nol: metode gagal.

Menghentikan atau melanjutkan penerimaan semua aliran video jarak jauh.

public abstract int subscribeAllRemoteVideoStreams(boolean sub);

Metode ini adalah sakelar utama untuk berlangganan aliran video jarak jauh. Jika diatur ke false, hal ini menyebabkan:

• Semua aliran video jarak jauh dalam sesi saat ini berhenti dilanggan.

• Pengguna baru yang bergabung kemudian tidak akan berlangganan (meskipun Anda telah mengatur <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#c90127d90d22o" id="8661e30c89dum">setDefaultSubscribeAllRemoteVideoStreams</a>(true) untuk mengaktifkan langganan bawaan).

• 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 melanjutkan langganan, panggil metode ini lagi dan atur ke true.

Parameter

Deskripsi Kembalian

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan atau melanjutkan aliran media pengguna jarak jauh tertentu.

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

Metode ini menggabungkan langganan ke 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 ke aliran audio dan video jarak jauh. Parameter videoTrack mengontrol aliran video mana yang akan ditarik.

Parameter

Deskripsi nilai kembali

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

Menghentikan atau melanjutkan langganan ke aliran audio dan video pengguna jarak jauh dalam satu panggilan.

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

Antarmuka ini menggabungkan aliran audio dan video jarak jauh yang dilanggan.

Metode terkait

Tidak seperti subscribeRemoteMediaStream[1/2], metode ini menggunakan parameter videoTrack dan audioTrack untuk menentukan status langganan yang diinginkan dalam satu panggilan API. Misalnya:

• Jika Anda ingin berlangganan ke aliran kamera dan mikrofon, atur videoTrack dan audioTrack ke AliRtcVideoTrackCamera dan AliRtcAudioTrackMic saat memanggil.

• Untuk berhenti berlangganan aliran kamera tetapi tetap berlangganan aliran mikrofon, atur parameter videoTrack ke AliRtcVideoTrackNo dan parameter audioTrack ke AliRtcAudioTrackMic.

• Untuk berhenti berlangganan keduanya, Anda dapat mengatur videoTrack dan audioTrack ke AliRtcVideoTrackNo dan AliRtcAudioTrackNo, masing-masing.

• Untuk berlangganan ke aliran kamera dan berbagi layar, atur parameter videoTrack ke AliRtcVideoTrackBoth. Logika yang sama berlaku untuk aliran audio.

Parameter

Deskripsi Kembalian

• 0: Sukses.

• <0: Gagal.

Berlangganan ke aliran pengguna tertentu di saluran lain.

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

Parameter

Deskripsi Kembalian

Nilai kembali 0 menunjukkan bahwa panggilan metode berhasil, sedangkan nilai lainnya menunjukkan bahwa panggilan gagal.

Menghentikan atau melanjutkan langganan ke aliran semua pengguna di saluran lain.

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

Parameter

Deskripsi nilai kembali

• 0: Panggilan metode berhasil.

• Bukan nol: Panggilan metode gagal.

Menyesuaikan volume pemutaran aliran audio yang ditarik.

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

Anda dapat menggunakan metode ini untuk menyesuaikan volume pemutaran aliran audio pengguna tertentu di perangkat lokal.

Parameter

Deskripsi Nilai Kembali

• 0: Panggilan metode berhasil.

• Bukan nol: Panggilan metode gagal, misalnya karena nilai volume tidak valid.

Menghentikan atau melanjutkan pengiriman data audio lokal.

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

Kapan Harus Menghubungi

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

Callback terkait

Setelah panggilan berhasil, pengguna jarak jauh memicu notifikasi <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 dimute.

Parameter

Deskripsi Pengembalian

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan. Muting mengirimkan frame diam, tetapi penangkapan dan encoding audio tetap berjalan.

Menghentikan atau melanjutkan pemutaran aliran audio jarak jauh.

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

API ini mengontrol pemutaran aliran audio pengguna jarak jauh tertentu saja. API ini tidak memengaruhi penarikan atau decoding aliran audio jarak jauh. Untuk berhenti berlangganan aliran audio pengguna, panggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="66a2ef0919jjg">subscribeRemoteAudioStream</a>.

Kapan Harus Menghubungi

Anda dapat mengatur ini sebelum atau setelah bergabung ke saluran.

Parameter

Deskripsi Nilai Kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan atau melanjutkan pemutaran semua aliran audio jarak jauh.

public abstract int muteAllRemoteAudioPlaying(boolean mute);

Metode ini menghentikan atau melanjutkan semua aliran audio jarak jauh.

Kapan dipanggil

Anda dapat mengatur ini sebelum atau setelah Anda bergabung ke saluran.

Parameter

Deskripsi Pengembalian

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Memulai penangkapan audio.

public abstract int startAudioCapture();

Metode ini memulai penangkapan audio. Anda dapat memanggil metode ini sebelum bergabung ke saluran untuk mengaktifkan penangkapan audio lebih awal. Jika metode ini tidak dipanggil, SDK secara otomatis mengontrol perangkat penangkapan audio. Anda juga dapat memanggil metode ini untuk mengaktifkan kembali penangkapan audio setelah memanggil stopAudioCapture.

Kapan harus memanggil

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

Metode terkait

API <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 penangkapan audio tetap diaktifkan setelah Anda meninggalkan rapat.

Callback terkait

Setelah Anda memanggil metode ini, callback onLocalAudioStateChanged memberi tahu Anda tentang perubahan status penangkapan audio lokal.

Deskripsi Nilai Kembali

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

Memulai penangkapan audio.

public abstract int startAudioCapture(boolean keepAlive);

Menonaktifkan penangkapan mikrofon setelah muting.

Metode ini memulai penangkapan audio. Anda dapat memanggilnya sebelum bergabung ke saluran untuk mengaktifkan penangkapan audio lebih awal. Jika Anda tidak mengatur metode ini, SDK secara otomatis mengontrol perangkat penangkapan audio.

Kapan Harus Menelepon

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

Metode terkait

Dibandingkan dengan startAudioCapture[1/2], metode ini memungkinkan Anda mengontrol apakah perangkat penangkapan tetap aktif setelah meninggalkan saluran menggunakan parameter keepAlive.

Callback terkait

Setelah memanggil metode ini untuk mengubah status penangkapan audio lokal, Anda dapat mengambil perubahan status melalui callback onLocalAudioStateChanged.

Parameter

Deskripsi Nilai Kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan penangkapan audio.

public abstract int stopAudioCapture();

SDK secara default mengaktifkan penangkapan audio. Saat Anda memulai pratinjau atau bergabung ke saluran, penangkapan audio dimulai secara otomatis. Panggil metode ini untuk menghentikan penangkapan perangkat audio.

Callback terkait

Setelah Anda memanggil metode ini, SDK memicu callback onLocalAudioStateChanged untuk melaporkan perubahan status penangkapan audio lokal.

Deskripsi Kembalian

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

Menetapkan apakah perangkat output audio default adalah speakerphone.

public abstract int setDefaultAudioRoutetoSpeakerphone(boolean defaultToSpeakerphone);

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

SDK mendefinisikan prioritas routing audio yang secara otomatis beralih berdasarkan status koneksi peripheral saat ini, sebagai berikut: wired headset > Bluetooth headset > user settings > default settings. Oleh karena itu, jika tidak ada peripheral yang terhubung dan enableSpeakerphone tidak diatur, SDK menerapkan pengaturan default.

Untuk informasi lebih lanjut tentang pengaturan routing audio, lihat pengaturan routing audio.

Perangkat seluler biasanya mendukung dua perangkat output audio: earpiece dan speakerphone:

• Ketika audio diarahkan ke earpiece, suaranya lebih pelan dan memerlukan memegang ponsel dekat telinga, memberikan privasi yang lebih baik dan cocok untuk panggilan telepon.

• Ketika audio diarahkan ke speakerphone, suaranya lebih keras dan memungkinkan penggunaan bebas genggam tanpa memegang ponsel ke telinga.

Metode terkait

Metode ini memodifikasi konfigurasi routing audio default. Metode enableSpeakerphone menetapkan perangkat routing audio saat ini.

Kapan dipanggil

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

Parameter

Deskripsi respons

• 0: panggilan metode berhasil.

• <0: panggilan metode gagal.

Menetapkan perangkat output audio ke headset atau speaker.

public abstract int enableSpeakerphone(boolean enable);

Metode ini memilih perangkat pemutaran audio saat ini setelah bergabung ke saluran, beralih antara earpiece dan speaker. Jika Anda tidak memanggil metode ini, pemutaran menggunakan perangkat yang ditentukan oleh rute audio default.

SDK mendefinisikan urutan prioritas yang telah ditentukan untuk routing audio dan melakukan alih otomatis berdasarkan status koneksi peripheral saat ini. Urutan prioritasnya adalah sebagai berikut: wired headset > Bluetooth headset > user settings > default settings. Oleh karena itu, ketika peripheral terhubung, panggilan API ini tidak berpengaruh. Untuk informasi lebih lanjut tentang pengaturan routing audio, lihat Pengaturan Routing Audio.

Kapan Harus Menelepon

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

Metode terkait

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

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Menentukan apakah perangkat output audio saat ini adalah earpiece atau speaker.

public abstract boolean isSpeakerOn();

Deskripsi Nilai Kembali

Nilai true menunjukkan speaker. Nilai false menunjukkan earpiece.

Mengaktifkan prompt volume pengguna.

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

Metode ini mengaktifkan SDK untuk secara berkala melaporkan volume pengguna lokal dan pengguna jarak jauh dengan volume tertinggi saat ini. Untuk menggunakan fitur ini, implementasikan kelas AliRtcAudioVolumeObserver dan panggil registerAudioVolumeObserver untuk mendaftarkan observer.

Kapan Harus Menghubungi

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

Callback terkait

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

• Callback AliRtcAudioVolumeObserver#onAudioVolume melaporkan volume audio setiap pembicara. Frekuensi callback ini ditentukan oleh parameter interval.

• Deteksi aktivitas suara: Ketika pembicara aktif terdeteksi, ID pengguna (UID) mereka dilaporkan melalui callback AliRtcAudioVolumeObserver#onActiveSpeaker.

Parameter

Deskripsi Nilai Kembali

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

Mengaktifkan pemantauan in-ear.

public abstract int enableEarBack(boolean enable);

Metode ini mengaktifkan atau menonaktifkan pemantauan in-ear. Anda bisa mendapatkan hasil yang lebih baik dengan mengaktifkan pemantauan in-ear saat menggunakan headphone kabel atau Bluetooth.

Kapan Harus Menghubungi

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

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menetapkan volume pemantauan in-ear.

public abstract int setEarBackVolume(int volume) ;

Metode ini hanya berlaku setelah pemantauan in-ear diaktifkan dengan memanggil enableEarBack.

Kapan Harus Menghubungi

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

Parameter

Petunjuk Pengembalian

• 0: Panggilan metode berhasil.

• <0: Panggilan metode gagal.

Memulai perangkat pemutaran audio.

public abstract int startAudioPlayer();

Anda dapat menggunakan metode ini untuk mengaktifkan pemutaran audio lebih awal. Jika Anda tidak memanggil metode ini, SDK secara otomatis mengaktifkan pemutaran audio setelah Anda berlangganan ke aliran audio.

Deskripsi Nilai Kembali

• 0: Panggilan berhasil.

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

Menghentikan perangkat pemutaran audio.

 public abstract int stopAudioPlayer();

Antarmuka ini menghentikan pemutaran audio dan merupakan pasangan dari startAudioPlayer.

Informasi Pengembalian

• 0: Panggilan berhasil.

• Bukan nol: Panggilan gagal. Kode kesalahan dikembalikan.

Anda dapat mengatur volume pemutaran lokal.

public abstract int setPlayoutVolume(int volume);

Parameter

Deskripsi respons

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal.

Anda dapat mengatur volume perekaman.

public abstract int setRecordingVolume(int volume);

Parameter

Deskripsi Kembalian

• 0: panggilan metode berhasil.

• Kode nilai kembali bukan nol menunjukkan bahwa panggilan gagal.

Anda dapat memutar file audio.

public abstract int playAudioFileTest(String filePath) ;

Anda dapat menggunakan metode ini untuk memutar file audio sebelum bergabung ke saluran guna menguji pemutaran audio.

Kapan Harus Menghubungi

Anda hanya dapat memanggil metode ini sebelum bergabung ke saluran.

Batasan Panggilan

Panggilan ganda akan menimpa panggilan sebelumnya. Memanggil metode ini akan menghentikan file yang sedang diputar.

Parameter

Deskripsi nilai kembali

• 0: panggilan metode berhasil.

• Nilai bukan nol menunjukkan bahwa panggilan gagal.

Hentikan pemutaran file audio.

public abstract int stopAudioFileTest();

Antarmuka ini sesuai dengan antarmuka playAudioFileTest dan menghentikan pemutaran file audio.

Batasan

Anda hanya dapat memanggil metode ini sebelum Anda bergabung ke saluran.

Deskripsi Pengembalian

• 0: panggilan berhasil.

• Bukan nol: panggilan gagal.

Memulai pengujian perangkat penangkapan audio sebelum panggilan.

public abstract int startAudioCaptureTest();

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

Kapan dipanggil

Anda harus memanggil metode ini sebelum bergabung ke saluran. Setelah pengujian selesai, panggil stopAudioCaptureTest untuk menghentikan pengujian dan melepaskan perangkat audio.

Deskripsi Kembalian

• 0: Panggilan berhasil.

• Bukan nol: Panggilan gagal. Kode kesalahan dikembalikan.

Menonaktifkan deteksi penangkapan audio.

public abstract int stopAudioCaptureTest();

Metode ini menghentikan pengujian perangkat penangkapan audio. Setelah Anda memanggil startAudioCaptureTest, Anda harus memanggil metode ini untuk menghentikan pengujian.

Kapan Harus Menghubungi

Anda dapat memanggil metode ini sebelum bergabung ke saluran.

Deskripsi Pengembalian

• 0: Panggilan berhasil.

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

Menetapkan mode pengubah suara.

public abstract int setAudioEffectVoiceChangerMode(AliRtcAudioEffectVoiceChangerMode mode);

Parameter

Deskripsi Pengembalian

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Anda dapat mengatur parameter penyesuaian pitch.

public abstract int setAudioEffectPitchValue(double value);

Parameter

Deskripsi nilai kembali

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

Menetapkan mode reverb.

public abstract int setAudioEffectReverbMode(AliRtcAudioEffectReverbMode mode);

Parameter

Deskripsi Pengembalian

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

Anda dapat mengatur jenis dan parameter untuk efek suara reverb.

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

Parameter

Deskripsi Pengembalian

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Menetapkan mode beautifikasi suara yang telah ditentukan sebelumnya.

public abstract int setAudioEffectBeautifyMode(AliRtcAudioEffectBeautifyMode mode);

Metode ini menetapkan mode beautifikasi suara yang telah ditentukan sebelumnya oleh SDK. Metode ini cocok untuk skenario yang memerlukan peningkatan kualitas vokal, seperti siaran langsung suara, karaoke, dan jejaring sosial suara. Dengan memilih mode beautifikasi suara, Anda dapat mengubah suara manusia, seperti membuatnya lebih resonan atau meningkatkan kejelasannya. Hal ini meningkatkan pengalaman mendengarkan bagi pengguna jarak jauh.

Kapan dipanggil

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

Parameter

Nilai kembali

• 0: Operasi berhasil.

• Nilai bukan nol: Operasi gagal.

Menetapkan parameter equalizer audio (EQ) untuk menyesuaikan gain pada pita frekuensi tertentu.

public abstract int setAudioEffectEqualizationParam(AliRtcAudioEffectEqualizationBandFrequency bandIndex, float gain);

Metode ini menyesuaikan equalizer grafis untuk sinyal suara dan audio yang ditangkap secara lokal. Dengan menyesuaikan gain (dalam dB) pada pita frekuensi tertentu, Anda dapat menyesuaikan suara untuk tujuan seperti mengoptimalkan kejelasan suara, menonjolkan vokal, dan meningkatkan pengurangan noise.

Equalizer mendukung spektrum audio penuh dari 31 Hz hingga 16 kHz di 10 pita standar. Gain untuk setiap pita dapat diatur secara independen ke nilai dari -15 dB hingga 15 dB. Nilai default adalah 0 dB, yang menunjukkan tidak ada peningkatan atau pelemahan.

Batasan

• Anda harus mengaktifkan mode beautifikasi suara dengan memanggil setAudioEffectBeautifyMode sebelum memanggil metode ini.

Parameter

Deskripsi Kembalian

0: Panggilan metode berhasil.

Nilai bukan nol: Panggilan metode gagal.

Anda dapat menambahkan aliran audio eksternal.

public abstract int addExternalAudioStream(AliRtcExternalAudioStreamConfig config);

Metode ini menambahkan aliran audio eksternal. Ikuti langkah-langkah berikut:

1. Anda dapat memanggil API <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-nya.

2. Anda dapat memanggil <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 eksternal.

3. Saat mengakhiri panggilan, Anda harus memanggil <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.

Jika Anda ingin mempublikasikan penangkapan audio kustom di saluran, lihat Penangkapan Audio Kustom.

Kapan dipanggil

Deskripsi Pengembalian

Nilai kembali lebih besar dari 0 menunjukkan panggilan metode berhasil dan mewakili ID aliran audio eksternal. Nilai lainnya menunjukkan bahwa panggilan metode gagal.

Anda dapat memasukkan data aliran audio eksternal.

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

Gunakan antarmuka ini untuk mengirim data ke aliran audio tertentu. 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="8822f2932e9ep">addExternalAudioStream</a> untuk menambahkan aliran audio eksternal dan mendapatkan ID aliran audio eksternal.

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 mendorong data audio ke aliran audio yang dibuat.

3. Setelah panggilan berakhir, panggil <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.

Untuk informasi lebih lanjut tentang mempublikasikan audio dari sumber kustom di saluran, lihat Penangkapan Audio Kustom.

Kapan Harus Menelepon

Panggil metode ini setelah bergabung ke saluran.

Parameter

Deskripsi Kembalian

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

Menetapkan volume publikasi aliran audio eksternal.

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

Parameter

Deskripsi nilai kembali

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

Mengambil volume ingest aliran audio eksternal

public abstract int getExternalAudioStreamPublishVolume(int streamId);

Parameter

Deskripsi Nilai Kembali

Volume ingest aliran: Nilai yang valid adalah 0 hingga 100. Nilai kurang dari 0 menunjukkan kegagalan.

Menetapkan volume pemutaran aliran audio eksternal.

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

Parameter

Deskripsi nilai kembali

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

Mengambil volume pemutaran aliran audio eksternal

public abstract int getExternalAudioStreamPlayoutVolume(int streamId);

Parameter

Deskripsi respons

Volume pemutaran memiliki nilai yang valid berkisar dari 0 hingga 100. Nilai kurang dari 0 menunjukkan kegagalan.

Menghapus aliran audio eksternal.

public abstract int removeExternalAudioStream(int streamId);

Metode ini menghapus aliran audio eksternal yang sesuai dengan ID aliran tertentu. Metode ini merupakan pasangan dari metode addExternalAudioStream.

Kapan Harus Menghubungi

Untuk menggunakan fitur input audio kustom, Anda harus terlebih dahulu memanggil metode addExternalAudioStream untuk menambahkan aliran audio dan mendapatkan ID alirannya. Kemudian, panggil metode pushExternalAudioStreamRawData untuk mendorong data audio Anda ke SDK. Saat Anda ingin berhenti menggunakan input audio kustom, panggil metode ini untuk menghapus aliran audio dan melepaskan resource-nya.

Parameter

Deskripsi Pengembalian

• 0: Panggilan berhasil.

• <0: Panggilan gagal. Kode kesalahan dikembalikan.

Mengambil informasi file audio.

public abstract int getAudioFileInfo(String fileName);

Anda dapat memanggil antarmuka ini secara asinkron untuk mengambil durasi file. Ini adalah antarmuka asinkron, dan Anda dapat memperoleh informasi file audio menggunakan onAudioFileInfo.

Parameter

Pengantar Kembali

• 0: Panggilan berhasil.

• Bukan nol: Kode kesalahan dikembalikan.

Memulai pencampuran iringan audio.

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

Antarmuka ini memutar file iringan lokal atau online. Ini adalah antarmuka asinkron. Setelah Anda memanggil antarmuka ini, Anda dapat memantau status pemutaran iringan menggunakan AliRtcEngineNotify#onAudioAccompanyStateChanged.

Kapan dipanggil

Anda hanya dapat memanggil metode ini setelah bergabung ke saluran.

Batasan

Tidak seperti efek suara, hanya satu iringan yang dapat diputar sekaligus. Panggilan berulang akan menimpa pemutaran iringan sebelumnya.

Parameter

Deskripsi Kembalian

• 0: Panggilan berhasil.

• Bukan nol: Panggilan gagal dan mengembalikan kode kesalahan.

Menetapkan headset atau speaker sebagai perangkat output audio.

public abstract int stopAudioAccompany() ;

Antarmuka ini merupakan pasangan dari startAudioAccompany dan menghentikan pemutaran iringan audio.

Kapan Harus Menghubungi

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

Deskripsi respons

• 0: Panggilan berhasil.

• Bukan nol: Panggilan gagal dan mengembalikan kode kesalahan.

Menetapkan volume iringan audio untuk pemutaran lokal dan ingest aliran.

public abstract int setAudioAccompanyVolume( int volume) ;

API ini menetapkan volume iringan audio untuk pemutaran lokal dan untuk publikasi. Untuk mengatur hanya volume pemutaran lokal, gunakan setAudioAccompanyPlayoutVolume. Untuk mengatur hanya volume publikasi, gunakan setAudioAccompanyPublishVolume.

Parameter

Deskripsi respons

• 0: Panggilan berhasil.

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

Menetapkan volume iringan audio untuk ingest aliran.

public abstract int setAudioAccompanyPublishVolume(int volume) ;

Parameter

Deskripsi nilai kembali

• 0: Panggilan berhasil.

• Nilai bukan nol: Panggilan gagal. Nilai yang dikembalikan adalah kode kesalahan.

Mengambil volume ingest untuk aliran iringan.

public abstract int getAudioAccompanyPublishVolume() ;

Deskripsi respons

Volume ingest untuk aliran musik iringan.

• 0 hingga 100: berhasil.

• Nilai lainnya: kode kesalahan.

Menetapkan volume pemutaran lokal iringan.

public abstract int setAudioAccompanyPlayoutVolume(int volume) ;

Parameter

Deskripsi Kembalian

• 0: Panggilan berhasil.

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

Memeriksa volume pemutaran lokal iringan.

public abstract int getAudioAccompanyPlayoutVolume() ;

Deskripsi Nilai Kembali

Volume pemutaran lokal iringan.

• [0-100]: Berhasil.

• Nilai lainnya: Kode kesalahan.

Jeda pencampuran iringan.

public abstract int pauseAudioAccompany();

Deskripsi Pengembalian

• 0: Panggilan berhasil.

• Bukan nol: Panggilan gagal dan mengembalikan kode kesalahan.

Anda dapat memulai ulang pencampuran iringan.

public abstract int resumeAudioAccompany();

Deskripsi Pengembalian

• Nilai 0 menunjukkan bahwa panggilan berhasil.

• Nilai bukan nol menunjukkan bahwa panggilan gagal dan mengembalikan kode kesalahan.

Mengambil durasi file iringan, dalam milidetik.

public abstract int getAudioAccompanyDuration();

Metode ini mengambil durasi file iringan saat ini.

Deskripsi nilai kembali

• >= 0: durasi file iringan.

• < 0: panggilan gagal dan mengembalikan kode kesalahan.

Memperoleh progres pemutaran file iringan, dalam milidetik.

public abstract int getAudioAccompanyCurrentPosition();

Metode ini memperoleh progres pemutaran file iringan saat ini, dalam milidetik.

Deskripsi respons

• Nilai lebih besar atau sama dengan 0: Progres pemutaran file iringan.

• Nilai kurang dari 0: Panggilan gagal. Kode kesalahan dikembalikan.

Menetapkan posisi pemutaran iringan.

public abstract int setAudioAccompanyPosition(int posMs);

Metode ini menetapkan progres pemutaran iringan. Metode ini berguna untuk fitur seperti menyeret bilah progres. Setelah metode ini dipanggil dengan sukses, iringan diputar dari posisi yang ditentukan.

Parameter

Deskripsi Kembalian

• 0: Panggilan berhasil.

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

Memuat awal efek suara.

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

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Menghapus file efek suara yang telah dimuat awal.

public abstract int unloadAudioEffect(int soundId);

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Memulai pemutaran efek suara.

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

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai bukan nol menunjukkan bahwa panggilan gagal.

Menghentikan pemutaran efek suara.

public abstract int stopAudioEffect(int soundId);

Parameter

Deskripsi nilai kembali

Nilai kembali 0 menmenunjukkan bahwa panggilan berhasil. Nilai bukan nol menunjukkan bahwa panggilan gagal.

Menghentikan pemutaran semua efek suara.

public abstract int stopAllAudioEffects();

Deskripsi Kembalian

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai bukan nol menunjukkan bahwa panggilan gagal.

Menetapkan volume untuk ingest aliran efek suara.

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

Parameter

Deskripsi Kembalian

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Memeriksa volume ingest aliran efek suara.

public abstract int getAudioEffectPublishVolume(int soundId);

Parameter

Deskripsi respons

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Menetapkan volume pemutaran lokal efek suara.

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

Parameter

Deskripsi nilai kembali

Nilai kembali 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Mengambil volume pemutaran lokal untuk efek suara di perangkat Android dan iOS.

public abstract int getAudioEffectPlayoutVolume(int soundId);

Parameter

Deskripsi nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menetapkan volume pencampuran untuk semua efek suara dalam ingest aliran.

public abstract int setAllAudioEffectsPublishVolume(int volume);

Parameter

Deskripsi nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menetapkan volume pemutaran lokal untuk semua efek suara (Android dan iOS).

public abstract int setAllAudioEffectsPlayoutVolume(int volume);

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Memulai perekaman file media.

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

Parameter

Nilai kembali

Nilai kembali TRUE menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan perekaman file media.

  public abstract void stopRecord();

Parameter

Tidak ada.

Menjeda efek suara.

public abstract int pauseAudioEffect(int soundId);

Parameter

Deskripsi Nilai Kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menjeda semua efek suara.

public abstract int pauseAllAudioEffects();

Deskripsi Nilai Kembali

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Melanjutkan pemutaran efek suara.

public abstract int resumeAudioEffect(int soundId);

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Anda dapat melanjutkan memutar semua efek suara.

public abstract int resumeAllAudioEffects();

Deskripsi Pengembalian

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Membuat tampilan rendering SurfaceView.

public abstract SophonSurfaceView createRenderSurfaceView(Context context);

Anda harus memanggil metode ini untuk menampilkan tampilan video, bukan membuat SurfaceView secara langsung. Untuk menggunakan metode ini:

• Tetapkan nilai kembali ke AliRtcVideoCanvas#view.

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

Kapan dipanggil

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

Batasan

Anda harus memanggil metode ini pada thread utama.

Parameter

Anda dapat mengatur jendela rendering dan parameter gambar untuk pratinjau lokal.

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

Metode ini mengatur tampilan pratinjau lokal dengan mengikat aliran video lokal ke tampilan dan mengonfigurasi mode rendering, mode pencerminan, dan sudut rotasi tampilan pengguna lokal. Metode ini hanya memengaruhi pratinjau pengguna lokal, bukan ingest video. Untuk mengatur tampilan antarmuka pengguna jarak jauh, panggil setRemoteViewConfig.

Kapan Harus Menghubungi

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

Parameter

Petunjuk Pengembalian

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Anda dapat mengatur jendela rendering dan parameter gambar untuk video jarak jauh.

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

Metode ini mengikat tampilan untuk aliran video pengguna jarak jauh tertentu dan mengonfigurasi mode rendering, mode pencerminan, dan sudut rotasi video tersebut saat ditampilkan secara lokal. Metode ini hanya memengaruhi video yang ditampilkan kepada pengguna lokal. Untuk mengonfigurasi tampilan pratinjau lokal, panggil setLocalViewConfig.

• Jika parameter view dari AliRtcVideoCanvas kosong, rendering dihentikan.

• Untuk mengatur ulang parameter renderMode dari AliRtcVideoCanvas selama pemutaran, ubah nilai renderMode sambil menjaga parameter lainnya tetap tidak berubah.

• Untuk mengubah parameter `mirrorMode` dari AliRtcVideoCanvas selama pemutaran, ubah nilai `mirrorMode` sambil menjaga parameter lainnya tetap tidak berubah.

Kapan Harus Memanggil

Kami menyarankan Anda memanggil fungsi ini ketika menerima callback onRemoteTrackAvailableNotify. Anda dapat mengaturnya ketika video pengguna jarak jauh tersedia.

Parameter

Deskripsi Pengembalian

Nilai 0 menunjukkan bahwa panggilan berhasil, sedangkan nilai lainnya menunjukkan kegagalan.

Menetapkan preferensi penangkapan kamera, seperti arah kamera dan laju frame penangkapan.

public abstract int setCameraCapturerConfiguration(AliEngineCameraCapturerConfiguration cameraCapturerConfiguration);

Metode ini mengonfigurasi preferensi penangkapan, seperti arah kamera dan laju frame.

Kapan Harus Menelepon

Anda harus memanggil metode ini sebelum mengaktifkan kamera, misalnya, sebelum melakukan operasi berikut:

• startPreview (memulai pratinjau video)

• joinChannel (bergabung ke saluran)

Parameter

Deskripsi Nilai Kembali

Nilai kembali 0 menunjukkan bahwa panggilan metode berhasil. Nilai lainnya menunjukkan kegagalan.

Menonaktifkan atau mengaktifkan kembali penangkapan video lokal.

public abstract int enableLocalVideo(boolean enable);

Metode ini mengontrol pengaktifan dan penonaktifan penangkapan video lokal. Ketika penangkapan video lokal dinonaktifkan, tidak ada data video untuk pratinjau lokal atau ingest aliran, tetapi hal ini tidak memengaruhi penerimaan video jarak jauh. Jika Anda memanggil metode ini untuk menonaktifkan penangkapan kamera lokal, baik pratinjau lokal maupun ingest aliran jarak jauh tetap menampilkan frame terakhir.

Kapan harus memanggil

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

Callback terkait

Panggilan API ini yang berhasil memberi tahu pengguna jarak jauh melalui callback onUserVideoEnabled.

Parameter

Deskripsi Pengembalian

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Menghentikan atau melanjutkan pengiriman data video lokal.

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

Saat mengingest aliran, Anda dapat memanggil metode ini untuk mengirim frame video hitam sepenuhnya. Pratinjau lokal tetap normal, dan modul penangkapan, encoding, serta pengiriman tetap beroperasi, tetapi konten videonya terdiri dari frame hitam.

Parameter

Deskripsi Nilai Kembali

Nilai 0 menunjukkan bahwa panggilan berhasil.

Memeriksa apakah kamera menyala.

public abstract boolean isCameraOn();

Return Description

Nilai true menunjukkan kamera menyala. Nilai false menunjukkan kamera mati.

Menetapkan properti encoding video.

public abstract void setVideoEncoderConfiguration(AliRtcVideoEncoderConfiguration config);

Metode ini menetapkan properti encoding untuk aliran video, seperti resolusi, laju frame, bitrate, dan orientasi video. Kami menyarankan Anda memanggil metode ini untuk semua skenario video.

Kapan dipanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke saluran. Jika Anda hanya perlu mengatur properti encoding video untuk aliran kamera sekali per sesi, kami menyarankan Anda memanggil metode ini sebelum bergabung ke saluran.

Batasan

Parameter mirrorMode dari metode ini dan metode setVideoMirrorMode sama-sama mengatur pencerminan untuk ingest aliran video. Kami menyarankan Anda hanya menggunakan salah satu dari metode ini. Menggunakan kedua metode ini dapat menyebabkan efek pencerminan tumpang tindih, yang dapat menyebabkan kegagalan atau ketidakkonsistenan pencerminan.

Parameter

Menetapkan properti decoding video.

    public abstract void setVideoDecoderConfiguration(AliRtcVideoDecoderConfiguration config);

Metode ini menetapkan parameter video untuk decoding aliran video.

Kapan dipanggil

Kami menyarankan memanggil metode ini sebelum bergabung ke saluran.

Parameter

Anda dapat beralih antara kamera depan dan belakang. Secara default, kamera depan digunakan.

public abstract int switchCamera();

Metode ini mengontrol apakah akan menggunakan kamera depan atau belakang. Secara default, kamera depan digunakan. Anda dapat beralih secara dinamis antar kamera selama runtime aplikasi, berdasarkan kamera yang tersedia, tanpa perlu me-restart aliran video atau mengonfigurasi ulang sumber video.

Kapan dipanggil

Anda hanya dapat memanggil metode ini setelah kamera berhasil diaktifkan.

Batasan

Metode ini hanya didukung di Android dan iOS.

Deskripsi nilai kembali

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

Mengambil arah kamera saat ini.

public abstract AliRTCCameraDirection getCurrentCameraDirection();

Petunjuk Pengembalian

• Nilai CAMERA_REAR (0) menunjukkan kamera belakang.

• Nilai CAMERA_FRONT (1) menunjukkan kamera depan.

• Nilai CAMERA_INVALID (-1) menunjukkan nilai tidak valid.

Memulai pratinjau lokal.

public abstract int startPreview();

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

Waktu pemanggilan

• Anda harus mengatur tampilan untuk pratinjau lokal dengan memanggil setLocalViewConfig sebelum panggilan. Jika tidak, pratinjau tidak akan ditampilkan, tetapi ingest aliran tidak terpengaruh.

• Jika diperlukan, Anda dapat memanggil metode ini untuk memulai pratinjau sebelum memanggil joinChannel. Kamera akan otomatis menyala.

Deskripsi Pengembalian

Nilai 0 menunjukkan panggilan berhasil, sedangkan nilai lainnya menunjukkan kegagalan.

Menghentikan pratinjau lokal.

public abstract int stopPreview();

Metode ini menghentikan pratinjau video lokal dan mematikan kamera. Setelah pratinjau dihentikan, tampilan lokal menampilkan frame terakhir yang ditangkap, dan ingest aliran tidak terpengaruh.

Kapan dipanggil

Anda dapat memanggil metode ini setelah memulai pratinjau lokal.

Deskripsi Nilai Kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Anda dapat mengatur rasio zoom kamera.

public abstract int setCameraZoom(float zoom);

Anda dapat mengatur faktor zoom kamera.

Batasan

Metode ini hanya tersedia di perangkat iOS dan Android.

Kapan dipanggil

Pengaturan ini hanya berlaku setelah Anda mengaktifkan kamera. Zoom akan diatur ulang setiap kali kamera dimulai ulang.

Parameter

Deskripsi Nilai Kembali

• 0: panggilan berhasil.

• Bukan nol: panggilan metode gagal.

Mengambil faktor zoom maksimum (zoom optik) yang didukung kamera.

public abstract float GetCameraMaxZoomFactor();

Deskripsi Nilai Kembali

Faktor zoom maksimum yang didukung kamera perangkat.

Anda dapat mengambil pengaturan faktor zoom kamera saat ini.

public abstract float GetCurrentZoom();

Deskripsi Pengembalian

Faktor zoom kamera saat ini dari perangkat.

Anda dapat mengatur eksposur kamera.

public abstract int SetExposure(float exposure);

Saat lingkungan pemotretan terlalu gelap atau terlalu terang, kualitas penangkapan video terpengaruh. Untuk meningkatkan kualitas video, Anda dapat menggunakan metode ini untuk menyesuaikan tingkat eksposur kamera Anda. Anda dapat mengambil rentang tingkat eksposur yang didukung menggunakan GetMinExposure dan GetMaxExposure.

Parameter

Deskripsi respons

• 0: panggilan berhasil.

• Nilai bukan nol menunjukkan bahwa panggilan metode gagal.

Mengambil tingkat eksposur kamera.

public abstract float GetCurrentExposure();

Mengambil pengaturan tingkat eksposur kamera yang sedang digunakan.

Deskripsi nilai kembali

Tingkat eksposur kamera saat ini.

Anda dapat memperoleh eksposur minimum yang didukung kamera.

public abstract float GetMinExposure();

Deskripsi nilai kembali

Tingkat eksposur minimum kamera.

Mengambil tingkat eksposur kamera maksimum yang didukung.

public abstract float GetMaxExposure();

Deskripsi Nilai Kembali

Tingkat eksposur maksimum kamera.

Mengaktifkan atau menonaktifkan lampu kilat kamera.

public abstract int setCameraFlash(boolean flash);

Mengaktifkan atau menonaktifkan lampu kilat.

Batasan

Metode ini hanya didukung di iOS dan Android.

Parameter

Deskripsi Kembalian

• 0: Pengaturan berhasil.

• Nilai bukan nol: Pengaturan gagal.

Memeriksa apakah fokus manual didukung pada perangkat saat ini.

public abstract boolean isCameraFocusPointSupported();

Memeriksa apakah kamera saat ini mendukung pengaturan titik fokus untuk fokus manual.

Batasan

Metode ini hanya tersedia di iOS dan Android.

Deskripsi respons

• true: Perangkat mendukung fokus manual.

• false: Perangkat tidak mendukung fokus manual.

Memeriksa apakah pengaturan titik eksposur kamera didukung.

public abstract boolean isCameraExposurePointSupported();

Menentukan apakah titik eksposur dapat diatur pada perangkat saat ini.

Batasan

Metode ini hanya tersedia di iOS dan Android.

Deskripsi Kembalian

• true: Titik eksposur kamera dapat diatur.

• false: Titik eksposur kamera tidak dapat diatur.

Anda dapat mengatur titik fokus manual kamera.

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

Menetapkan titik fokus untuk kamera saat ini. Setelah Anda memanggil operasi ini, kamera menyesuaikan eksposur untuk titik yang ditentukan dan kemudian mempertahankan nilai fokus tersebut. Sebelum memanggil operasi ini, kami menyarankan Anda memanggil isCameraFocusPointSupported untuk memeriksa apakah perangkat mendukung fokus manual.

Batasan

Metode ini hanya tersedia di iOS dan Android.

Panggil metode ini hanya sebelum bergabung ke saluran.

Deskripsi Kembalian

• 0: panggilan berhasil.

• Bukan nol: panggilan gagal.

Anda dapat mengatur titik eksposur kamera.

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

Operasi ini menetapkan titik eksposur kamera. Setelah Anda memanggilnya, kamera menyesuaikan eksposur sekali untuk titik yang ditentukan dan mempertahankan nilai eksposur tersebut. Sebelum memanggil operasi ini, kami menyarankan Anda memanggil isCameraExposurePointSupported untuk memeriksa apakah perangkat mendukung pengaturan titik eksposur manual.

Batasan

Metode ini hanya tersedia di perangkat iOS dan Android.

Parameter

Deskripsi Pengembalian

• 0: Panggilan metode berhasil.

• Bukan nol: Panggilan metode gagal.

Memeriksa apakah kamera mendukung fokus wajah otomatis.

public abstract boolean isCameraAutoFocusFaceModeSupported();

Menentukan apakah kamera mendukung fokus wajah otomatis.

Kapan Harus Menghubungi

Anda hanya dapat memanggil metode ini setelah kamera diaktifkan. Metode ini mengembalikan true jika kamera diaktifkan dan mendukung deteksi wajah serta fokus otomatis. Jika tidak, metode ini mengembalikan false.

Batasan

Metode ini hanya tersedia di iOS dan Android.

Deskripsi Pengembalian

• true: Fokus wajah otomatis didukung.

• false: Fokus wajah otomatis tidak didukung.

Anda dapat mengatur fokus wajah kamera.

public abstract boolean setCameraAutoFocusFaceModeEnabled(boolean enable);

Antarmuka ini mengaktifkan autofokus real-time pada wajah manusia. Sebelum memanggil metode ini, Anda harus memanggil isCameraAutoFocusFaceModeSupported untuk memverifikasi dukungan perangkat terhadap fitur ini.

Batasan

Metode ini hanya tersedia di iOS dan Android.

Parameter

Deskripsi nilai kembali

• true: Panggilan berhasil.

• false: Panggilan gagal.

Mengonfigurasi pencerminan video untuk pratinjau dan ingest aliran.

public abstract int setVideoMirrorMode(AliRtcVideoPipelineMirrorMode mirrorMode);

Menentukan apakah akan mengaktifkan mode pencerminan untuk video pratinjau lokal dan aliran video yang diingest.

Kapan Harus Menelepon

Anda dapat mengatur metode ini secara dinamis sebelum atau setelah bergabung ke saluran. SDK mencatat status secara internal dan menerapkan operasi video saat pratinjau dan encoding (ingest aliran) tersedia.

Batasan Panggilan

Metode ini tumpang tindih dengan mirrorMode di setLocalViewConfig dan setVideoEncoderConfiguration. Kami menyarankan hanya menggunakan salah satu dari metode ini.

Panggil metode ini sebelum bergabung ke saluran.

Deskripsi respons

• 0: Pengaturan berhasil diterapkan.

• <0: Pengaturan gagal.

  • AliRtcErrInner: Kesalahan status internal SDK. Anda dapat memeriksa apakah instans SDK berhasil dibuat.

Menetapkan waktu penskalaan penangkapan video.

public abstract void setCapturePipelineScaleMode(AliRtcCapturePipelineScaleMode mode);

Menetapkan apakah penskalaan data video terjadi segera setelah penangkapan atau selama encoding. Misalnya, ketika resolusi penangkapan berbeda dari resolusi encoding, Anda dapat mengatur waktu penskalaan untuk menentukan apakah data pratinjau dan data ingest aliran konsisten.

Kapan dipanggil

Tetapkan metode ini sebelum mengaktifkan kamera. Misalnya, atur sebelum memulai pratinjau dengan startPreview atau bergabung ke saluran dengan joinChannel.

Parameter

Deskripsi Kembalian

Tidak ada.

Mengaktifkan sumber input video eksternal.

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

Parameter

Mengimpor data video.

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

Parameter

Deskripsi respons

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Memulai streaming langsung yang diteruskan.

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

Parameter

Deskripsi respons

Nilai 0 menunjukkan bahwa panggilan berhasil. Nilai lainnya menunjukkan kegagalan.

Anda dapat memperbarui parameter streaming langsung bypass.

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

Parameter

Instruksi Pengembalian

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Hentikan streaming langsung bypass.

public abstract int stopPublishLiveStream(String streamUrl);

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Ambil status streaming langsung bypass.

public abstract AliRtcEngine.AliRtcLiveTranscodingState getPublishLiveStreamState(String streamUrl);

Parameter

Instruksi Pengembalian

Mengembalikan status streaming langsung bypass.

Anda dapat mengaktifkan probing kualitas jaringan.

public abstract int startNetworkQualityProbeTest(AlirtcNetworkQualityProbeConfig config);

Parameter

Deskripsi nilai kembali

Nilai 0 menunjukkan keberhasilan, sedangkan nilai bukan nol menunjukkan kegagalan.

Menghentikan pengujian kualitas jaringan.

public abstract int stopNetworkQualityProbeTest();

Deskripsi Nilai Kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Anda dapat mengirim informasi ekstensi media.

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

SDK memungkinkan Anda mengirim dan menerima pesan ekstensi media. Metode pengiriman menggunakan protokol ekstensi SEI. Penerima dapat memperoleh pesan dengan mendengarkan event onMediaExtensionMsgReceived.

Kasus penggunaan umum meliputi hal berikut:

• Gunakan informasi ekstensi media untuk mengirimkan timestamp, menghitung latensi jaringan end-to-end, atau menyinkronkan data dengan operasi bisnis lainnya.

• Gunakan informasi ekstensi media untuk mengirimkan informasi deskriptif. Anda dapat mengirimkan hingga 4 KB data, yang cocok untuk jumlah data kecil. Kami menyarankan menggunakan JSON atau string biasa.

Kapan Harus Menghubungi

Anda dapat memanggil metode ini setelah memulai ingest aliran.

Batasan

Menggunakan informasi ekstensi media memerlukan penggunaan kembali saluran data audio dan video. Oleh karena itu, Anda harus mengontrol seberapa sering Anda mengirim pesan kustom dan panjang data pesan. Batasannya adalah sebagai berikut:

• Anda dapat mengirim hingga pesan fps per detik, sebagaimana ditentukan dalam profil, karena informasi SEI disematkan dalam aliran H.264 atau H.265 dan memerlukan encoding frame video untuk melampirkan informasi ekstensi.

• Untuk menghindari dampak pada kualitas transmisi data media, badan pesan kustom dibatasi hingga 4 KB, sehingga cocok untuk jumlah informasi kecil.

• Parameter repeatCount dalam fungsi sendMediaExtensionMsg menentukan tingkat redundansi untuk pesan kustom. Jika nilai ini lebih besar dari 1, pesan dikirim beberapa kali.

• Redundansi ini membantu mencegah kehilangan pesan akibat kehilangan paket jaringan. Dalam kasus tersebut, peserta lain di ruangan menerima beberapa pesan identik dan harus menghapus duplikatnya.

• Pelanggan di ruangan juga menerima pesan kustom selama streaming langsung yang diteruskan.

• Hanya satu MediaExtensionMsg yang ditransmisikan sekaligus. Beberapa panggilan ke sendMediaExtensionMsg akan menimpa data yang sedang dalam antrian.

Callback terkait

Pengguna yang menarik aliran dapat mengambil informasi ekstensi media yang dikirim oleh pengguna yang mengingest aliran dengan mendengarkan callback onMediaExtensionMsgReceived.

Parameter

Petunjuk Pengembalian

• 0: Panggilan berhasil.

• <0: Panggilan gagal. Kode kesalahan dikembalikan.

  • ERR_INNER(-1): Kesalahan internal SDK. Kemungkinan penyebab: SDK belum diinisialisasi, atau dipanggil setelah dihancurkan.

Mengirim informasi ekstensi media.

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

SDK menyediakan fitur untuk mengirim dan menerima informasi ekstensi media. Metode ini mengirim informasi ekstensi media menggunakan protokol ekstensi SEI. Anda dapat memperoleh informasi dengan mendengarkan onMediaExtensionMsgReceived. Ketika payloadType adalah 5, ini setara dengan menggunakan antarmuka sendMediaExtensionMsg.

Kasus penggunaan umum meliputi hal berikut:

• Gunakan informasi ekstensi media untuk mengirimkan timestamp, menghitung latensi jaringan end-to-end, atau menyinkronkan data dengan operasi bisnis lainnya.

• Gunakan informasi ekstensi media untuk mengirimkan informasi deskriptif. Anda dapat mengirimkan hingga 4 KB data, yang cocok untuk jumlah data kecil. Kami menyarankan menggunakan JSON atau string biasa.

Kapan Menghubungi

Anda dapat memanggil metode ini setelah Anda memulai ingest aliran.

Batasan

Menggunakan informasi ekstensi media memerlukan penggunaan kembali saluran data audio dan video. Oleh karena itu, Anda harus mengontrol seberapa sering Anda mengirim pesan kustom dan panjang data pesan. Batasannya adalah sebagai berikut:

• Anda dapat mengirim hingga pesan fps per detik, sebagaimana ditentukan dalam profil, karena informasi SEI disematkan dalam aliran H.264 atau H.265 dan memerlukan encoding frame video untuk melampirkan informasi ekstensi.

• Untuk menghindari penurunan kualitas transmisi data media, badan pesan kustom dibatasi hingga 4 KB, sehingga cocok untuk jumlah informasi kecil.

• Parameter repeatCount dalam fungsi sendMediaExtensionMsg menentukan tingkat redundansi untuk pesan kustom. Jika nilai ini lebih besar dari 1, pesan dikirim beberapa kali.

• Redundansi ini membantu mencegah kehilangan pesan akibat kehilangan paket jaringan. Dalam kasus tersebut, peserta lain di ruangan menerima beberapa pesan identik dan harus menghapus duplikatnya.

• Pelanggan di ruangan juga menerima pesan kustom selama streaming langsung yang diteruskan.

• Hanya satu MediaExtensionMsg yang ditransmisikan sekaligus. Beberapa panggilan ke sendMediaExtensionMsg akan menimpa data yang sedang dalam antrian.

Deskripsi Parameter

Deskripsi nilai kembali

• 0: Panggilan berhasil.

• <0: Panggilan gagal dan mengembalikan kode kesalahan.

  • ERR_INNER(-1): Terjadi kesalahan internal SDK. Kemungkinan penyebab termasuk kegagalan inisialisasi SDK atau memanggil SDK setelah dihancurkan.

Callback ini dipanggil ketika status koneksi jaringan berubah. Penting untuk memantau callback ini.

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

Parameter

Callback yang dipanggil ketika terjadi pengecualian perangkat lokal. Perhatikan baik-baik callback ini.

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

Parameter

Callback ini menunjukkan bahwa autentikasi pengguna akan kedaluwarsa dalam 30 detik. Anda harus menangani callback ini.

public void onAuthInfoWillExpire();

Callback ini menunjukkan bahwa informasi autentikasi pengguna akan kedaluwarsa dalam 30 detik. Anda harus mendapatkan token baru dan memperbarui informasi autentikasi menggunakan salah satu metode 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.

Waktu Pemicu

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

Pengguna memanggil antarmuka yang memerlukan autentikasi, dan server mengembalikan informasi kedaluwarsa.

public void onAuthInfoExpired();

Callback ini menunjukkan bahwa informasi autentikasi pengguna telah kedaluwarsa. Jika Anda ingin tetap berada dalam sesi, Anda harus menghasilkan token baru di server dan kemudian memperbarui informasi autentikasi menggunakan metode berikut:

• Anda dapat memanggil <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="c3b0cf2f19dgm">leaveChannel</a> untuk keluar dari saluran saat ini. Kemudian, panggil joinChannel untuk masuk kembali.

Waktu Pemicu

Callback ini dipicu ketika informasi autentikasi pengguna kedaluwarsa.

Callback ini mengembalikan hasil bergabung ke saluran.

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

Parameter

Callback yang mengembalikan hasil meninggalkan saluran.

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

Kondisi Pemicu

Callback ini dipicu ketika 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> dan sistem mengembalikan hasil meninggalkan saluran bersama dengan informasi statistik sesi.

Parameter

Callback offline untuk pengguna jarak jauh.

public void onRemoteUserOffLineNotify(String uid, AliRtcUserOfflineReason reason);

Callback ini memberi tahu pengguna lokal bahwa pengguna jarak jauh telah meninggalkan saluran karena mereka offline.

Kondisi Pemicu

• Ketika pengguna jarak jauh secara aktif meninggalkan saluran, callback dipicu.

• Ketika 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 viewer (dengan memanggil AliRtcEngine#setClientRole dan mengatur peran ke AliRTCSdkLive), callback dipicu.

• Ketika streamer jarak jauh dianggap offline karena tidak menerima data dari mereka dalam periode yang lama, callback dipicu.

Parameter

Callback ini dipanggil ketika pengguna jarak jauh online.

public void onRemoteUserOnLineNotify(String uid, int elapsed);

Metode ini memberi tahu klien lokal bahwa pengguna jarak jauh telah bergabung ke saluran.

Kondisi Pemicu

• Pengguna jarak jauh bergabung ke saluran.

• Setelah pengguna lokal bergabung ke saluran, callback ini dipanggil untuk setiap pengguna yang sudah berada di saluran. Hal ini memungkinkan pengguna lokal mengidentifikasi pengguna yang sudah ada.

Parameter

Callback ini dipanggil ketika aliran audio dan video pengguna jarak jauh berubah.

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

Callback ini dipicu ketika status ingest aliran pengguna jarak jauh berubah. Melalui callback ini, developer dapat memperoleh informasi real-time tentang apakah pengguna jarak jauh sedang mengingest aliran audio dan video, dan sesuai dengan itu menampilkan atau menyembunyikan informasi audio dan video pengguna jarak jauh.