ApsaraVideo Live：Antarmuka AliRtcEngine

Membuat instans AliRtcEngine.

static AliEngine *Create(const char *extras);

Kapan harus memanggil

Panggil metode ini untuk membuat instance AliRtcEngine sebelum memanggil API lain dari kit pengembangan perangkat lunak (SDK) Alibaba Real-Time Communication (ARTC).

Batasan

SDK hanya mendukung pembuatan satu instance AliRtcEngine per aplikasi.

Parameter

Nilai kembali

Mengembalikan instance singleton dari kelas AliEngine.

Menghapus instans AliRtcEngine.

static void Destroy(AliEngineDestroyCompletionCallback *callback = nullptr);

Menghancurkan objek singleton AliRtcEngine. Setelah memanggil metode ini, semua sumber daya internal dilepaskan. Anda tidak dapat lagi menggunakan metode atau callback lain dari AliRtcEngine. Untuk menggunakannya kembali, Anda harus memanggil Create untuk membuat instance baru.

Kapan harus memanggil

Panggil metode ini untuk melepaskan instance setelah menyelesaikan sesi Komunikasi Real-Time.

Batasan

Untuk menghindari deadlock, jangan panggil metode ini di dalam callback SDK apa pun.

Parameter

Mendapatkan instance antarmuka fitur.

virtual int QueryInterface(AliEngineInterfaceIdType iid, void** pInterface) = 0;

Metode ini mendapatkan instance antarmuka fitur tertentu. Saat mengembangkan aplikasi audio dan video di Windows, banyak fitur lanjutan disediakan melalui kelas antarmuka yang sesuai, seperti manajemen perangkat audio (AliEngineInterfaceAudioDeviceManager), manajemen perangkat video (AliEngineInterfaceVideoDeviceManager), dan mesin media (AliEngineInterfaceMediaEngine). Sebelum memanggil metode terkait, Anda harus menggunakan metode QueryInterface untuk mendapatkan instance antarmuka ini.

Parameter

Nilai pengembalian

• 0: Panggilan berhasil.

• <0: Panggilan gagal.

Menetapkan apakah akan mengaktifkan mode kompatibilitas H5.

static void SetH5CompatibleMode(bool comp);

Parameter

Memeriksa apakah mode kompatibilitas H5 diaktifkan.

static bool GetH5CompatibleMode();

Nilai kembali

Mengembalikan true jika kompatibilitas H5 diaktifkan; false jika tidak diaktifkan.

Menetapkan listener event.

virtual int SetEngineEventListener(AliEngineEventListener *listener) = 0;

Metode ini menetapkan listener callback untuk SDK. Dengan menetapkan listener ini, Anda dapat menerima berbagai notifikasi event dari mesin, seperti pengguna yang bergabung atau meninggalkan saluran, perubahan status jaringan, dan status aliran audio/video.

Anda perlu mengimplementasikan kelas AliEngineEventListener untuk menyesuaikan metode event yang ingin Anda dengarkan. Secara default, semua antarmuka memiliki implementasi kosong. Anda tidak perlu mengimplementasikan semua metode, cukup sesuai kebutuhan bisnis Anda.

Panggilan balik terkait

Jika terjadi pengecualian selama runtime, SDK pertama-tama mencoba memulihkan secara otomatis. Untuk kesalahan yang tidak dapat diselesaikan secara internal, SDK memberi tahu aplikasi Anda melalui antarmuka callback yang telah ditentukan. Berikut adalah callback utama untuk masalah yang tidak dapat ditangani SDK dan memerlukan pendengaran serta respons dari lapisan aplikasi:

Parameter

Nilai kembali

• 0: Sukses.

• Nilai bukan nol: Gagal. Kegagalan mungkin karena parameter listener tidak valid atau SDK tidak diinisialisasi dengan benar.

Menanyakan versi SDK saat ini.

static const char *GetSDKVersion();

Nilai kembali

Nomor versi SDK saat ini dalam format string, misalnya, "2.5.0.x".

Menetapkan mode saluran.

virtual int SetChannelProfile(const AliEngineChannelProfile channelProfile) = 0;

Metode ini menetapkan mode saluran. Saat ini tersedia dua skenario: panggilan video dan streaming interaktif:

• Mode panggilan video: Semua pengguna memiliki peran streamer dan dapat melakukan ingest aliran dan penarikan aliran.

• Mode streaming interaktif: Anda perlu memanggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="4e50f781a01e1">SetClientRole</a> untuk menetapkan peran pengguna. Untuk pengguna yang melakukan ingest aliran di saluran, tetapkan peran mereka ke streamer (AliRTCSdkInteractive). Jika pengguna hanya melakukan penarikan aliran, tetapkan peran mereka ke viewer (AliRTCSdkLive). Mode ini direkomendasikan untuk skenario RTC.

Kapan harus memanggil

Anda hanya dapat memanggil metode ini sebelum bergabung ke saluran. Metode ini tidak dapat diatur ulang saat berada di saluran. Anda dapat mengaturnya ulang setelah meninggalkan saluran.

Parameter

Nilai kembali

• 0: Pemanggilan metode berhasil.

• Nilai lainnya: Pemanggilan metode gagal.

  • -1: SDK belum diinisialisasi atau telah dihapus.

Menetapkan profil audio.

virtual int SetAudioProfile(int audioProfile, int audioScene) = 0;

Metode ini menetapkan mode pengkodean audio dan mode skenario audio. Untuk informasi lebih lanjut, lihat Operasi dan konfigurasi audio umum. SDK ARTC menggunakan mode berkualitas tinggi (AliEngineHighQualityMode) dan mode skenario musik (AliEngineSceneMusicMode) secara default. Jika pengaturan default tidak memenuhi kebutuhan Anda, panggil metode ini untuk mengonfigurasinya.

Kapan harus memanggil

Anda hanya dapat memanggil metode ini sebelum bergabung ke saluran. Metode ini tidak dapat diatur ulang setelah bergabung ke saluran. Anda dapat mengaturnya ulang setelah meninggalkan saluran.

Parameter

Nilai kembali

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

Memeriksa apakah mode saat ini hanya audio.

virtual bool IsAudioOnlyMode() = 0;

Nilai kembali

true menunjukkan mode hanya audio; false menunjukkan mode audio dan video.

Menetapkan mode ke hanya audio atau audio dan video.

virtual int SetAudioOnlyMode(bool audioOnly) = 0;

Parameter

Nilai kembali

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

Masuk ke saluran.

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const char *userName) = 0;

Metode ini bergabung ke saluran. ARTC mengatur pengguna berdasarkan saluran. Pengguna harus bergabung ke saluran untuk mempublikasikan atau berlangganan aliran audio dan video. Metode ini, JoinChannel[2/3], dan JoinChannel[3/3] semuanya dapat digunakan untuk bergabung ke saluran. Mereka berbeda dalam metode autentikasi dan informasi pengguna yang dilewatkan, seperti dijelaskan di bawah ini:

• Metode ini untuk bergabung dengan parameter tunggal. Lewatkan token yang dihasilkan untuk bergabung dengan parameter tunggal menggunakan Autentikasi Token untuk bergabung ke saluran. Kami merekomendasikan menggunakan metode ini untuk bergabung ke saluran dalam skenario RTC.

• JoinChannel[2/3] untuk bergabung dengan parameter ganda. Anda perlu melewati token yang dihasilkan untuk bergabung dengan parameter ganda menggunakan Autentikasi Token, dan juga melewati informasi pengguna yang digunakan untuk menghasilkan token.

• JoinChannel[3/3] untuk skenario interaksi real-time AI. Lewatkan token bergabung dengan parameter tunggal dan tetapkan properti pengguna capabilityProfile berdasarkan skenario.

Kapan harus dipanggil

Panggil metode ini setelah membuat mesin.

Batasan

• Setelah berhasil bergabung ke saluran, jika Anda ingin beralih ke saluran yang berbeda, Anda harus terlebih dahulu memanggil LeaveChannel untuk meninggalkan saluran saat ini. Anda hanya dapat bergabung ke saluran baru setelah menerima callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="b2522e57e4vom">OnLeaveChannelResult</a>.

• Metode ini hanya mendukung bergabung ke satu saluran sekaligus.

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

• Jangan panggil metode ini untuk mencoba kembali jika gagal masuk ke saluran.

Callback terkait

Pemanggilan sukses metode ini memicu callback berikut:

• Hasil klien lokal bergabung ke saluran dikembalikan oleh callback AliRtcEngineEventListener's <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="cad6eb9b1bwx7">OnJoinChannelResult</a>.

• Setelah berhasil bergabung ke saluran, pengguna jarak jauh memicu callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="fab4a94264m28">OnRemoteUserOnLineNotify</a>.

Parameter

Nilai kembali

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

Masuk ke sebuah saluran.

virtual int JoinChannel(const AliEngineAuthInfo &authInfo,
                                 const char *userName) = 0;

Metode ini bergabung ke saluran. ARTC mengatur pengguna berdasarkan saluran. Pengguna harus bergabung ke saluran untuk mempublikasikan atau berlangganan aliran audio dan video. Metode ini, JoinChannel[1/3], dan JoinChannel[3/3] semuanya dapat digunakan untuk bergabung ke saluran. Mereka berbeda dalam metode autentikasi dan informasi pengguna yang dilewatkan, seperti dijelaskan di bawah ini:

• JoinChannel[1/3] untuk bergabung dengan parameter tunggal. Lewatkan token yang dihasilkan untuk bergabung dengan parameter tunggal menggunakan Autentikasi Token untuk bergabung ke saluran. Kami merekomendasikan menggunakan metode ini untuk bergabung ke saluran dalam skenario RTC.

• Metode ini untuk bergabung dengan parameter ganda. Anda perlu melewati token yang dihasilkan untuk bergabung dengan parameter ganda menggunakan Autentikasi Token, dan juga melewati informasi pengguna yang digunakan untuk menghasilkan token.

• JoinChannel[3/3] untuk skenario interaksi real-time AI. Lewatkan token bergabung dengan parameter tunggal dan tetapkan properti pengguna capabilityProfile berdasarkan skenario.

Batasan

• Setelah berhasil bergabung ke saluran, jika Anda perlu beralih ke saluran lain, Anda harus terlebih dahulu memanggil LeaveChannel untuk meninggalkan yang saat ini. Anda hanya dapat bergabung ke yang baru setelah menerima callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="fcd2fac6abf0y">OnLeaveChannelResult</a>.

• Metode ini hanya mendukung bergabung ke satu saluran sekaligus.

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

Callback terkait

Pemanggilan sukses metode ini memicu callback berikut:

• Hasil klien lokal bergabung ke saluran dikembalikan dalam callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="b3db8c610ewua">OnJoinChannelResult</a>.

• Setelah berhasil bergabung ke saluran, ujung jarak jauh memicu callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="a1297d33bcd92">OnRemoteUserOnLineNotify</a>.

Parameter

Masuk ke sebuah saluran.

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const AliEngineChannelParam &userParam) = 0;

Metode ini bergabung ke saluran. ARTC mengatur pengguna berdasarkan saluran. Pengguna harus bergabung ke saluran untuk mempublikasikan atau berlangganan aliran audio dan video. Metode ini, JoinChannel[1/3], dan JoinChannel[2/3] semuanya dapat digunakan untuk bergabung ke saluran. Mereka berbeda dalam metode autentikasi dan informasi pengguna yang dilewatkan, seperti dijelaskan di bawah ini:

• JoinChannel[1/3] untuk bergabung dengan parameter tunggal dalam skenario RTC. Lewatkan token yang dihasilkan untuk bergabung dengan parameter tunggal menggunakan Autentikasi Token untuk bergabung ke saluran. Kami merekomendasikan menggunakan metode ini untuk bergabung ke saluran dalam skenario RTC.

• JoinChannel[2/3] untuk bergabung dengan parameter ganda. Anda perlu melewati token yang dihasilkan untuk bergabung dengan parameter ganda menggunakan Autentikasi Token, dan juga melewati informasi pengguna yang digunakan untuk menghasilkan token.

• Metode ini untuk skenario interaksi real-time AI. Lewatkan token bergabung dengan parameter tunggal dan tetapkan properti pengguna capabilityProfile berdasarkan skenario. Jika Anda ingin berkomunikasi dengan agen AI, tetapkan ke AliCapabilityProfileHuman.

Batasan

• Setelah berhasil bergabung ke saluran, jika Anda perlu bergabung ke saluran lain, Anda harus terlebih dahulu memanggil leaveChannel untuk meninggalkan saluran saat ini dan memastikan bahwa Anda menerima callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="15ec544e3985m">OnLeaveChannelResult</a> sebelum Anda dapat bergabung ke saluran lain.

• Metode ini hanya mendukung bergabung ke satu saluran sekaligus.

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

• Jangan panggil metode ini untuk mencoba ulang jika bergabung ke saluran gagal.

Callback terkait

Pemanggilan sukses metode ini memicu callback berikut:

• Hasil klien lokal bergabung ke saluran diberi tahu melalui callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="5d109191c950l">OnJoinChannelResult</a>.

• Setelah berhasil bergabung ke saluran, ujung jarak jauh memicu callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="fa6f8d9357glx">OnRemoteUserOnLineNotify</a>.

Parameter

Nilai kembali

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

Meninggalkan saluran.

virtual int LeaveChannel() = 0;

Setelah memanggil metode ini, SDK menghentikan interaksi audio dan video dan meninggalkan saluran saat ini.

Kapan harus memanggil

• Panggil metode ini saat Anda perlu meninggalkan saluran yang telah Anda gabung.

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

Callback terkait

• Pengguna lokal: Memanggil metode ini memicu callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="9626ae24d89ue">OnLeaveChannelResult</a> untuk memberi tahu Anda mengenai hasil keluar dari saluran.

• Sisi jarak jauh: Pemanggilan API ini yang berhasil memicu callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#44ce12a0ecj52" id="0dfcab6a6fylt">OnRemoteUserOffLineNotify</a> untuk pengguna jarak jauh.

Nilai kembali

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

Memeriksa apakah pengguna saat ini berada di saluran.

virtual bool IsInCall() = 0;

Nilai kembali

true menunjukkan pengguna berada di saluran; false menunjukkan pengguna tidak berada di saluran.

Menetapkan peran pengguna.

virtual int SetClientRole(const AliEngineClientRole clientRole) = 0;

Metode ini menetapkan peran pengguna sebagai streamer atau viewer.

Dalam mode streaming interaktif, sebelum bergabung ke saluran:

• Tetapkan peran pengguna ke streamer: SDK secara otomatis mempublikasikan aliran audio dan video lokal dan menerima aliran audio dan video streamer lain secara default.

• Tetapkan peran pengguna ke viewer: SDK tidak mempublikasikan aliran audio dan video lokal, tetapi menerima aliran audio dan video streamer lain.

Kapan harus memanggil

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

Batasan

Metode ini hanya efektif dalam mode interaktif, yaitu saat Anda memanggil API <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#901e748242y3g" id="322c3da902jpt">SetChannelProfile</a> untuk menetapkan profil saluran ke AliEngineInteractiveLive.

Dalam mode streaming interaktif, kami merekomendasikan secara eksplisit memanggil metode ini untuk menetapkan peran pengguna sebelum bergabung ke saluran.

Parameter

Nilai kembali

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

Mendapatkan jenis peran pengguna saat ini (streamer/viewer).

virtual AliEngineClientRole GetClientRole() = 0;

Nilai kembali

Jika pemanggilan metode berhasil, metode ini mengembalikan objek AliEngineClientRole. Ini adalah enumerasi yang menunjukkan jenis peran adalah streamer (0) atau viewer (1).

Memperbarui informasi autentikasi.

virtual int RefreshAuthInfo(const AliEngineAuthInfo &authInfo) = 0;

Metode ini memperbarui informasi autentikasi. Token kedaluwarsa setelah periode tertentu. Saat kedaluwarsa, SDK tidak dapat terhubung ke server.

Kapan harus memanggil

Dalam situasi berikut:

• Saat Anda menerima callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#9f8ebe177degw" id="f52a19bb78yoi">OnAuthInfoWillExpire</a> yang melaporkan bahwa informasi autentikasi akan segera kedaluwarsa, kami merekomendasikan agar Anda membuat ulang Token di server Anda, lalu memanggil metode ini dan melewatkan Token baru.

• Jika Anda tidak memperbarui Token tepat waktu, callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#09c4ec9160eom" id="440c501877fxr">OnAuthInfoExpired</a> dipicu, yang menunjukkan bahwa autentikasi telah kedaluwarsa. Anda kemudian harus membuat ulang Token dan memanggil JoinChannel untuk bergabung kembali ke saluran.

Parameter

Nilai pengembalian

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

Memperbarui informasi autentikasi.

virtual int RefreshAuthInfo(const char *token) = 0;

Metode ini memperbarui token. Token kedaluwarsa setelah periode tertentu. Saat kedaluwarsa, SDK tidak dapat terhubung ke server.

Kapan harus memanggil

Dalam situasi berikut, kami merekomendasikan agar Anda membuat ulang token di server Anda dan kemudian memanggil metode ini untuk melewatkan token baru:

• Saat Anda menerima callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#9f8ebe177degw" id="b21949148djrc">OnAuthInfoWillExpire</a>, yang menunjukkan bahwa informasi autentikasi akan segera kedaluwarsa.

• Jika Anda tidak memperbarui token tepat waktu, callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#09c4ec9160eom" id="62df9bf63786v">OnAuthInfoExpired</a> dipicu untuk memberi tahu Anda bahwa autentikasi telah kedaluwarsa. Pada titik ini, Anda harus memanggil JoinChannel untuk bergabung kembali ke saluran.

Parameter

Nilai pengembalian

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

Menetapkan apakah akan mempublikasikan aliran audio lokal.

virtual int PublishLocalAudioStream(bool enabled) = 0;

Metode ini mengontrol apakah akan mempublikasikan aliran audio yang ditangkap secara lokal. SDK mempublikasikan aliran audio secara default. Jika Anda tidak ingin mempublikasikan aliran audio secara default, Anda dapat memanggil PublishLocalAudioStream(false) sebelum bergabung ke saluran untuk menonaktifkan publikasi aliran audio.

Kapan harus memanggil

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

Callback terkait

Saat status ingest aliran audio lokal berubah, klien lokal memicu callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#eb8fab7f5ak7v" id="c584949653jn5">OnAudioPublishStateChanged</a> untuk memberi tahu status terbaru ingest aliran audio, dan klien jarak jauh memicu callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="75f2096b1efxy">OnRemoteTrackAvailableNotify</a> untuk memberi tahu perubahan pada aliran audio dan video pengguna jarak jauh.

Parameter

Nilai kembali

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

Menanyakan apakah publikasi aliran audio saat ini diizinkan.

virtual bool IsLocalAudioStreamPublished() = 0;

Nilai kembali

true menunjukkan publikasi diizinkan; false menunjukkan publikasi tidak diizinkan.

Menetapkan apakah akan berlangganan ke aliran audio jarak jauh secara default.

virtual int SetDefaultSubscribeAllRemoteAudioStreams(bool sub) = 0;

Metode ini mengonfigurasi apakah sistem berlangganan ke aliran audio pengguna jarak jauh secara default. Pengaturan ini memengaruhi perilaku berlangganan aliran audio untuk pengguna baru yang bergabung ke saluran. Kami merekomendasikan menetapkannya ke true kecuali Anda memiliki persyaratan khusus.

Kapan harus memanggil

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

• Sebelum bergabung dengan saluran:

  • SDK berlangganan ke aliran audio pengguna jarak jauh secara default saat bergabung ke saluran. Jika Anda ingin mengubah perilaku ini, panggil metode ini sebelum bergabung ke saluran.

• Setelah bergabung dengan saluran:

  • Jika Anda ingin menghentikan langganan default, panggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e95a7e2d6fjwt">SetDefaultSubscribeAllRemoteAudioStreams</a>(false) sehingga Anda tidak akan berlangganan ke aliran audio pengguna yang kemudian bergabung ke saluran.

  • Setelah Anda menghentikan langganan default, jika Anda ingin melanjutkan berlangganan ke aliran audio pengguna tertentu, panggil antarmuka <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="1a391bcabc66e">SubscribeRemoteAudioStream</a>. Jika Anda ingin melanjutkan berlangganan ke aliran audio beberapa pengguna, panggil antarmuka beberapa kali.

  • Setelah Anda menghentikan langganan default, memanggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e79b5ad58awcw">SetDefaultSubscribeAllRemoteAudioStreams</a>(true) hanya melanjutkan aliran audio pengguna yang kemudian bergabung ke saluran. Aliran audio pengguna jarak jauh yang bergabung saat langganan dihentikan tidak berlangganan.

Parameter

Nilai kembali

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

Menghentikan atau melanjutkan berlangganan aliran audio dari pengguna remote tertentu.

virtual int SubscribeRemoteAudioStream(const char* uid, bool sub) = 0;

Metode ini menghentikan atau melanjutkan berlangganan ke aliran audio pengguna jarak jauh tertentu. Kami merekomendasikan menetapkannya ke true kecuali Anda memiliki persyaratan khusus.

Parameter

Nilai kembali

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

Menghentikan atau melanjutkan penerimaan semua aliran audio remote.

virtual int SubscribeAllRemoteAudioStreams(bool sub) = 0;

Metode ini adalah sakelar utama untuk berlangganan ke aliran audio jarak jauh. Kami merekomendasikan menetapkannya ke true. Jika Anda menetapkannya ke false, hal berikut terjadi:

• Langganan ke semua aliran audio jarak jauh di saluran saat ini berhenti.

• Pengguna baru yang bergabung ke saluran tidak berlangganan.

• Anda tidak dapat menggunakan <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="aface4ad3920l">SubscribeRemoteAudioStream</a> untuk mengontrol secara individual aliran audio pengguna tertentu.

Untuk berlangganan kembali, panggil metode ini lagi dan atur ke true untuk melanjutkan langganan.

Parameter

Nilai kembali

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

Memublikasikan atau menghentikan publikasi aliran kamera.

virtual int PublishLocalVideoStream(bool enabled) = 0;

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

Kapan harus dipanggil

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

Memanggilnya sebelum bergabung ke saluran akan mengubah konfigurasi default, yang akan berlaku saat Anda bergabung.

Callback terkait

Ketika status pengambilan aliran audio lokal berubah, callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="d37709b09147d">OnVideoPublishStateChanged</a> akan dipicu pada klien lokal untuk memberi tahu status pengambilan terbaru, sedangkan callback <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="f16e4b51bchqb">OnRemoteTrackAvailableNotify</a> akan dipicu pada klien jarak jauh untuk memberi tahu bahwa aliran audio dan video pengguna jarak jauh telah berubah.

Parameter

Nilai kembalian

• 0: Pemanggilan metode berhasil.

• <0: Pemanggilan metode gagal.

Mengatur izin pengiriman aliran video.

virtual int PublishLocalVideoStream(bool enabled, AliEngineVideoTrack track) = 0;

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

Kapan harus memanggil

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

Memanggilnya sebelum bergabung dengan saluran akan mengubah konfigurasi default, yang berlaku saat Anda bergabung.

Callback terkait

Ketika status pengambilan aliran audio lokal berubah, callback <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="18a9d4b47ezcc">OnVideoPublishStateChanged</a> dipicu pada klien lokal untuk melaporkan status terbaru pengambilan aliran audio, sedangkan callback <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="d01e7a574f92o">OnRemoteTrackAvailableNotify</a> dipicu pada klien jarak jauh untuk menunjukkan bahwa aliran audio dan video dari pengguna jarak jauh telah berubah.

Parameter

Nilai kembali

• 0: Pemanggilan metode berhasil.

• <0: Pemanggilan metode gagal.

Menanyakan apakah penerbitan aliran video saat ini diizinkan.

virtual bool IsLocalVideoStreamPublished() = 0;

Nilai kembali

true menunjukkan aliran kamera telah diterbitkan; false menunjukkan aliran kamera belum diterbitkan.

Mengatur apakah akan berlangganan aliran video jarak jauh secara default.

virtual int SetDefaultSubscribeAllRemoteVideoStreams(bool sub) = 0;

Metode ini mengatur apakah akan berlangganan aliran video secara default. SDK melakukan langganan secara default.

Kapan harus memanggil

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

• Sebelum bergabung dengan saluran:

  • Anda dapat menggunakan metode ini untuk membatalkan pengaturan langganan default.

• Setelah bergabung dengan saluran:

  • Untuk menghentikan langganan default, panggil SetDefaultSubscribeAllRemoteVideoStreams(false). Hal ini akan mencegah berlangganan aliran video pengguna yang selanjutnya bergabung ke saluran.

  • Setelah menghentikan langganan default, jika Anda ingin melanjutkan berlangganan aliran video pengguna tertentu, panggil metode SubscribeRemoteVideoStream. Untuk melanjutkan berlangganan beberapa pengguna, panggil metode tersebut beberapa kali.

  • Setelah menghentikan langganan default, pemanggilan SetDefaultSubscribeAllRemoteVideoStreams(false) hanya akan melanjutkan berlangganan ke aliran video dari pengguna yang bergabung setelahnya.

Parameter

Nilai kembali

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

Menghentikan atau melanjutkan berlangganan aliran video pengguna jarak jauh.

virtual int SubscribeRemoteVideoStream(const char* uid, AliEngineVideoTrack track, bool sub) = 0;

Berlangganan atau membatalkan langganan aliran video pengguna tertentu.

Kapan harus memanggil

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

Parameter

Nilai kembalian

• true: Pengaturan berhasil.

• false: Pengaturan gagal.

Menghentikan atau melanjutkan menerima semua aliran video remote.

virtual int SubscribeAllRemoteVideoStreams(bool sub) = 0;

Metode ini adalah sakelar utama untuk berlangganan aliran video remote. Jika Anda menyetelnya ke false, berikut yang terjadi:

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

• Pengguna baru yang bergabung ke rapat nanti juga tidak akan berlangganan (meskipun Anda telah mengatur <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#2cbc54790brn3" id="b7b0080f3cnoq">SetDefaultSubscribeAllRemoteVideoStreams</a>(true) untuk berlangganan secara default).

• Anda tidak dapat menggunakan <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#jyGTp" id="0e2edf97aa1g6">SubscribeRemoteVideoStream</a> untuk mengontrol secara individual aliran video pengguna tertentu.

Untuk berlangganan kembali, panggil metode ini lagi dan atur ke true untuk melanjutkan langganan.

Parameter

Nilai kembali

Nilai 0 menunjukkan bahwa pemanggilan metode berhasil, sedangkan nilai lainnya menunjukkan kegagalan pemanggilan metode.

Menghentikan atau melanjutkan aliran media pengguna jarak jauh tertentu.

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, bool subVideo,  bool subAudio) = 0;

Metode ini berlangganan aliran audio dan video jarak jauh secara bersamaan.

Metode terkait

Dibandingkan dengan SubscribeRemoteMediaStream[2/2], metode ini menggunakan dua parameter Boolean, subVideo dan subAudio, untuk menentukan apakah akan berlangganan aliran audio dan video jarak jauh. Parameter videoTrack mengontrol aliran video mana yang ditarik.

Parameter

Nilai kembali

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

Menghentikan atau melanjutkan aliran media pengguna jarak jauh tertentu.

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, AliEngineAudioTrack audioTrack) = 0;

Metode ini berlangganan aliran audio dan video jarak jauh secara bersamaan.

Metode terkait

Dibandingkan dengan SubscribeRemoteMediaStream[1/2], metode ini menggunakan parameter videoTrack dan audioTrack untuk memberi tahu SDK mengenai status langganan yang diinginkan dalam satu panggilan. Contohnya:

• Untuk berlangganan aliran kamera dan aliran mikrofon, atur videoTrack dan audioTrack masing-masing ke AliRtcVideoTrackCamera dan AliRtcAudioTrackMic saat memanggil.

• Untuk membatalkan langganan aliran kamera tetapi tetap mempertahankan mikrofon, panggil kembali dan atur videoTrack dan audioTrack masing-masing ke AliRtcVideoTrackNo dan AliRtcAudioTrackMic.

• Untuk membatalkan keduanya, panggil kembali dan atur videoTrack dan audioTrack masing-masing ke AliRtcVideoTrackNo dan AliRtcAudioTrackNo.

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

Parameter

Nilai kembali

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

Berlangganan ke aliran pengguna tertentu di berbagai saluran.

virtual int SubscribeRemoteDestChannelStream(const char* channelId, const char* uid, AliEngineVideoTrack track, bool sub_audio, bool sub) = 0;

Parameter

Nilai kembalian

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

Menyesuaikan volume pemutaran pengguna remote tertentu.

virtual int SetRemoteAudioVolume(const char *uid, int volume) = 0;

Parameter

Nilai kembali

• 0: Sukses.

• Nilai bukan nol: Gagal.

Menghentikan atau melanjutkan pengiriman data audio lokal.

virtual int MuteLocalMic(bool mute, AliEngineMuteLocalAudioMode mode = AliEngineMuteLocalAudioModeDefault) = 0;

Kapan harus memanggil

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

Callback terkait

Setelah pemanggilan berhasil, pengguna jarak jauh memicu notifikasi <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#a15f0a6cf6id7" id="f4ae88f094vqy">OnUserAudioMuted</a>, yang menunjukkan apakah pengguna tersebut dalam keadaan diredam (muted).

Parameter

Nilai kembali

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

Menghentikan atau melanjutkan pemutaran audio jarak jauh.

virtual int MuteRemoteAudio(const char *uid,
                                    bool mute) = 0;

API ini hanya menghentikan atau melanjutkan pemutaran audio pengguna jarak jauh tertentu, tetapi tidak memengaruhi penarikan aliran atau dekoding audio jarak jauh. Untuk berhenti berlangganan dari aliran audio pengguna, panggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="89841a0989t7y">SubscribeRemoteAudioStream</a>.

Kapan harus memanggil

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

Parameter

Nilai kembali

Nilai 0 menunjukkan bahwa pemanggilan metode berhasil, sedangkan nilai lainnya menunjukkan kegagalan pemanggilan metode.

Menentukan apakah pemutaran Track audio dari semua pengguna jarak jauh akan dihentikan.

virtual int MuteAllRemoteAudio(bool mute) = 0;

API ini menghentikan atau melanjutkan semua pemutaran audio jarak jauh.

Kapan harus memanggil

Anda dapat mengatur ini sebelum atau setelah bergabung dengan saluran.

Deskripsi metrik

Nilai kembali

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

Memulai penangkapan audio.

virtual int StartAudioCapture() = 0;

Metode ini mengontrol awal perekaman audio. Anda juga dapat memanggilnya sebelum bergabung ke saluran untuk memulai perekaman audio lebih awal. Jika tidak diatur, SDK secara otomatis mengontrol perangkat perekaman audio. Untuk memulai kembali perekaman audio setelah dihentikan dengan memanggil stopAudioCapture, panggil metode ini.

Kapan harus memanggil

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

Metode terkait

• Metode StartAudioCapture[2/2] dapat mengontrol apakah perangkat perekaman audio tetap aktif setelah meninggalkan saluran.

Callback terkait

Setelah memanggil metode ini untuk mengubah status perekaman audio lokal, Anda dapat memperoleh perubahan status tersebut melalui callback OnLocalAudioStateChange.

Nilai kembali

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

Memulai penangkapan audio.

virtual int StartAudioCapture(bool keepAlive) = 0;

Menghentikan penangkapan mikrofon setelah membisukan suara.

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

Kapan harus memanggil

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

Metode terkait

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

Callback terkait

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

Parameter

Nilai kembalian

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

Menghentikan penangkapan audio.

virtual int StopAudioCapture() = 0;

Setelah memulai pengambilan perangkat audio dengan StartAudioCapture, Anda dapat memanggil metode ini untuk menghentikan pengambilan tersebut.

Callback terkait

Setelah memanggil metode ini untuk mengubah status pengambilan audio lokal, Anda dapat memperoleh perubahan status melalui callback OnLocalAudioStateChange.

Nilai kembalian

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

Mengatur frekuensi callback volume dan koefisien penghalusan.

virtual int EnableAudioVolumeIndication(int interval, int smooth, int reportVad) = 0;

Metode ini memungkinkan SDK melaporkan secara berkala informasi terkait volume dari pengguna penerbit lokal dan pengguna jarak jauh dengan volume instan tertinggi ke aplikasi.

Kapan harus memanggil

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

Callback terkait

Setelah pemanggilan metode ini berhasil, jika terdapat pengguna yang menerbitkan aliran di saluran, SDK akan memicu dua callback berikut pada interval waktu yang ditetapkan:

• Volume audio pembicara diberitahukan melalui callback OnAudioVolumeCallback. Frekuensi callback ditentukan oleh interval.

• Deteksi aktivitas suara. Ketika pengguna aktif terdeteksi, UID pembicara diberitahukan melalui callback OnActiveSpeaker.

Kapan harus memanggil

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

Parameter

Nilai kembalian

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

Memulai perangkat pemutaran audio.

virtual int StartAudioPlayer() = 0;

Metode ini dapat mengontrol awal pemutaran audio secara lebih awal. Jika tidak diatur, SDK akan secara otomatis memulai pemutaran audio setelah berlangganan ke aliran audio.

Nilai kembali

• 0: Sukses.

• Nilai bukan nol: Gagal. Kode kesalahan dikembalikan.

Menghentikan pemutaran audio.

virtual int StopAudioPlayer() = 0;

Metode ini dapat mengontrol penghentian pemutaran audio. Metode ini berkorespondensi dengan AliEngine::StartAudioPlayer.

Parameter

Tidak ada.

Nilai kembali

• 0: Sukses.

• Nilai bukan nol: Gagal. Kode kesalahan dikembalikan.

Menetapkan volume pemutaran.

virtual int SetPlayoutVolume(int volume) = 0;

Parameter

Return value

• 0: Sukses.

• Nilai bukan nol: Gagal. Kode kesalahan dikembalikan.

virtual int SetRecordingVolume(int volume) = 0;

Parameter

Return value

• 0: Sukses.

• Nilai bukan nol: Gagal. Kode kesalahan dikembalikan.

Memainkan file audio.

virtual int PlayAudioFileTest(const char* filePath) = 0;

Parameter

Nilai kembali

• 0: Sukses.

• <0: Gagal.

Menghentikan pemutaran file audio.

virtual int StopAudioFileTest() = 0;

Nilai kembali

• 0: Sukses.

• <0: Gagal.

Memulai pengujian penangkapan audio sebelum panggilan.

virtual int StartAudioCaptureTest() = 0;

Metode ini dapat mengontrol dimulainya pengujian perekaman audio. Hasil dari callback AliEngineEventListener::OnTestAudioVolumeCallback digunakan untuk menentukan apakah perekaman audio berjalan normal.

Nilai kembali

• 0: Berhasil.

• <0: Gagal.

Menghentikan tes perekaman audio.

virtual int StopAudioCaptureTest() = 0;

Nilai kembali

• 0: Sukses.

• <0: Gagal.

Mengaktifkan atau menonaktifkan penangkapan dan publikasi audio sistem.

virtual int EnableSystemAudioRecording(bool enable, const char *path = nullptr, const char *device_id = nullptr) = 0;

Metode ini mengaktifkan atau menonaktifkan penangkapan audio sistem, seperti suara dari browser dan aplikasi.

Parameter

Nilai pengembalian

• 0: Panggilan metode berhasil.

• <0: Panggilan metode gagal.

Memeriksa apakah perekaman dan publikasi audio sistem saat ini diaktifkan.

virtual bool IsSystemAudioRecording() = 0;

Nilai kembalian

• true: Diaktifkan.

• false: Dinonaktifkan.

Mengatur volume pengambilan dan penerbitan audio sistem.

virtual int SetSystemAudioRecordingVolume(int volume) = 0;

Metode ini hanya berlaku pada platform Windows dan macOS.

Metode ini hanya dapat diatur setelah pengambilan dan penerbitan audio sistem diaktifkan. Jika tidak, pengaturan tersebut tidak valid.

Parameter

Nilai kembali

• 0: Sukses.

• <0: Gagal.

Mendapatkan volume perekaman dan publikasi audio sistem saat ini.

virtual int GetSystemAudioRecordingVolume() = 0;

Metode ini hanya berlaku pada platform Windows dan macOS.

Nilai kembali

Volume ingest perekaman sistem.

Mengatur volume pemutaran audio sistem.

virtual int SetSystemAudioPlayoutVolume(int volume) = 0;

Metode ini hanya berlaku pada platform Windows dan macOS.

Metode ini hanya dapat diatur setelah pengambilan dan penerbitan audio sistem diaktifkan. Jika tidak, pengaturan tersebut tidak valid.

Parameter

Return value

• 0: Berhasil.

• <0: Gagal.

Mengembalikan volume playout audio sistem saat ini.

virtual int GetSystemAudioPlayoutVolume() = 0;

Fungsi ini hanya didukung pada platform Windows dan macOS.

Return value

Volume pemutaran audio sistem.

Mendapatkan daftar perangkat perekaman dalam sistem.

virtual AliEngineDeviceInfoList* GetAudioCaptureList() = 0;

Nilai kembali

Sebuah pointer ke daftar perangkat perekaman, AliEngineDeviceInfoList *.

Mendapatkan nama perangkat tangkapan audio yang sedang digunakan.

virtual String GetCurrentAudioCaptureName() = 0;

Nilai kembali

Sebuah string yang merepresentasikan nama perangkat tangkapan audio saat ini.

Mendapatkan ID perangkat perekaman yang sedang digunakan.

virtual String GetCurrentAudioCaptureID() = 0;

Nilai kembali

ID perangkat perekaman yang saat ini sedang digunakan.

Memilih perangkat perekaman berdasarkan nama.

virtual int SetCurrentAudioCaptureName(const char* captureName) = 0;

Parameter

Nilai kembali

0 untuk keberhasilan, nilai lain untuk kegagalan.

Memilih perangkat perekaman berdasarkan ID.

virtual int SetCurrentAudioCaptureID(const char* captureID) = 0;

Parameter

Nilai kembali

0 untuk keberhasilan, nilai lain untuk kegagalan.

Mendapatkan daftar speaker dalam sistem.

virtual AliEngineDeviceInfoList* GetAudioPlayerList() = 0;

Nilai kembalian

Sebuah pointer ke daftar speaker dalam sistem, AliEngineDeviceInfoList *.

Mendapatkan daftar speaker yang dapat direkam dalam sistem (untuk perekaman internal sistem).

virtual AliEngineDeviceInfoList* GetSystemRecordAudioPlayerList() = 0;

Nilai kembali

Daftar perangkat pemutaran audio terutama disediakan untuk EnableSystemAudioRecording sebagai parameter terakhir untuk menangkap audio pemutaran sistem.

Mendapatkan nama speaker yang sedang digunakan.

virtual String GetCurrentAudioPlayerName() = 0;

Nilai kembali

Nama perangkat pemutaran audio saat ini.

Mendapatkan ID speaker yang sedang digunakan.

virtual String GetCurrentAudioPlayerID() = 0;

Nilai kembali

ID perangkat pemutaran audio saat ini.

Pilih nama speaker.

virtual int SetCurrentAudioPlayerName(const char* playerName) = 0;

Nilai kembali

Nama perangkat pemutaran audio.

Memilih speaker berdasarkan ID.

virtual int SetCurrentAudioPlayerID(const char* playerID) = 0;

Parameter

Nilai kembali

0 untuk keberhasilan, nilai lainnya untuk kegagalan.

Mengatur volume perangkat perekaman audio. Rentang volume adalah [0, 100].

virtual int SetRecordingDeviceVolume(int volume) = 0;

Daftar parameter

Nilai kembali

0 untuk keberhasilan, nilai lainnya untuk kegagalan.

Mendapatkan volume perangkat perekam audio.

virtual int GetRecordingDeviceVolume() = 0;

Nilai kembali

>=0 mengembalikan volume. Nilai lain menunjukkan kegagalan.

Mengatur volume perangkat pemutaran audio. Rentang volume adalah [0, 100].

virtual int SetPlaybackDeviceVolume(int volume) = 0;

Parameter

Nilai kembali

0 untuk keberhasilan, nilai lain untuk kegagalan.

Mendapatkan volume perangkat pemutaran audio.

virtual int GetPlaybackDeviceVolume() = 0;

Nilai kembali

>=0 adalah volume sistem. Nilai lain menunjukkan kegagalan.

Meredam perangkat perekaman audio.

virtual int SetRecordingDeviceMute(bool mute) = 0;

Parameter

Nilai kembali

0 untuk keberhasilan, nilai lainnya untuk kegagalan.

Mendapatkan status bisu perangkat perekaman audio.

virtual bool GetRecordingDeviceMute() = 0;

Nilai kembali

Apakah perekaman dalam keadaan dibisukan atau tidak.

Membisukan perangkat pemutaran audio.

virtual int SetPlaybackDeviceMute(bool mute) = 0;

Parameter

Nilai kembali

0 untuk keberhasilan, nilai lainnya untuk kegagalan.

Mendapatkan status bisu perangkat pemutaran audio.

virtual bool GetPlaybackDeviceMute() = 0;

Return value

Apakah perangkat pemutaran dalam keadaan dibisukan atau tidak.

Mengatur mode efek pengubah suara.

virtual int SetAudioEffectVoiceChangerMode(const AliEngineAudioEffectVoiceChangerMode &mode) = 0;

Parameter

Return value

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

Mengatur parameter perubahan pitch.

virtual int SetAudioEffectPitchValue(double value) = 0;

Parameter

Return value

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

Mengatur mode efek gema (reverberation).

virtual int SetAudioEffectReverbMode(const AliEngineAudioEffectReverbMode& mode) = 0;

Parameter

Nilai kembali

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

Mengatur jenis efek reverberasi dan parameter spesifiknya.

virtual int SetAudioEffectReverbParamType(const AliEngineAudioEffectReverbParamType& type,
                                                  float value) = 0;

Parameter

Nilai kembali

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

Menambahkan aliran audio eksternal.

virtual int AddExternalAudioStream(const AliEngineExternalAudioStreamConfig& config) = 0;

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

1. Panggil API <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#991b862eb353w" id="08ee3d1ed35jj">AddExternalAudioStream</a> untuk menambahkan aliran audio eksternal dan mendapatkan ID aliran audio eksternal tersebut.

2. Panggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e6cf3f7cef0g6" id="fae817d0f00p3">PushExternalAudioStreamRawData</a> untuk mendorong data audio ke aliran audio yang telah dibuat.

3. Saat panggilan berakhir, Anda perlu memanggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#u27oe" id="3b9a3eb119umh">RemoveExternalAudioStream</a> untuk menghapus aliran audio eksternal tersebut.

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

Parameter

Nilai pengembalian

Nilai lebih besar dari 0 menunjukkan pemanggilan metode berhasil, dan nilai kembali tersebut merupakan ID aliran audio eksternal. Nilai lainnya menunjukkan pemanggilan metode gagal.

Memasukkan data aliran audio eksternal.

virtual int PushExternalAudioStreamRawData(int streamId, AliEngineAudioRawData& data) = 0;

Metode ini meneruskan data ke aliran audio yang ditentukan. Langkah-langkahnya adalah sebagai berikut:

1. Panggil operasi <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#991b862eb353w" id="3836ac109732c">AddExternalAudioStream</a> untuk menambahkan aliran audio eksternal dan memperoleh ID aliran audio eksternal.

2. Panggil PushExternalAudioStreamRawData untuk mendorong data audio ke aliran audio yang dibuat.

3. Saat panggilan berakhir, Anda harus memanggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#u27oe" id="398ea88d61fn0">RemoveExternalAudioStream</a> untuk menghapus aliran audio eksternal tersebut.

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

Deskripsi metrik

Nilai pengembalian

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

Menetapkan volume publikasi aliran audio eksternal.

virtual int SetExternalAudioStreamPublishVolume(int streamId, int vol) = 0;

Parameter

Returns

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

Mengatur volume pemutaran untuk aliran audio eksternal.

virtual int SetExternalAudioStreamPlayoutVolume(int streamId, int vol) = 0;

Parameter

Nilai kembali

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

Mendapatkan volume publikasi dari aliran audio eksternal.

virtual int GetExternalAudioStreamPublishVolume(int streamId) = 0;

Parameter

Returns

Volume publikasi, dari 0 hingga 100. Nilai kurang dari 0 menunjukkan kegagalan.

Mendapatkan volume pemutaran dari aliran audio eksternal.

virtual int GetExternalAudioStreamPlayoutVolume(int streamId) = 0;

Parameter

Returns

Volume pemutaran, dari 0 hingga 100. Nilai kurang dari 0 menunjukkan kegagalan.

Menghapus aliran audio eksternal.

virtual int RemoveExternalAudioStream(int streamId) = 0;

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

Kapan harus memanggil

Jika Anda ingin menggunakan fitur input audio kustom, Anda perlu memanggil metode AddExternalAudioStream untuk menambahkan aliran audio dan mendapatkan ID aliran audio eksternal. Setelah itu, panggil antarmuka <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e6cf3f7cef0g6" id="bdab74f108i1p">PushExternalAudioStreamRawData</a> untuk memasukkan data audio Anda ke SDK. Ketika Anda ingin berhenti menggunakan input audio kustom, panggil antarmuka ini untuk menghapus aliran audio eksternal yang sesuai dan membersihkan sumber daya.

Parameter

Nilai kembali

Mengembalikan 0 jika berhasil. Nilai bukan nol menunjukkan bahwa pemanggilan gagal.

Mendapatkan informasi file audio.

virtual int GetAudioFileInfo(const char *filePath) = 0;

Ini adalah antarmuka asinkron. Anda dapat memperoleh informasi file audio melalui AliEngineEventListener::OnAudioFileInfo.

Parameter

Returns

• 0: Sukses.

• Nilai bukan nol: Gagal. Kode kesalahan dikembalikan.

Memulai pencampuran iringan audio.

virtual int StartAudioAccompany(const char *filePath, const AliEngineAudioAccompanyConfig& config) = 0;

Ini adalah metode asinkron. Anda dapat memantau status pemutar iringan audio melalui AliEngineEventListener::OnAudioAccompanyStateChanged.

Parameter

Return value

• 0: Sukses.

• Nilai bukan nol: Gagal. Kode kesalahan dikembalikan.

Menghentikan pencampuran iringan audio.

virtual int StopAudioAccompany() = 0;

Returns

• 0: Berhasil.

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

Menetapkan volume dari audio iringan.

 virtual int SetAudioAccompanyVolume(int volume) = 0;

Parameter

Returns

• 0: Panggilan berhasil.

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

Mengatur volume pengambilan aliran untuk iringan audio.

virtual int SetAudioAccompanyPublishVolume(int volume) = 0;

Parameter

Returns

• 0: Sukses.

• Nilai bukan nol: Gagal. Nilai tersebut merupakan kode kesalahan.

Mendapatkan volume publikasi dari audio pendamping.

virtual int GetAudioAccompanyPublishVolume() = 0;

Returns

Volume publikasi dari audio pendamping. Nilainya berkisar antara 0 hingga 100.

Menetapkan volume pemutaran lokal dari audio iringan.

virtual int SetAudioAccompanyPlayoutVolume(int volume) = 0;

Parameter

Returns

• 0: Sukses.

• Nilai bukan nol: Gagal. Kode kesalahan dikembalikan.

Mendapatkan volume pemutaran lokal dari audio iringan.

virtual int GetAudioAccompanyPlayoutVolume() = 0;

Returns

Volume pemutaran lokal dari audio iringan. Nilainya berkisar antara 0 hingga 100.

Menghentikan sementara pencampuran suara iringan.

virtual int PauseAudioAccompany() = 0;

Returns

• 0: Panggilan berhasil.

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

Melanjutkan pencampuran iringan audio.

virtual int ResumeAudioAccompany() = 0;

Returns

• 0: Berhasil.

• Nilai bukan nol: Gagal. Nilai tersebut adalah kode kesalahan.

Mendapatkan durasi file iringan audio dalam milidetik.

virtual int GetAudioAccompanyDuration() = 0;

Pengembalian

Durasi file iringan audio dalam milidetik.

Mendapatkan posisi pemutaran saat ini dari file iringan audio dalam milidetik.

virtual int GetAudioAccompanyCurrentPosition() = 0;

Pengembalian

Posisi pemutaran saat ini dari file iringan audio, dalam milidetik.

Mengatur posisi pemutaran file iringan.

virtual int SetAudioAccompanyPosition(int pos) = 0;

Mengembalikan

• 0: Sukses.

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

Memuat terlebih dahulu file efek suara.

virtual int PreloadAudioEffect(unsigned int soundId,
                                       const char *filePath) = 0;

Parameter

Returns

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Membatalkan pemuatan file efek suara yang telah dimuat sebelumnya.

virtual int UnloadAudioEffect(unsigned int soundId) = 0;

Parameter

Returns

0 menunjukkan pemanggilan berhasil. Nilai lain menunjukkan pemanggilan gagal.

Memainkan efek suara.

virtual int PlayAudioEffect(unsigned int soundId, const char *filePath, const AliEngineAudioEffectConfig& config) = 0;

Parameter

Return value

0 menunjukkan pemanggilan berhasil. Nilai lain menunjukkan pemanggilan gagal.

Menghentikan pemutaran efek suara.

virtual int StopAudioEffect(unsigned int soundId) = 0;

Parameter

Return value

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

Menghentikan semua efek suara.

- (int)StopAllAudioEffects;

Nilai kembalian

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

Menghentikan sementara efek suara.

virtual int PauseAudioEffect(unsigned int soundId) = 0;

Parameter

Returns

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

Menghentikan sementara semua efek suara.

virtual int PauseAllAudioEffects() = 0;

Returns

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

Melanjutkan pemutaran efek suara.

virtual int ResumeAudioEffect(unsigned int soundId) = 0;

Parameter

Returns

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

Melanjutkan pemutaran semua efek suara.

virtual int ResumeAllAudioEffects() = 0;

Returns

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

Mengatur volume efek suara untuk pengambilan aliran.

virtual int SetAudioEffectPublishVolume(unsigned int soundId, int volume) = 0;

Parameter

Nilai kembali

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

Mendapatkan volume efek suara yang diterbitkan.

virtual int GetAudioEffectPublishVolume(unsigned int soundId) = 0;

Parameter

Returns

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menetapkan volume publikasi untuk semua efek suara.

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

Parameter

Returns

Mengembalikan 0 jika berhasil. Nilai lainnya menunjukkan terjadi kesalahan.

Menetapkan volume pemutaran lokal dari efek suara.

virtual int SetAudioEffectPlayoutVolume(unsigned int soundId, int volume) = 0;

Parameter

Returns

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

Mendapatkan volume pemutaran lokal dari efek suara.

virtual int GetAudioEffectPlayoutVolume(unsigned int soundId) = 0;

Parameter

Returns

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

Mengatur volume pemutaran untuk semua efek suara.

virtual int SetAllAudioEffectsPlayoutVolume(int volume) = 0;

Parameter

Return value

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

Mengatur volume pengambilan aliran untuk semua efek suara.

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

Parameter

Nilai kembali

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

Mengatur jendela rendering dan parameter rendering untuk pratinjau video lokal.

virtual int SetLocalViewConfig(AliEngineVideoCanvas renderConfig,
                                         AliEngineVideoTrack track) = 0;

Metode ini mengatur tampilan pratinjau lokal. Metode ini menyambungkan aliran video lokal ke jendela tampilan (view) dan mengonfigurasi pengaturan rendering-nya, seperti mode rendering, mode cermin, dan sudut rotasi. Pengaturan ini hanya memengaruhi pratinjau lokal dan tidak memengaruhi aliran video yang dipublikasikan. Untuk mengatur tampilan pengguna jarak jauh, panggil SetRemoteViewConfig.

Kapan harus memanggil

Panggil metode ini sebelum atau setelah bergabung ke saluran.

Parameter

Pengembalian

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

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

virtual int SetCameraCapturerConfiguration(const AliEngineCameraCapturerConfiguration& config) = 0;

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

Kapan harus memanggil

Panggil metode ini sebelum membuka kamera, misalnya, sebelum melakukan operasi berikut:

• StartPreview

• JoinChannel

Parameter

Nilai kembali

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

Menonaktifkan atau mengaktifkan kembali pengambilan video lokal.

virtual int EnableLocalVideo(bool enabled) = 0;

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 aliran video jarak jauh. Jika metode ini dipanggil untuk menonaktifkan kamera lokal, baik pratinjau lokal maupun aliran keluar akan membekukan pada bingkai terakhir.

Kapan harus memanggil

Panggil metode ini sebelum atau setelah Anda bergabung ke saluran.

Callback terkait

Pemanggilan metode ini yang berhasil akan memberi tahu pengguna jarak jauh melalui callback OnUserVideoEnabled.

Parameter

Pengembalian

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

Menghentikan atau melanjutkan pengiriman data video lokal.

virtual int MuteLocalCamera(bool mute, AliEngineVideoTrack track) = 0;

Panggil metode ini selama pengambilan aliran untuk mengirim frame video hitam. Pratinjau lokal tidak terpengaruh. Modul penangkapan, pengkodean, dan pengiriman tetap berjalan, tetapi konten video diganti dengan frame hitam.

Parameter

Nilai Kembali

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

Mengatur jendela rendering dan parameter rendering untuk video jarak jauh.

virtual int SetRemoteViewConfig(AliEngineVideoCanvas renderConfig,
                                          const char *uid,
                                          AliEngineVideoTrack track) = 0;

Metode ini menyambungkan tampilan untuk aliran video tertentu dari pengguna jarak jauh dan mengatur mode rendering, mode cermin (mirror), serta sudut rotasi untuk tampilan lokal, yang hanya memengaruhi citra video yang dilihat oleh pengguna lokal. Jika Anda perlu mengatur tampilan pratinjau lokal, panggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#fbc8ab10f5e03" id="c0f59b8c26y7o">SetLocalViewConfig</a>.

• Jika parameter view dalam AliEngineVideoCanvas kosong, rendering berhenti.

• Untuk mengatur ulang parameter renderMode dari AliEngineVideoCanvas selama pemutaran, ubah hanya renderMode dan pertahankan parameter lainnya tetap tidak berubah.

• Untuk mengatur ulang parameter mirrorMode dari AliEngineVideoCanvas selama pemutaran, ubah hanya mirrorMode dan pertahankan parameter lainnya tetap tidak berubah.

Kapan harus memanggil

Panggil metode ini ketika Anda menerima callback OnRemoteTrackAvailableNotify. Callback ini menunjukkan bahwa aliran video pengguna jarak jauh aktif.

Parameter

Nilai kembali

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

Memeriksa apakah kamera menyala.

virtual bool IsCameraOn() = 0;

Return value

Mengembalikan YES jika kamera menyala. Mengembalikan NO jika kamera mati.

Mengatur properti pengkodean video.

virtual void SetVideoEncoderConfiguration(const AliEngineVideoEncoderConfiguration& config) = 0;

Gunakan metode ini untuk mengatur parameter video untuk aliran video. Parameter-parameter tersebut mencakup resolusi, laju frame, bitrate, dan orientasi video. Panggil metode ini untuk semua skenario video.

Kapan harus memanggil

Panggil metode ini sebelum atau setelah bergabung dalam rapat. Untuk mengatur properti pengkodean video hanya sekali per rapat khusus untuk aliran kamera, panggil metode ini sebelum bergabung.

Batasan pemanggilan

Baik parameter `mirrorMode` pada metode ini maupun metode setVideoMirrorMode dapat mengatur cermin video untuk pengambilan aliran. Gunakan hanya salah satu opsi tersebut. Jika Anda menggunakan keduanya, efek cermin mungkin bertumpuk. Hal ini dapat menyebabkan pengaturan cermin gagal atau berperilaku tidak sesuai harapan.

Parameter

Menetapkan properti dekoding video untuk aliran kamera. Properti ini mencakup pengaturan dekoding perangkat lunak atau perangkat keras dan apakah akan mengaktifkan B-frame.

virtual void SetVideoDecoderConfiguration(const AliEngineVideoDecoderConfiguration& config) = 0;

Kapan harus memanggil

Panggil metode ini sebelum bergabung ke konferensi dan menarik aliran.

Parameter

Memulai pratinjau lokal dan secara otomatis mengaktifkan kamera.

virtual int StartPreview(int width = 0, int height = 0) = 0;

Metode ini memulai pratinjau video lokal dan secara otomatis mengaktifkan kamera. Untuk menghentikan pratinjau lokal, panggil metode StopPreview.

Kapan harus memanggil

• Sebelum memanggil metode ini, panggil SetLocalViewConfig untuk menetapkan tampilan bagi pratinjau lokal. Jika Anda tidak menetapkan tampilan, pratinjau tidak akan ditampilkan. Ingest aliran tidak terpengaruh.

• Sesuai kebutuhan, panggil metode ini sebelum Anda memanggil JoinChannel untuk memulai pratinjau. Kamera akan secara otomatis diaktifkan.

Nilai Pengembalian

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

Menghentikan pratinjau lokal.

virtual int StopPreview() = 0;

Metode ini menghentikan pratinjau video lokal dan mematikan Kamera. Setelah pratinjau dihentikan, tampilan video lokal membekukan pada bingkai terakhir. Hal ini tidak memengaruhi pengambilan aliran.

Kapan harus memanggil

Panggil metode ini untuk menghentikan pratinjau setelah pratinjau dimulai.

Return value

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

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

virtual int setVideoMirrorMode(AliEngineVideoPipelineMirrorMode mirrorMode) = 0;

Mengaktifkan atau menonaktifkan mode cermin untuk pratinjau video lokal dan aliran video yang dipublikasikan.

Kapan harus memanggil

Anda dapat memanggil metode ini secara dinamis baik sebelum maupun setelah bergabung ke saluran. SDK mencatat status tersebut secara internal. Perubahan akan diterapkan pada video ketika pratinjau dan pengkodean (pengambilan aliran) tersedia.

Batasan

Fungsi metode ini tumpang tindih dengan parameter `mirrorMode` dalam SetLocalViewConfig&SetVideoEncoderConfiguration. Gunakan hanya metode ini.

Parameter

Pengembalian

• 0: Pemanggilan metode berhasil.

• <0: Pemanggilan metode gagal.

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

Mengatur apakah akan menskalakan video yang ditangkap segera setelah penangkapan atau selama proses encoding.

virtual void SetCapturePipelineScaleMode(const AliEngineCapturePipelineScaleMode mode) = 0;

Pengaturan ini berguna ketika resolusi penangkapan berbeda dari resolusi encoding. Pengaturan ini memungkinkan Anda mengontrol apakah data pratinjau sesuai dengan data untuk aliran yang dimasukkan (ingested stream).

Kapan harus memanggil

Panggil metode ini sebelum membuka kamera. Misalnya, panggil sebelum memulai pratinjau dengan StartPreview atau bergabung ke saluran dengan JoinChannel.

Parameter

Mendapatkan daftar kamera.

virtual AliEngineDeviceInfoList* GetCameraList() = 0;

Nilai kembali

Sebuah pointer ke objek daftar kamera, AliEngineDeviceInfoList*.

Mendapatkan nama kamera yang sedang digunakan.

virtual String GetCurrentCameraName() = 0;

Nilai kembali

Nama perangkat dari kamera yang sedang digunakan.

Mendapatkan ID dari kamera saat ini.

virtual String GetCurrentCameraID() = 0;

Nilai kembali

ID dari kamera saat ini.

Mengatur kamera saat ini.

virtual int SetCurrentCameraName(const char* cameraName) = 0;

Parameter

Nilai pengembalian

Mengembalikan nilai 0 jika berhasil. Nilai bukan nol menunjukkan kegagalan.

Menetapkan ID kamera saat ini.

virtual int SetCurrentCameraID(const char* cameraID) = 0;

Parameter

Nilai pengembalian

Mengembalikan 0 jika berhasil. Nilai bukan nol menunjukkan kegagalan.

Mendapatkan resolusi yang didukung.

virtual AliEngineVideoResolutionList * GetCurrentCameraSupportedResolutionList(int source) = 0 ;

Parameter

Nilai kembali

Mengembalikan daftar resolusi yang didukung. Mengembalikan NULL jika operasi gagal.

Mengaktifkan sumber input video eksternal.

virtual int SetExternalVideoSource(bool enable,
        AliEngineVideoTrack type,
        AliEngineRenderMode renderMode) = 0;

Parameter

Mendorong data video eksternal.

virtual int PushExternalVideoFrame(const AliEngineVideoRawData &frame,
        AliEngineVideoTrack type) = 0;

Parameter

Return value

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

Memulai aliran langsung bypass.

virtual int StartPublishLiveStream(const String& streamURL, const AliEngineLiveTranscodingParam &transcoding) = 0;

Parameter

Returns

Mengembalikan 0 untuk pemanggilan metode yang berhasil. Mengembalikan nilai bukan nol untuk pemanggilan metode yang gagal.

Memperbarui parameter untuk streaming langsung tanpa proses tambahan.

virtual int UpdatePublishLiveStream(const String& streamURL, const AliEngineLiveTranscodingParam &transcoding) = 0;

Parameter

Returns

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

Menghentikan aliran langsung bypass.

virtual int StopPublishLiveStream(const String& streamURL) = 0;

Parameter

Return value

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

Mendapatkan status aliran langsung bypass.

virtual AliEngineLiveTranscodingState GetPublishLiveStreamState(const String& streamURL) = 0;

Parameter

Returns

Mengembalikan status aliran langsung bypass.

Memulai uji probe kualitas jaringan last-mile. Masalah pada jaringan lokal dapat menyebabkan panggilan audio dan video gagal. Panggil metode ini untuk mendapatkan informasi seperti bandwidth jaringan uplink dan downlink, tingkat kehilangan paket, jitter, dan waktu respons (RT) tautan. Informasi ini membantu Anda menemukan dan mengatasi masalah jaringan.

 virtual int StartLastmileDetect(bool uplink, bool downlink, int uplinkBandWidth, int downlinkBandWidth) = 0;

Kapan harus memanggil

Panggil metode ini sebelum memanggil JoinChannel. Hasil pengujian dikembalikan melalui callback. Pengujian probe jaringan dapat memakan waktu cukup lama. Panggil StopLastmileDetect untuk menghentikan pengujian probe jaringan sesuai kebutuhan.

Batasan penggunaan

Kit pengembangan perangkat lunak (SDK) hanya dapat menjalankan satu pengujian probe jaringan dalam satu waktu. Jika Anda memanggil metode ini lagi sebelum pengujian sebelumnya selesai, pemanggilan tersebut akan gagal.

Callback terkait

Setelah Anda berhasil memanggil metode ini, dua callback akan dipicu:

• OnLastmileDetectResultWithQuality: Callback ini dipicu sekitar 3 detik kemudian dan memberikan perkiraan kasar kualitas jaringan.

• OnLastmileDetectResultWithBandWidth: Callback ini dipicu sekitar 30 detik kemudian dan memberikan hasil pengujian yang lebih rinci.

Parameter

Nilai kembalian

• 0: Pemanggilan metode berhasil.

• <0: Pemanggilan metode gagal. Misalnya, Anda telah bergabung ke saluran.

Menghentikan probe kualitas jaringan.

virtual int StopLastmileDetect() = 0;

Kapan harus memanggil

Panggil API ini setelah Anda membuat engine dan sebelum bergabung ke dalam rapat.

Nilai yang dikembalikan

• 0: Pemanggilan berhasil.

• <0: Pemanggilan gagal.

Mengirim pesan ekstensi media. Fitur ini diimplementasikan secara internal menggunakan Supplemental Enhancement Information (SEI).

virtual int SendMediaExtensionMsg(const int8_t * message, uint32_t length, int32_t repeatCount, uint32_t delay, bool isKeyFrame) = 0;

SDK memungkinkan Anda mengirim dan menerima pesan ekstensi media. Untuk menerima pesan, lihat AliEngineEventListener::OnMediaExtensionMsgReceived. Pesan-pesan ini menggunakan kembali saluran data audio dan video. Oleh karena itu, kendalikan frekuensi dan panjang data pesan kustom Anda. Perhatikan batasan berikut:

• Jumlah pesan yang dikirim per detik tidak boleh melebihi nilai frame per detik (fps) yang ditetapkan dalam profil.

• Untuk menjaga kualitas transmisi data media, batasi isi pesan kustom hingga 4 KB. Hal ini memungkinkan Anda mentransfer data dalam jumlah kecil.

• Parameter repeatCount dalam fungsi sendMediaExtensionMsg mengontrol redundansi pesan. Jika Anda menetapkan parameter ini ke nilai lebih besar dari 1, pesan akan dikirim beberapa kali. Hal ini membantu mencegah kehilangan pesan akibat loss paket jaringan. Pengguna lain dalam saluran akan menerima pesan yang sama beberapa kali. Sisi penerima harus menghapus duplikat pesan-pesan tersebut.

• Pelanggan dalam saluran juga menerima pesan kustom ini selama live streaming bypass. Jika Anda menetapkan parameter repeatCount ke -1, pesan akan dikirim terus-menerus hingga Anda memanggil sendMediaExtensionMsg lagi.

• Hanya satu pemanggilan sendMediaExtensionMsg yang diproses dalam satu waktu. Pemanggilan baru ke fungsi ini akan menimpa pemanggilan sebelumnya jika pemanggilan sebelumnya belum dikirim atau belum selesai.

Parameter

Mengembalikan

• 0: Sukses.

• <0: Gagal. Kode kesalahan dikembalikan.

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

Mengirim pesan ekstensi media. Fungsi ini diimplementasikan secara internal menggunakan Informasi Peningkatan Tambahan (SEI).

virtual int SendMediaExtensionMsgEx(const int8_t * message, uint32_t length, int32_t repeatCount, uint32_t delay, bool isKeyFrame, int32_t payloadType) = 0;

SDK menyediakan fitur untuk mengirim dan menerima SEI. Untuk detail di sisi penerima, lihat AliEngineEventListener::OnMediaExtensionMsgReceived. Saat menggunakan fitur ini, Anda perlu menggunakan kembali saluran data audio dan video. Oleh karena itu, Anda harus mengontrol frekuensi pengiriman pesan kustom dan panjang pesan tersebut. Perhatikan poin-poin berikut:

• Jumlah maksimum pesan yang dikirim per detik tidak boleh melebihi nilai frames per second (fps) yang ditetapkan dalam profil.

• Isi pesan kustom dibatasi hingga 4 KB untuk menghindari dampak negatif terhadap kualitas transmisi data media. Anda dapat menggunakannya untuk mentransmisikan data dalam jumlah kecil.

• Parameter `repeatCount` pada 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. Anda harus menghapus duplikat pesan-pesan tersebut.

• Pelanggan dalam saluran juga menerima pesan kustom selama live streaming bypass. Jika Anda mengatur parameter `repeatCount` ke -1, data dikirim tanpa batas. Pengiriman hanya berhenti jika Anda memanggil `sendMediaExtensionMsg` lagi.

• Hanya satu panggilan `sendMediaExtensionMsg` yang diproses dalam satu waktu. Panggilan baru ke `sendMediaExtensionMsg` akan menimpa panggilan sebelumnya jika pesan sebelumnya belum dikirim atau masih dalam proses pengiriman.

Parameter

Nilai kembalian

• 0: Panggilan berhasil.

• <0: Panggilan gagal. Kode kesalahan dikembalikan.

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

Callback untuk perubahan status konektivitas jaringan.

virtual void OnConnectionStatusChange(int status, int reason) {};

Deskripsi parameter

Pemicu balik ini dipanggil ketika terjadi pengecualian pada perangkat lokal. Anda harus menangani pemicu balik ini.

virtual void OnLocalDeviceException(AliEngineLocalDeviceType deviceType, AliEngineLocalDeviceExceptionType exceptionType, const char* msg){};

Parameter

Callback ini memberi tahu Anda bahwa informasi autentikasi Anda akan kedaluwarsa dalam 30 detik. Anda harus menangani callback ini.

virtual void OnAuthInfoWillExpire() {};

Ketika Anda menerima callback ini, informasi autentikasi Anda akan kedaluwarsa dalam 30 detik. Dapatkan token baru dan perbarui informasi autentikasi Anda dengan salah satu cara berikut:

• Panggil metode RefreshAuthInfo untuk memperbarui informasi autentikasi.

• Panggil LeaveChannel untuk meninggalkan saluran saat ini, lalu panggil JoinChannel untuk bergabung kembali ke saluran tersebut.

Pemicu

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

Panggilan balik ini dipicu ketika server melaporkan bahwa informasi autentikasi Anda telah kedaluwarsa.

virtual void OnAuthInfoExpired() {};

Untuk tetap berada di saluran, buat token baru di server Anda. Kemudian, perbarui informasi autentikasi Anda sebagai berikut:

• Panggil LeaveChannel untuk meninggalkan saluran saat ini, lalu panggil JoinChannel untuk bergabung kembali ke saluran.

Pemicu

Panggilan balik ini dipicu ketika informasi autentikasi Anda kedaluwarsa.

Callback ini memberikan hasil dari proses bergabung ke dalam saluran. Callback ini setara dengan operasi blok dari metode JoinChannel. Keduanya menangani event setelah pengguna bergabung ke dalam saluran. Anda hanya perlu menggunakan salah satunya.

virtual void OnJoinChannelResult(int result, const char *channel, const char *userId, int elapsed) {}

Kondisi pemicu

Saat sebuah aplikasi memanggil metode JoinChannel, callback ini dipicu. Callback ini menunjukkan apakah pengguna berhasil bergabung ke dalam saluran dan mengembalikan informasi terkait proses bergabung tersebut, termasuk waktu yang berlalu.

Parameter

Callback untuk hasil meninggalkan saluran. Callback ini dikembalikan setelah Anda memanggil metode LeaveChannel. Jika Anda segera memanggil Destroy setelahnya, Anda tidak akan menerima callback ini.

virtual void OnLeaveChannelResult(int result, AliEngineStats stats) {}

Pemicu

Callback ini dipicu ketika aplikasi berhasil memanggil LeaveChannel untuk meninggalkan saluran. Callback ini mengembalikan hasil dari proses meninggalkan saluran dan statistik sesi saluran tersebut.

Parameter

Callback yang dipicu ketika pengguna jarak jauh offline.

virtual void OnRemoteUserOffLineNotify(const char *uid, AliEngineUserOfflineReason reason) {}

Callback ini memberi tahu pengguna lokal ketika pengguna jarak jauh offline karena alasan apa pun.

Pemicu

• Pengguna remote secara aktif meninggalkan saluran.

• Ketika streamer jarak jauh memanggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="03e45f655fcxx">SetClientRole</a> untuk beralih ke peran penonton (diatur ke AliEngineClientRoleLive), callback dipicu.

• Streamer jarak jauh dianggap offline karena periode inaktivitas data yang berkepanjangan.

Parameter

Callback ini memberi tahu klien lokal bahwa pengguna remote telah bergabung ke dalam saluran.

virtual void OnRemoteUserOnLineNotify(const char *uid, int elapsed) {}

Callback ini memberi tahu klien lokal bahwa pengguna remote telah bergabung ke saluran.

Kondisi pemicu

• Pengguna remote bergabung ke dalam saluran.

• Setelah pengguna lokal bergabung ke saluran, pemicu callback ini dijalankan untuk semua pengguna jarak jauh yang sudah berada di saluran tersebut. Hal ini menampilkan pengguna yang sebelumnya telah bergabung.

Parameter

Panggilan balik ini dipicu ketika aliran pengguna jarak jauh berubah.

virtual void OnRemoteTrackAvailableNotify(const char *uid,
                                                  AliEngineAudioTrack audioTrack,
                                                  AliEngineVideoTrack videoTrack) {}

Panggilan balik ini dipicu ketika status penerbitan aliran pengguna jarak jauh berubah. Panggilan balik ini memberikan informasi real-time mengenai apakah pengguna jarak jauh sedang menerbitkan aliran audio dan video. Gunakan informasi ini untuk menampilkan atau menyembunyikan audio dan video pengguna jarak jauh pada antarmuka pengguna.

Kondisi pemicu

Callback ini dipicu dalam skenario berikut:

• Pengguna jarak jauh mulai menerbitkan aliran (audio dan video).

• Pengguna jarak jauh berhenti menerbitkan aliran (audio dan video).

• Dalam mode interaktif, pengguna jarak jauh memanggil SetClientRole untuk mengganti perannya dari penonton menjadi host dan mulai menerbitkan aliran.

Contoh aliran video berikut menunjukkan kapan panggilan balik ini dipicu. Asumsikan pengguna jarak jauh awalnya tidak menerbitkan aliran video:

• Pengguna jarak jauh mulai menerbitkan aliran kamera (Status penerbitan: Tidak ada aliran video -> Hanya aliran kamera). Panggilan balik lokal mengembalikan AliEngineVideoTrackCamera, yang menunjukkan bahwa aliran kamera pengguna jarak jauh tersedia.

• Pengguna jarak jauh juga mulai menerbitkan aliran berbagi layar (Status penerbitan: Hanya aliran kamera -> Aliran kamera dan berbagi layar). Panggilan balik lokal mengembalikan AliEngineVideoTrackBoth, yang menunjukkan bahwa aliran kamera dan berbagi layar dari pengguna jarak jauh keduanya tersedia.

• Pengguna jarak jauh berhenti menerbitkan aliran kamera tetapi tetap menerbitkan aliran berbagi layar (Status penerbitan: Aliran kamera dan berbagi layar -> Hanya aliran berbagi layar). Panggilan balik lokal mengembalikan AliEngineVideoTrackScreen, yang menunjukkan bahwa hanya aliran berbagi layar yang saat ini tersedia.

• Pengguna jarak jauh kemudian berhenti menerbitkan aliran berbagi layar (Status penerbitan: Hanya aliran berbagi layar -> Tidak ada aliran video). Panggilan balik lokal mengembalikan AliEngineVideoTrackNo, yang menunjukkan bahwa tidak ada aliran video yang saat ini tersedia.

Parameter

Panggilan balik ini dipicu ketika Anda dihapus oleh server atau saluran ditutup.

virtual void OnBye(int code) {}

Panggilan balik ini dipicu ketika Anda terputus karena alasan apa pun atau saluran ditutup. Gunakan parameter code untuk menentukan alasan pemutusan koneksi dan merespons sesuai dengan itu.

Kondisi pemicu

• Anda dihapus oleh server.

• Saluran ditutup oleh server.

• Anda terputus secara tidak sukarela. Coba lanjutkan sesi atau sambungkan ulang.

Parameter

Callback untuk perubahan dalam status penerbitan audio.

virtual void OnAudioPublishStateChanged(AliEnginePublishState oldState, AliEnginePublishState newState, int elapseSinceLastState, const char *channel) {};

Callback ini dipicu ketika status penerbitan aliran audio lokal berubah.

Pemicu

Callback ini dipicu saat status penerbitan audio berubah. Misalnya:

• Penerbitan aliran dihentikan.

• Panggil <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="904fc4e83a35n">SetClientRole</a> untuk mengganti peran klien menjadi penonton.

Parameter

Callback untuk perubahan status langganan aliran audio.

virtual void OnAudioSubscribeStateChanged(const char *uid,
                                                  AliEngineSubscribeState oldState, 
                                                  AliEngineSubscribeState newState,
                                                  int elapseSinceLastState,
                                                  const char *channel) {};

Callback ini memberi tahu pengguna lokal bahwa status langganan aliran audio pengguna jarak jauh telah berubah. Callback ini menunjukkan status baru dan waktu yang berlalu sejak status sebelumnya.

Parameter

Notifikasi bahwa pengguna telah membisukan atau mengaktifkan kembali audio mereka.

virtual void OnUserAudioMuted(const char* uid, bool isMute) {}

Parameter

Mengatur volume ingest aliran audio eksternal.

virtual void OnUserAudioInterruptedBegin(const char* uid) {}

Parameter

Pemicu balik yang dijalankan ketika gangguan audio pengguna berakhir. Pemicu balik ini berkorespondensi dengan OnUserAudioInterruptedBegin.

virtual void OnUserAudioInterruptedEnded(const char* uid) {}

Parameter

Memberikan laporan perubahan pada status penerbitan aliran video.

virtual void OnVideoPublishStateChanged(AliEnginePublishState oldState, AliEnginePublishState newState, int elapseSinceLastState, const char *channel) {};

Callback ini memantau perubahan status penerbitan aliran video pengguna lokal.

Parameter

Callback yang dipanggil saat status langganan terhadap track kamera berubah.

virtual void OnVideoSubscribeStateChanged(const char *uid, 
                                                  AliEngineSubscribeState oldState, 
                                                  AliEngineSubscribeState newState,
                                                  int elapseSinceLastState,
                                                  const char *channel) {};

Callback ini memberi tahu pengguna lokal bahwa status langganan terhadap aliran kamera pengguna jarak jauh telah berubah. Callback ini menyediakan detail perubahan status langganan untuk pengguna jarak jauh tertentu serta interval waktu dari status sebelumnya ke status saat ini.

Callback Terkait

Aliran video terutama terdiri dari aliran kamera dan aliran berbagi layar. Antarmuka ini digunakan untuk perubahan status langganan aliran kamera, sedangkan antarmuka callback untuk aliran berbagi layar adalah OnScreenShareSubscribeStateChanged.

Parameter

Notifikasi bahwa video pengguna dimatikan (muted).

virtual void OnUserVideoMuted(const char* uid, bool isMute) {}

Parameter

Mendapatkan volume ingest aliran audio eksternal.

virtual void OnUserVideoEnabled(const char* uid, bool isEnable) {}

Parameter

Panggilan balik yang dipicu ketika aplikasi pengguna jarak jauh berpindah ke latar belakang.

virtual void OnUserWillResignActive(const char* uid) {}

Parameter

Mendapatkan volume pemutaran aliran audio eksternal.

virtual void OnUserWillBecomeActive(const char* uid) {}

Parameter