ApsaraVideo Live:Antarmuka AliRtcEngine

Membuat instans AliRtcEngine menggunakan pola singleton.

+ (instancetype _Nonnull )sharedInstance:(id<AliRtcEngineDelegate>_Nullable)delegate extras:(NSString *_Nullable)extras;

Kapan Harus Menghubungi

Panggil metode ini sebelum memanggil API SDK ARTC lainnya untuk membuat instans AliRtcEngine.

Batasan

• Metode ini bersifat sinkron dan harus dipanggil pada thread utama.

• SDK hanya mendukung satu instans AliRtcEngine per aplikasi.

Callback terkait

Implementasikan callback di AliRtcEngineDelegate sesuai kasus penggunaan Anda saat membuat instans engine. Jika SDK mengalami pengecualian selama operasi, SDK terlebih dahulu mencoba pemulihan internal secara otomatis. Untuk kesalahan yang tidak dapat diselesaikan secara internal, SDK memberi tahu aplikasi Anda melalui callback yang telah ditentukan. Berikut adalah callback utama yang memerlukan penanganan tingkat aplikasi:

Parameter

Menghancurkan instans AliRtcEngine.

+ (void)destroy;

Menghancurkan objek singleton AliRtcEngine. Setelah Anda memanggil metode ini, semua resource yang digunakan secara internal dilepas. Anda tidak dapat menggunakan metode atau callback AliRtcEngine lainnya. Untuk menggunakan AliRtcEngine lagi, Anda harus memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#2db21d4f16s77" id="96631a9306wq8">sharedInstance</a> untuk membuat instans baru.

Metode ini dan destroy[2/2] sama-sama menghancurkan instans engine, tetapi perbedaannya adalah destroy[2/2] memungkinkan Anda meneruskan objek monitor untuk penyelesaian penghancuran.

Waktu Menghubungi

Panggil metode ini untuk melepas instans setelah komunikasi real-time berakhir (yaitu, ketika Anda tidak lagi memerlukan fungsi AliRtcEngine). Hal ini mengurangi penggunaan resource yang tidak perlu.

Batasan

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

Menghancurkan instans AliRtcEngine.

+ (void)destroy:(id<AliRtcEngineDestroyDelegate>_Nullable)delegate;

Menghancurkan objek singleton AliRtcEngine. Setelah Anda memanggil metode ini, semua resource yang digunakan secara internal oleh objek dilepas. Anda tidak dapat menggunakan metode atau callback AliRtcEngine lainnya. Untuk menggunakan AliRtcEngine lagi, Anda harus memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#2db21d4f16s77" id="115fd691743nx">sharedInstance</a> untuk membuat instans baru.

Kapan harus memanggil

Kami menyarankan memanggil metode ini untuk melepas instans setelah menyelesaikan komunikasi real-time.

Batasan

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

Parameter

Menentukan apakah akan mengaktifkan mode kompatibilitas HTML5.

+ (void)setH5CompatibleMode:(BOOL)comp;

Parameter

Memeriksa apakah mode kompatibilitas HTML5 diaktifkan.

+ (BOOL)getH5CompatibleMode;

Deskripsi Pengembalian

Nilai YES menunjukkan bahwa mode kompatibilitas HTML5 diaktifkan. Nilai NO menunjukkan bahwa mode kompatibilitas HTML5 dinonaktifkan.

Mengambil nomor versi SDK.

+ (NSString *_Nonnull)getSdkVersion;

Nilai kembali

Nomor versi SDK saat ini sebagai string, misalnya: "2.5.0.x".

Catatan

Ini adalah metode statis. Anda dapat memanggilnya kapan saja untuk mengambil nomor versi.

Menetapkan mode channel.

- (int)setChannelProfile:(AliRtcChannelProfile)profile;

Metode ini menetapkan profil channel. Tersedia dua profil utama:

• Profil komunikasi: Semua pengguna bertindak sebagai streamer dan dapat menerbitkan serta berlangganan stream.

• Profil streaming langsung interaktif: Anda harus memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#892915dd4edcy" id="d88dccff391by">setClientRole</a> untuk menetapkan peran klien. Tetapkan peran pengguna yang mengingest stream di channel sebagai streamer (AliRTCSdkInteractive). Jika pengguna hanya perlu menarik stream dan tidak mengingest stream, tetapkan perannya sebagai viewer (AliRTCSdkLive). Profil ini direkomendasikan untuk skenario RTC.

Kapan dipanggil

Anda hanya dapat memanggil metode ini sebelum bergabung ke channel. Anda tidak dapat mengubah profil saat berada di channel. Anda dapat mengubahnya setelah meninggalkan channel.

Parameter

Deskripsi pengembalian

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

Menetapkan profil audio.

- (int)setAudioProfile:(AliRtcAudioProfile)audio_profile audio_scene:(AliRtcAudioScenario)audio_scene;

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

Kapan Harus Menelepon

Anda hanya dapat memanggil metode ini sebelum bergabung ke channel. Anda tidak dapat mengubahnya setelah bergabung. Anda dapat mengubahnya setelah meninggalkan channel.

Parameter

Deskripsi Pengembalian

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

Memeriksa apakah mode hanya audio diaktifkan.

- (BOOL)isAudioOnly;

Deskripsi pengembalian

Nilai YES menunjukkan bahwa mode hanya audio diaktifkan. Nilai NO menunjukkan bahwa mode audio-video diaktifkan.

Mengaktifkan mode hanya audio atau mode audio-video.

- (int)setAudioOnlyMode:(BOOL)audioOnly;

Parameter

Instruksi pengembalian

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

Bergabung ke channel (yaitu, bergabung ke rapat).

- (int)joinChannel:(NSString *_Nonnull)token channelId:(NSString *_Nullable)channelId userId:(NSString *_Nullable)userId name:(NSString *_Nullable)userName onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed))onResult;

Metode ini bergabung ke channel. ARTC mengorganisasi pengguna ke dalam channel. Pengguna harus bergabung ke channel untuk menerbitkan atau berlangganan stream audio dan video. Metode ini, bersama dengan joinChannel[2/3] dan joinChannel[3/3], dapat digunakan untuk bergabung ke channel. Perbedaannya terletak pada metode autentikasi dan informasi pengguna yang diteruskan:

• Ini adalah metode bergabung parameter tunggal. Teruskan token yang dihasilkan menggunakan Autentikasi Token. Kami merekomendasikan metode ini untuk skenario RTC.

• joinChannel[2/3] adalah metode bergabung parameter ganda. Teruskan token yang dihasilkan menggunakan Autentikasi Token, dan juga teruskan informasi pengguna yang digunakan untuk menghasilkan token.

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

Kapan Harus Menghubungi

Panggil metode ini setelah membuat instans engine.

Batasan

• Setelah berhasil bergabung ke channel, untuk bergabung ke channel lain di tengah sesi, Anda harus terlebih dahulu memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="37299758eavvg">leaveChannel</a> untuk meninggalkan channel saat ini dan memastikan bahwa Anda menerima callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="50039f328fdk7">onLeaveChannelResult</a> sebelum bergabung ke channel lagi.

• Metode ini hanya mendukung bergabung ke satu channel sekaligus.

• Aplikasi dengan App ID berbeda tidak dapat berinteroperasi.

• Tidak perlu memanggil metode ini ketika mencoba ulang setelah kegagalan bergabung.

Callback terkait

Setelah berhasil memanggil metode ini, callback berikut dipicu:

• Hasil klien lokal bergabung ke channel dilaporkan melalui callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6d2a213d7sl2" id="903005c54be4d">onJoinChannelResult</a>.

• Setelah Anda berhasil bergabung ke channel, sisi remote memicu callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#634626babfq9x" id="4b11b846b1f4t">onRemoteUserOnLineNotify</a>.

Parameter

Deskripsi Pengembalian

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

Bergabung ke channel, yaitu sesi multipartisipan.

- (int)joinChannel:(AliRtcAuthInfo *_Nonnull)authInfo name:(NSString *_Nullable)userName onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed))onResult;

Metode ini bergabung ke channel. ARTC mengorganisasi pengguna ke dalam channel. Pengguna harus bergabung ke channel untuk menerbitkan atau berlangganan stream audio dan video. Metode ini, bersama dengan joinChannel[1/3] dan joinChannel[3/3], dapat digunakan untuk bergabung ke channel. Perbedaannya terletak pada metode autentikasi dan informasi pengguna yang diteruskan:

• joinChannel[1/3] adalah metode bergabung parameter tunggal. Teruskan token yang dihasilkan menggunakan Autentikasi Token. Kami merekomendasikan metode ini untuk skenario RTC.

• Ini adalah metode bergabung parameter ganda. Teruskan token yang dihasilkan menggunakan Autentikasi Token, dan juga teruskan informasi pengguna yang digunakan untuk menghasilkan token.

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

Batasan

• Untuk beralih channel setelah bergabung ke satu, Anda harus terlebih dahulu memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="4283c6cc013bz">leaveChannel</a> untuk meninggalkan channel saat ini. Anda hanya dapat bergabung ke channel baru setelah menerima callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="9e6478b2f0hen">onLeaveChannelResult</a>.

• Metode ini hanya mendukung bergabung ke satu channel sekaligus.

• Aplikasi dengan App ID berbeda tidak dapat berinteroperasi.

Callback terkait

Setelah berhasil memanggil metode ini, callback berikut dipicu:

• Callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6d2a213d7sl2" id="df00346ea8928">onJoinChannelResult</a> mengembalikan hasil pengguna lokal bergabung ke channel.

• Setelah Anda berhasil bergabung ke channel, pengguna remote memicu callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#634626babfq9x" id="c3832e71e8vck">onRemoteUserOnLineNotify</a>.

Parameter

Bergabung ke channel.

- (int)joinChannel:(NSString *_Nonnull)token channelParam:(AliRtcChannelParam *_Nonnull)channelParam onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed))onResult;

Metode ini bergabung ke channel. ARTC mengorganisasi pengguna ke dalam channel. Pengguna harus bergabung ke channel untuk menerbitkan atau berlangganan stream audio dan video. Metode ini, bersama dengan joinChannel[1/3] dan joinChannel[2/3], dapat digunakan untuk bergabung ke channel. Perbedaannya terletak pada metode autentikasi dan informasi pengguna yang diteruskan:

• joinChannel[1/3] adalah metode bergabung parameter tunggal untuk skenario RTC. Teruskan token yang dihasilkan menggunakan Autentikasi Token. Kami merekomendasikan metode ini untuk skenario RTC.

• joinChannel[2/3] adalah metode bergabung parameter ganda. Teruskan token yang dihasilkan menggunakan Autentikasi Token, dan juga teruskan informasi pengguna yang digunakan untuk menghasilkan token.

• Metode ini ditujukan untuk skenario interaksi real-time AI. Teruskan token parameter tunggal dan atur properti pengguna capabilityProfile. Saat berkomunikasi dengan agen AI, atur ini ke AliRtcCapabilityProfileAiHuman.

Batasan

• Setelah Anda berhasil bergabung ke channel, untuk bergabung ke channel lain, Anda harus terlebih dahulu memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="923190466431o">leaveChannel</a> untuk meninggalkan channel saat ini dan memastikan bahwa Anda menerima callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="dfd794c32covq">onLeaveChannelResult</a> sebelum Anda dapat bergabung ke channel lain.

• Metode ini hanya mendukung bergabung ke satu channel sekaligus.

• Aplikasi dengan App ID berbeda tidak dapat berinteroperasi.

• Tidak perlu memanggil metode ini ketika mencoba ulang setelah kegagalan bergabung.

Callback terkait

Setelah berhasil memanggil metode ini, callback berikut dipicu:

• Hasil pengguna lokal bergabung ke channel dikembalikan oleh callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6d2a213d7sl2" id="f83d0aff9btwh">onJoinChannelResult</a>.

• Setelah Anda berhasil bergabung ke channel, pengguna remote memicu callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#634626babfq9x" id="aeef817be3a0b">onRemoteUserOnLineNotify</a>.

Parameter

Meninggalkan channel.

- (int)leaveChannel;

Setelah memanggil metode ini, SDK menghentikan komunikasi real-time dan meninggalkan channel saat ini.

Kapan Harus Menghubungi

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

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

Callback terkait

• Pengguna lokal: Setelah metode ini dipanggil, callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="ea2e36a41csu0">onLeaveChannelResult</a> dipicu untuk melaporkan hasil meninggalkan channel.

• Sisi remote: Setelah Anda berhasil memanggil operasi ini, pengguna remote memicu callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#34876c27d7zv7" id="a50f534f21mew">onRemoteUserOffLineNotify</a>.

Deskripsi pengembalian

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

Memeriksa apakah Anda berada di channel.

- (BOOL)isInCall;

Deskripsi pengembalian

Nilai YES menunjukkan bahwa Anda berada di channel. Nilai NO menunjukkan bahwa Anda tidak berada di channel.

Menentukan peran pengguna.

- (int)setClientRole:(AliRtcClientRole)role;

Metode ini menetapkan peran pengguna sebagai streamer atau viewer.

Dalam mode interaktif, sebelum bergabung ke channel:

• Tetapkan peran pengguna sebagai streamer: SDK secara otomatis menerbitkan stream audio dan video lokal serta berlangganan ke stream pengguna streamer lainnya.

• Tetapkan peran pengguna sebagai viewer: SDK tidak menerbitkan stream audio atau video lokal, tetapi berlangganan ke stream pengguna streamer lainnya.

Kapan dipanggil

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

Batasan

Metode ini hanya berlaku dalam mode interaktif, yaitu ketika Anda memanggil metode <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#fc9626a99f5kj" id="cd8138c77fv4r">setChannelProfile</a> dan menetapkan profil channel ke AliRtcInteractivelive.

Kami merekomendasikan menetapkan peran pengguna secara eksplisit sebelum bergabung dalam mode interaktif.

Parameter

Deskripsi Pengembalian

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

Memeriksa peran pengguna. Metode ini hanya berlaku untuk iOS.

- (AliRtcClientRole)getCurrentClientRole;

Nilai Kembali

Peran pengguna dikembalikan.

Memperbarui informasi autentikasi.

- (int)refreshAuthInfo:(AliRtcAuthInfo *_Nonnull)authInfo;

Metode ini memperbarui informasi autentikasi. Token kedaluwarsa setelah periode tertentu, dan SDK akan gagal terhubung ke server setelah kedaluwarsa.

Kapan harus memanggil

Dalam kasus berikut:

• Ketika Anda menerima callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6766cdfb40z1a" id="c1cc6cbddb22o">onAuthInfoWillExpire</a> yang menunjukkan bahwa informasi autentikasi Anda akan segera kedaluwarsa, kami merekomendasikan agar 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="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#b04cd67880ptu" id="13c9ccb2b6ghh">onAuthInfoExpired</a> dipicu untuk menunjukkan bahwa autentikasi telah kedaluwarsa. Pada titik ini, Anda harus membuat ulang token dan kemudian memanggil joinChannel untuk bergabung kembali ke channel.

Parameter

Deskripsi pengembalian

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

Memperbarui informasi autentikasi.

- (int)refreshAuthInfoWithToken:(NSString *_Nonnull)token;

Metode ini memperbarui token. Token kedaluwarsa setelah periode tertentu, dan SDK akan gagal terhubung ke server setelah kedaluwarsa.

Kapan Harus Menghubungi

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

Ketika Anda menerima callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6766cdfb40z1a" id="b1dbfcb71d5ys">onAuthInfoWillExpire</a> yang melaporkan bahwa informasi autentikasi akan segera kedaluwarsa.

Parameter

Deskripsi pengembalian

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

Menentukan apakah akan menerbitkan track audio.

- (int)publishLocalAudioStream:(BOOL)enable;

Metode ini mengontrol apakah akan menerbitkan audio yang diambil secara lokal. Secara default, SDK menerbitkan audio. Jika Anda tidak ingin menerbitkan audio secara default, panggil publishLocalAudioStream(false) sebelum bergabung ke channel.

Kapan Harus Menelepon

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

Callback terkait

Ketika status ingest stream audio lokal berubah, klien lokal memicu callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#86b2d8735bm71" id="e5ef180ba6e2i">onAudioPublishStateChanged</a> untuk melaporkan status ingest terbaru, dan klien remote memicu callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6da9cf330aoer" id="299ef35806ttb">onRemoteTrackAvailableNotify</a> untuk melaporkan perubahan pada stream audio dan video pengguna remote.

Parameter

Deskripsi Pengembalian

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

Memeriksa apakah track audio diterbitkan.

- (BOOL)isLocalAudioStreamPublished;

Deskripsi Pengembalian

YES menunjukkan bahwa push diizinkan. NO menunjukkan bahwa push tidak diizinkan.

Menetapkan perilaku default untuk menerima stream audio.

- (int)setDefaultSubscribeAllRemoteAudioStreams:(BOOL)sub;

Metode ini mengonfigurasi apakah sistem berlangganan ke track audio pengguna remote secara default. Pengaturan ini memengaruhi perilaku langganan untuk pengguna yang bergabung ke channel nanti. Kecuali Anda memiliki persyaratan khusus, atur ini ke true.

Kapan Harus Menghubungi

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

• Sebelum bergabung:

  • SDK berlangganan ke track audio pengguna remote secara default ketika bergabung ke channel. Untuk mengubah perilaku ini, panggil metode ini sebelum bergabung.

• Setelah bergabung:

  • Jika Anda ingin menghentikan langganan default, Anda dapat memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#8b515d9855osk" id="a467e60e4eyhk">setDefaultSubscribeAllRemoteAudioStreams</a>(false). Sistem tidak akan berlangganan ke stream audio dari pengguna yang bergabung ke channel nanti.

  • Setelah Anda menghentikan langganan default, jika Anda ingin melanjutkan berlangganan ke stream audio pengguna tertentu, panggil API <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#c8249fb568gms" id="9806dd9a750pf">subscribeRemoteAudioStream</a>. Jika Anda ingin melanjutkan berlangganan untuk beberapa pengguna, panggil beberapa kali.

  • Setelah Anda menghentikan langganan default, memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#8b515d9855osk" id="9507d6d3121uh">setDefaultSubscribeAllRemoteAudioStreams</a>(true) hanya melanjutkan stream audio pengguna yang bergabung ke channel setelahnya, dan tidak berlangganan ke stream audio pengguna remote yang telah bergabung saat langganan dihentikan.

Parameter

Deskripsi Pengembalian

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

Berlangganan atau berhenti berlangganan track audio pengguna remote tertentu.

- (int)subscribeRemoteAudioStream:(NSString *_Nonnull)uid sub:(BOOL)sub;

Gunakan antarmuka ini untuk menghentikan atau melanjutkan stream audio dari pengguna remote tertentu. Untuk sebagian besar skenario, atur parameter ini ke true.

Parameter

Deskripsi Pengembalian

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

Berlangganan atau berhenti berlangganan track audio semua pengguna remote.

- (int)subscribeAllRemoteAudioStreams:(BOOL)sub;

Metode ini adalah sakelar utama untuk berlangganan ke track audio remote. Kami merekomendasikan menyetelnya ke YES. Menyetelnya ke NO menyebabkan hal berikut:

• Track audio remote di sesi saat ini tidak lagi berlangganan.

• Pengguna baru yang bergabung nanti tidak berlangganan.

• Anda tidak dapat menggunakan <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#c8249fb568gms" id="846b0dd501epf">subscribeRemoteAudioStream</a> untuk mengontrol secara individual stream audio pengguna tertentu.

Untuk melanjutkan langganan, panggil metode ini lagi dengan parameter sub diatur ke YES.

Parameter

Deskripsi Pengembalian

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

Menentukan apakah akan menerbitkan track video.

- (int)publishLocalVideoStream:(BOOL)enable;

Metode ini mengontrol penerbitan video yang diambil secara lokal.

Kapan Harus Menelepon

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

Jika Anda memanggil metode ini sebelum bergabung ke channel, metode ini memodifikasi konfigurasi default, dan pengaturan tersebut berlaku ketika Anda bergabung ke channel.

Callback terkait

Ketika status pengambilan aliran audio lokal berubah, klien lokal memicu callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#bd67711e63tnk" id="f966292202q3d">onVideoPublishStateChanged</a> untuk melaporkan status terbaru pengambilan aliran audio. Sementara itu, klien jarak jauh memicu callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6da9cf330aoer" id="2fdc208ccczr1">onRemoteTrackAvailableNotify</a> untuk melaporkan perubahan pada aliran audio dan video pengguna jarak jauh.

Parameter

Memeriksa apakah track video diterbitkan.

- (BOOL)isLocalVideoStreamPublished;

Deskripsi pengembalian

Nilai YES menunjukkan bahwa track video diterbitkan. Nilai NO menunjukkan bahwa track video tidak diterbitkan.

Anda dapat menetapkan apakah menerima stream video secara default.

- (int)setDefaultSubscribeAllRemoteVideoStreams:(BOOL)sub;

Secara default, SDK berlangganan ke track video pengguna remote. Gunakan metode ini untuk mengubah perilaku tersebut.

Kapan Harus Menghubungi

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

• Sebelum bergabung:

  • Anda dapat menggunakan metode ini untuk menonaktifkan langganan default.

• Setelah bergabung:

  • Untuk menonaktifkan langganan bawaan, panggil setDefaultSubscribeAllRemoteVideoStreams(false). Setelah itu, Anda tidak akan lagi secara otomatis berlangganan aliran audio pengguna yang bergabung ke saluran.

  • Setelah menghentikan langganan default, Anda dapat memanggil antarmuka subscribeRemoteVideoStream untuk melanjutkan langganan aliran audio pengguna tertentu. Untuk melanjutkan langganan beberapa pengguna, panggil antarmuka ini satu kali untuk setiap pengguna.

  • Setelah Anda menghentikan langganan default, pemanggilan setDefaultSubscribeAllRemoteVideoStreams(false) hanya akan memulihkan aliran audio untuk pengguna yang bergabung ke saluran setelahnya.

Parameter

Deskripsi Pengembalian

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

Hentikan atau lanjutkan berlangganan ke stream video dari pengguna remote.

- (int)subscribeRemoteVideoStream:(NSString *_Nonnull)uid track:(AliRtcVideoTrack)track sub:(BOOL)sub;

Anda dapat berlangganan atau berhenti berlangganan stream video pengguna tertentu.

Kapan Harus Memanggil

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

Deskripsi

Berlangganan atau berhenti berlangganan track video semua pengguna remote.

- (int)subscribeAllRemoteVideoStreams:(BOOL)sub;

Metode ini berfungsi sebagai sakelar utama untuk berlangganan ke stream video remote. Menyetel sub ke false menyebabkan:

• Semua stream video remote di sesi saat ini berhenti berlangganan.

• Pengguna baru yang bergabung nanti tidak akan berlangganan juga (bahkan jika pengaturan langganan default <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#a975297480yoj" id="0464849a17dks">setDefaultSubscribeAllRemoteVideoStreams</a> diaktifkan).

• Anda tidak dapat menggunakan <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#1cc7ef76fdawz" id="498e782f414zz">subscribeRemoteVideoStream</a> untuk mengontrol aliran audio secara individual untuk pengguna tertentu.

Untuk melanjutkan langganan, panggil metode ini lagi dengan sub diatur ke true.

Parameter

Deskripsi pengembalian

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

Hentikan atau lanjutkan stream media dari pengguna remote tertentu.

- (int)subscribeRemoteMediaStream:(NSString *_Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack subVideo:(BOOL)subVideo subAudio:(BOOL)subAudio;

Antarmuka ini menggabungkan stream audio dan video remote yang berlangganan.

Related API operations

Tidak seperti subscribeRemoteMediaStream[2/2], antarmuka ini menggunakan dua parameter Boolean—subVideo dan subAudio—untuk mengontrol apakah berlangganan ke stream video dan audio remote, dan parameter videoTrack menentukan stream video mana yang akan ditarik.

Catatan: Dalam API ini, AliRtcVideoTrackNo dari AliRtcVideoTrack tidak valid, dan menyetelnya tidak berpengaruh.

Parameter

Deskripsi respons

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

Anda dapat menghentikan atau melanjutkan stream media dari pengguna remote tertentu.

- (int)subscribeRemoteMediaStream:(NSString *_Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack audioTrack:(AliRtcAudioTrack)audioTrack;

Antarmuka ini menggabungkan stream audio dan video remote yang berlangganan.

API Terkait

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

• Untuk berlangganan ke stream kamera dan mikrofon, atur videoTrack ke AliRtcVideoTrackCamera dan audioTrack ke AliRtcAudioTrackMic saat Anda memanggil metode tersebut.

• Jika Anda ingin berhenti berlangganan dari stream kamera tetapi tetap menggunakan mikrofon, atur AliRtcVideoTrackNo dan AliRtcAudioTrackMic ke parameter videoTrack dan audioTrack masing-masing saat Anda memanggil metode tersebut lagi.

• Jika Anda ingin membatalkan semua track, atur videoTrack dan audioTrack ke AliRtcVideoTrackNo dan AliRtcAudioTrackNo masing-masing saat Anda memanggilnya lagi.

• Untuk berlangganan ke stream kamera dan berbagi layar, atur videoTrack ke AliRtcVideoTrackBoth. Audio bekerja dengan cara yang sama.

Parameter

Deskripsi pengembalian

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Berlangganan atau berhenti berlangganan stream media pengguna remote tertentu lintas channel.

- (int)subscribeRemoteDestChannelStream:(NSString *_Nonnull)channelId uid:(NSString *_Nonnull)uid track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

Parameter

Deskripsi Pengembalian

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

Berlangganan ke semua stream pengguna di channel target.

- (int)subscribeRemoteDestChannelAllStream:(NSString *_Nonnull)channelId track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

Parameter

Nilai kembali

0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Anda dapat mengatur volume audio remote.

- (int)setRemoteAudioVolume:(NSString *_Nonnull)uid volume:(NSInteger)volume;

Parameter

Nilai kembali

Nilai 0 menunjukkan keberhasilan. Nilai non-nol menunjukkan kegagalan.

Hentikan atau lanjutkan transmisi data audio lokal.

- (int)muteLocalMic:(BOOL)mute mode:(AliRtcMuteLocalAudioMode)mode;

Kapan harus memanggil

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

Callback terkait

Setelah panggilan berhasil, pengguna remote memicu callback <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3189c59d9fipb" id="1579c3523779c">onUserAudioMuted</a> untuk menunjukkan apakah pengguna dibisukan.

Parameter

Nilai kembali

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

Anda dapat menghentikan atau melanjutkan pemutaran audio remote.

- (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;- (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;- (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;

API ini menghentikan atau melanjutkan pemutaran audio dari pengguna remote tertentu tetapi tidak memengaruhi penarikan atau decoding stream audio remote. Untuk berhenti berlangganan dari stream audio pengguna, panggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#c8249fb568gms" id="dd9dbbad0bkni">subscribeRemoteAudioStream</a>.

Kapan Harus Menghubungi

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

Parameter

Deskripsi Pengembalian

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

Anda dapat menghentikan atau melanjutkan semua pemutaran audio remote.

- (int)muteAllRemoteAudioPlaying:(BOOL)mute;

API ini menghentikan atau melanjutkan pemutaran semua audio remote.

Kapan dipanggil

Anda dapat mengonfigurasi pengaturan ini sebelum atau setelah bergabung ke channel.

Parameter

Deskripsi Pengembalian

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

Memulai pengumpulan audio.

- (void)startAudioCapture;

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

Kapan Harus Menghubungi

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

Metode terkait

API startAudioCapture[2/2] mengontrol apakah perangkat pengambilan audio tetap aktif setelah Anda meninggalkan rapat, berdasarkan parameter yang ditentukan.

Callback terkait

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

Deskripsi pengembalian

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

Memulai pengumpulan audio.

- (void)startAudioCapture:(BOOL)keepAlive;

Menonaktifkan pengambilan mikrofon setelah dibisukan.

Metode ini memulai pengambilan audio. Anda dapat memanggilnya sebelum bergabung ke channel untuk memulai pengambilan audio lebih awal. Jika Anda tidak memanggil metode ini, SDK secara otomatis mengelola perangkat pengambilan audio.

Kapan harus memanggil

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

Metode terkait

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

Callback terkait

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

Parameter

Deskripsi pengembalian

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

Menghentikan pengumpulan audio.

- (void)stopAudioCapture;

Setelah Anda memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3103c368bexf8" id="ddef64f9b93zq">startAudioCapture</a> untuk mengaktifkan pengambilan audio dari perangkat audio, Anda dapat memanggil metode ini untuk menghentikan pengambilan audio.

Callback terkait

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

Deskripsi pengembalian

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

Menetapkan headset atau speaker sebagai perangkat output audio. Metode ini hanya berlaku untuk iOS.

- (int)enableSpeakerphone:(BOOL)enable;

Metode ini menetapkan perangkat pemutaran audio menjadi speaker atau headset setelah Anda bergabung ke channel. Jika Anda tidak memanggil metode ini, SDK menggunakan rute audio default.

SDK mendefinisikan urutan prioritas internal untuk routing audio dan beralih secara otomatis berdasarkan periferal yang terhubung: Wired headset > Bluetooth headset > User setting > Default setting. Oleh karena itu, metode ini tidak berpengaruh ketika periferal terhubung. Untuk informasi lebih lanjut, lihat Pengaturan routing audio.

Kapan Harus Menghubungi

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

Metode terkait

Metode <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#83be8cc066qqq" id="f8de149ef8so0">setDefaultAudioRoutetoSpeakerphone</a> memodifikasi pengaturan routing audio default dan menetapkan perangkat output audio saat ini.

Parameter

Deskripsi Pengembalian

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

Memeriksa apakah perangkat output audio saat ini adalah headset atau speaker. Metode ini hanya berlaku untuk iOS.

- (BOOL)isEnableSpeakerphone;

Deskripsi Pengembalian

Nilai YES menunjukkan bahwa perangkat output audio saat ini adalah speaker. Nilai NO menunjukkan bahwa perangkat output audio saat ini adalah headset.

Tetapkan interval callback volume dan faktor penghalusan.

- (int)enableAudioVolumeIndication:(NSInteger)interval smooth:(NSInteger)smooth reportVad:(NSInteger)reportVad;

Metode ini mengaktifkan SDK untuk secara berkala melaporkan informasi volume untuk pengguna lokal yang menerbitkan dan pengguna remote dengan volume instan tertinggi.

Kapan Harus Menghubungi

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

Callback terkait

Setelah Anda berhasil memanggil metode ini, jika ada pengguna yang menerbitkan di channel, SDK memicu callback berikut pada interval yang dikonfigurasi:

• SDK melaporkan volume untuk pengguna yang berbicara melalui callback onAudioVolumeCallback. Frekuensi callback bergantung pada parameter interval.

• Untuk deteksi aktivitas suara, ketika pembicara aktif terdeteksi, SDK melaporkan UID mereka melalui callback onActiveSpeaker.

Parameter

Nilai kembali

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

Anda dapat mengaktifkan pemantauan in-ear.

- (int)enableEarBack:(BOOL)enable;

Metode ini mengaktifkan atau menonaktifkan pemantauan in-ear. Untuk hasil optimal, kami merekomendasikan mengaktifkan pemantauan in-ear ketika menggunakan headphone kabel atau Bluetooth.

Kapan dipanggil

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

Deskripsi Parameter

Deskripsi pengembalian

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

Mengatur volume pemantauan in-ear.

- (int)setEarBackVolume:(NSInteger)volume;

Antarmuka ini mengatur volume pemantauan in-ear. Antarmuka ini baru berlaku setelah Anda mengaktifkan pemantauan in-ear dengan memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#bd665d0f894ux" id="b0fa866c9bcuq">enableEarBack</a>.

Kapan dipanggil

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

Parameter

Deskripsi pengembalian

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

Memulai pemutaran audio.

- (void)startAudioPlayer;

Menghentikan pemutaran audio.

- (void)stopAudioPlayer;

Menetapkan volume pemutaran.

- (int)setPlayoutVolume:(NSInteger)volume;

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan, sedangkan nilai lainnya menunjukkan kegagalan.

Menetapkan volume rekaman.

- (int)setRecordingVolume:(NSInteger)volume;

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Memutar file audio.

- (int)playAudioFileTest:(NSString *_Nonnull)filePath;

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan pemutaran file audio.

- (int)stopAudioFileTest;

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Aktifkan deteksi perangkat pengambilan audio sebelum panggilan.

- (void)startAudioCaptureTest;

Deteksi perangkat pengumpulan audio sebelum mengakhiri panggilan.

- (void)stopAudioCaptureTest;

Menetapkan rute audio default ke speaker. Secara default, audio diputar melalui speaker.

- (int)setDefaultAudioRouteToSpeakerphone:(BOOL)defaultToSpeakerphone;

Metode ini mengonfigurasi perangkat rute audio default sebelum Anda bergabung ke channel. Anda dapat mengarahkan audio ke headset atau speaker. SDK menggunakan speaker secara default. Untuk mengubah perilaku ini, panggil metode ini sebelum bergabung ke channel.

SDK mendefinisikan urutan prioritas tetap untuk routing audio dan melakukan alih otomatis berdasarkan status koneksi periferal saat ini. Urutan prioritas adalah sebagai berikut: wired headset > Bluetooth headset > user settings > default settings. Oleh karena itu, jika tidak ada periferal yang terhubung dan Anda belum mengonfigurasi routing audio melalui <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#f7d0d8b64fzkz" id="30798b686b5qk">enableSpeakerphone</a>, SDK menerapkan pengaturan default.

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

Perangkat seluler biasanya mendukung dua rute audio: headset dan speaker:

• Ketika menggunakan headset, suara lebih pelan dan memerlukan pegangan ponsel dekat telinga Anda. Ini memberikan privasi yang lebih baik dan cocok untuk panggilan telepon.

• Ketika menggunakan speaker, suara lebih keras dan dapat didengar tanpa memegang ponsel ke telinga Anda. Ini memungkinkan operasi hands-free.

Metode terkait

API ini memodifikasi pengaturan routing audio default. API <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#f7d0d8b64fzkz" id="6001aa98ebapw">enableSpeakerphone</a> menetapkan perangkat routing audio saat ini.

Kapan dipanggil

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

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menetapkan mode perubahan suara.

- (int)setAudioEffectVoiceChangerMode:(AliRtcAudioEffectVoiceChangerMode)mode;

Parameter

Deskripsi Pengembalian

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

Menetapkan pitch audio.

- (int)setAudioEffectPitchValue:(double)value;

Parameter

Deskripsi Pengembalian

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

Menetapkan mode gema.

- (int)setAudioEffectReverbMode:(AliRtcAudioEffectReverbMode)mode;

Parameter

Deskripsi respons

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

Anda dapat menetapkan jenis efek gema dan parameter spesifik.

- (int)setAudioEffectReverbParamType:(AliRtcAudioEffectReverbParamType)type value:(float)value;

Parameter

Deskripsi pengembalian

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

Menetapkan mode efek pemercantik suara yang telah ditentukan sebelumnya.

- (int)setAudioEffectBeautifyMode:(AliRtcAudioEffectBeautifyMode)mode;

Metode ini mengonfigurasi mode pemercantik suara bawaan di SDK. Cocok untuk skenario seperti streaming langsung suara, karaoke, dan aplikasi sosial berbasis suara di mana peningkatan kualitas suara diperlukan. Memilih mode pemercantik yang berbeda mengubah karakteristik vokal yang dirasakan—misalnya, meningkatkan kekayaan atau kejernihan—untuk meningkatkan pengalaman mendengar bagi pengguna remote.

Kapan Harus Menghubungi

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

Parameter

Deskripsi Pengembalian

• 0: Berhasil.

• Bukan nol: Gagal.

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

- (int)setAudioEffectEqualizationParam:(AliRtcAudioEffectEqualizationBandFrequency)bandIndex gain:(float)gain;

Metode ini menerapkan penyesuaian equalizer grafis ke sinyal suara atau audio yang diambil secara lokal. Anda dapat menyesuaikan gain dalam desibel (dB) untuk sepuluh pita frekuensi tetap guna menyesuaikan kualitas nada. Metode ini cocok untuk mengoptimalkan kejernihan ucapan, meningkatkan kualitas suara, dan mengurangi noise.

Equalizer mendukung penyesuaian spektrum penuh dari 31 Hz hingga 16 kHz di sepuluh pita frekuensi standar. Gain untuk setiap pita dapat disesuaikan secara independen dari -15 dB hingga 15 dB. Gain default adalah 0 dB, yang menunjukkan tidak ada penguatan atau redaman.

Batasan

• Anda harus mengaktifkan pemercantik suara dengan memanggil setAudioEffectBeautifyMode sebelum menggunakan equalizer.

Parameter

Deskripsi pengembalian

0: Berhasil.

Bukan nol: Gagal.

Menambahkan track audio eksternal.

- (int)addExternalAudioStream:(AliRtcExternalAudioStreamConfig *_Nonnull)config;

Untuk menambahkan stream audio eksternal, ikuti langkah-langkah berikut:

1. Panggil antarmuka <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#d71bbfd2f242b" id="c310321e9eu35">addExternalAudioStream</a> untuk menambahkan stream audio eksternal dan mengambil ID-nya.

2. Panggil pushExternalAudioStream untuk memasukkan data audio ke dalam stream.

3. Ketika panggilan berakhir, panggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#282d70095duaw" id="16f621608d94x">removeExternalAudioStream</a> untuk menghapus stream audio eksternal.

Untuk menerbitkan audio yang diambil secara kustom di channel, lihat Pengambilan audio kustom.

Parameter

Deskripsi pengembalian

Nilai lebih besar dari 0 menunjukkan bahwa panggilan berhasil dan merupakan ID track audio eksternal. Nilai kurang dari atau sama dengan 0 menunjukkan bahwa panggilan gagal.

Mengimpor data audio eksternal.

- (int)pushExternalAudioStream:(int)streamId rawData:(AliRtcAudioFrame * _Nonnull)audioFrame;

Metode ini memasukkan data audio ke stream yang ditentukan. Ikuti langkah-langkah berikut:

1. Panggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#d71bbfd2f242b" id="0a353f7272shu">addExternalAudioStream</a> untuk menambahkan stream audio eksternal dan mendapatkan ID stream audio eksternal.

2. Panggil metode ini untuk memasukkan data audio ke dalam stream yang dibuat.

3. Ketika panggilan berakhir, Anda perlu memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#282d70095duaw" id="a9ebc8d599dz4">removeExternalAudioStream</a> untuk menghapus stream audio eksternal.

Untuk menerbitkan audio yang diambil secara kustom di channel, lihat Pengambilan audio kustom.

Parameter

Deskripsi Pengembalian

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

Atur volume untuk ingest stream audio eksternal.

- (int)setExternalAudioStream:(int)streamId
                publishVolume:(int)publishVolume;

Parameter

Deskripsi Pengembalian

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

Memeriksa volume audio eksternal untuk ingest stream.

- (int)getExternalAudioStreamPublishVolume:(int)streamId;

Parameter

Deskripsi Pengembalian

Nilai volume yang valid berkisar dari 0 hingga 100. Nilai kurang dari 0 menunjukkan bahwa panggilan gagal.

Menetapkan volume pemutaran audio eksternal.

- (int)setExternalAudioStream:(int)streamId
                playoutVolume:(int)playoutVolume;

Parameter

Deskripsi pengembalian

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

Memeriksa volume pemutaran audio eksternal.

- (int)getExternalAudioStreamPlayoutVolume:(int)streamId;

Parameter

Deskripsi respons

Nilai volume yang valid berkisar dari 0 hingga 100. Nilai kurang dari 0 menunjukkan bahwa panggilan gagal.

Hapus stream eksternal (audio).

- (int)removeExternalAudioStream:(int)streamId;

Metode ini menghapus stream audio eksternal untuk streamId yang ditentukan dan merupakan pasangan dari metode addExternalAudioStream.

Kapan Harus Menghubungi

Untuk menggunakan fitur input audio kustom, panggil metode addExternalAudioStream untuk menambahkan stream audio dan mendapatkan ID stream audio eksternal, lalu panggil antarmuka pushExternalAudioStream untuk mendorong data audio Anda ke SDK. Ketika Anda ingin menghentikan input audio kustom, panggil metode yang sesuai untuk menghapus stream audio eksternal dan melepaskan resource.

Parameter

Nilai kembali

0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Mengambil informasi file audio.

- (int)getAudioFileInfo:(NSString *_Nonnull)filePath;

Parameter

Anda dapat memulai pencampuran akompanimen.

- (int)startAudioAccompanyWithFile:(NSString *_Nonnull)filePath config:(AliRtcAudioAccompanyConfig *_Nonnull)config;

Parameter

Nilai kembali

0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan pencampuran akompanimen audio.

- (int)stopAudioAccompany;

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Atur volume akompanimen.

- (int)setAudioAccompanyVolume:(NSInteger)volume;

Parameter

Nilai kembali

0 berhasil; sisanya gagal.

Menetapkan volume penerbitan akompanimen audio.

- (int)setAudioAccompanyPublishVolume:(NSInteger)volume;

Parameter

Nilai kembali

Mengembalikan 0 pada keberhasilan. Kode kesalahan dikembalikan pada kegagalan.

Anda dapat mengambil tingkat volume untuk menerbitkan akompanimen audio.

- (int)getAudioAccompanyPublishVolume;

Nilai kembali

Nilai dalam rentang [0, 100] menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menetapkan volume pemutaran lokal untuk akompanimen.

- (int)setAudioAccompanyPlayoutVolume:(NSInteger)volume;

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Anda dapat mengambil volume pemutaran lokal akompanimen.

- (int)getAudioAccompanyPlayoutVolume;

Nilai kembali

Nilai dalam rentang 0 hingga 100 menunjukkan keberhasilan, sedangkan nilai lainnya menunjukkan kegagalan.

Jeda pencampuran akompanimen audio.

- (int)pauseAudioAccompany;

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Lanjutkan pencampuran akompanimen audio.

- (int)resumeAudioAccompany;

Nilai kembali

0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Mengambil durasi file akompanimen dalam milidetik.

- (int)getAudioAccompanyDuration;

Nilai kembali

Mengembalikan durasi file akompanimen dalam milidetik jika berhasil (>= 0). Mengembalikan nilai kurang dari 0 jika operasi gagal.

Ambil kemajuan pemutaran file akompanimen dalam milidetik.

- (int)getAudioAccompanyCurrentPosition;

Nilai kembali

Nilai 0 atau lebih besar menunjukkan posisi pemutaran saat ini dalam milidetik. Nilai negatif menunjukkan kegagalan.

Menetapkan posisi pemutaran file akompanimen.

- (int)setAudioAccompanyPosition:(int)pos;

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Memuat awal efek suara.

- (int)preloadAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString *_Nonnull)filePath;

Parameter

Deskripsi Pengembalian

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

Menghapus efek suara yang telah dimuat sebelumnya.

- (int)unloadAudioEffectWithSoundId:(NSInteger)soundId;

Parameter

Deskripsi Pengembalian

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

Memulai pemutaran efek suara.

- (int)playAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString *_Nonnull)filePath cycles:(NSInteger)cycles publish:(BOOL)publish;

Parameter

Deskripsi pengembalian

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

Menghentikan pemutaran efek suara.

- (int)stopAudioEffectWithSoundId:(NSInteger)soundId;

Parameter

Deskripsi pengembalian

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

Menghentikan pemutaran semua efek suara.

- (int)stopAllAudioEffects;

Deskripsi pengembalian

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

Jeda pemutaran efek suara.

- (int)pauseAudioEffectWithSoundId:(NSInteger)soundId;

Parameter

Deskripsi Pengembalian

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

Jeda pemutaran semua efek suara.

- (int)pauseAllAudioEffects;

Deskripsi respons

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

Melanjutkan pemutaran efek suara.

- (int)resumeAudioEffectWithSoundId:(NSInteger)soundId;

Parameter

Deskripsi pengembalian

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

Melanjutkan pemutaran semua efek suara.

- (int)resumeAllAudioEffects;

Deskripsi Pengembalian

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

Menetapkan volume efek suara untuk ingest stream.

- (int)setAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

Parameter

Deskripsi pengembalian

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

Memeriksa volume efek suara untuk ingest stream.

- (int)getAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId;

Parameter

Deskripsi Pengembalian

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

Menetapkan volume untuk mencampur semua efek suara ke dalam ingest stream.

- (int)setAllAudioEffectsPublishVolume:(NSInteger)volume;

Parameter

Deskripsi respons

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

Menetapkan volume efek suara untuk pemutaran lokal.

- (int)setAaudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

Parameter

Deskripsi pengembalian

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

Memeriksa volume efek suara untuk pemutaran lokal.

- (int)getAudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId;

Parameter

Deskripsi Pengembalian

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

Anda dapat mengatur volume pemutaran lokal semua efek suara.

- (int)setAllAudioEffectsPlayoutVolume:(NSInteger)volume;

Parameter

Deskripsi Pengembalian

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

Memulai perekaman file media.

- (BOOL)startRecord:(AliRtcRecordType)recordType recordFormat:(AliRtcRecordFormat)recordFormat filePath:(NSString*)filePath audioConfig:(AliRtcRecordAudioConfig*)audioConfig videoConfig:(AliRtcRecordVideoConfig*)videoConfig;

Parameter

Deskripsi pengembalian

Nilai TRUE menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menghentikan perekaman file media.

- (void)stopRecord 

Parameter

Tidak ada.

Menetapkan tampilan rendering dan parameter gambar untuk pratinjau lokal.

- (int)setLocalViewConfig:(AliVideoCanvas *_Nullable)viewConfig forTrack:(AliRtcVideoTrack)track;

Metode ini menetapkan tampilan pratinjau lokal. Ketika Anda memanggilnya, stream video lokal diikat ke tampilan tampilan dan mode rendering, mode cermin, serta sudut rotasi untuk tampilan pengguna lokal dikonfigurasi. Ini hanya memengaruhi pratinjau lokal—bukan ingest stream. Untuk mengonfigurasi tampilan pengguna remote, panggil setRemoteViewConfig.

Kapan Menghubungi

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

Deskripsi Parameter

Deskripsi Pengembalian

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

Mengatur preferensi pengumpulan Kamera.

- (int)setCameraCapturerConfiguration:(AliRtcCameraCapturerConfiguration* _Nonnull)config;

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

Kapan harus memanggil

Anda harus mengatur ini sebelum mengaktifkan kamera. Misalnya, sebelum:

• startPreview

• joinChannel (Bergabung ke Channel)

Parameter

Deskripsi pengembalian

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

Menonaktifkan atau mengaktifkan kembali pengumpulan video lokal.

- (int)enableLocalVideo:(BOOL)enable;

Metode ini mengaktifkan atau menonaktifkan pengambilan video lokal. Ketika dinonaktifkan, pratinjau lokal dan ingest stream tidak menampilkan video. Namun, menerima video remote tetap tidak terpengaruh. Jika Anda menonaktifkan pengambilan kamera lokal, pratinjau lokal dan ingest stream membeku pada frame terakhir.

Kapan Memanggil

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

Callback terkait

• Setelah Anda berhasil memanggil metode ini, callback onUserVideoEnabled memberi tahu pengguna remote.

Parameter

Deskripsi Pengembalian

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

Hentikan atau lanjutkan transmisi data video lokal.

- (int)muteLocalCamera:(BOOL)mute forTrack:(AliRtcVideoTrack)track;

Panggil metode ini untuk mengirim frame hitam saat menerbitkan. Pratinjau lokal tetap menampilkan secara normal. Modul pengambilan, pengkodean, dan transmisi tetap aktif, hanya mengirim frame hitam.

Deskripsi Parameter

Deskripsi pengembalian

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

Menetapkan tampilan rendering dan parameter gambar untuk track video pengguna remote.

- (int)setRemoteViewConfig:(AliVideoCanvas *_Nullable)canvas uid:(NSString *_Nonnull)uid forTrack:(AliRtcVideoTrack)track;

Metode ini menempelkan tampilan tampilan untuk stream video pengguna remote tertentu dan menetapkan properti untuk tampilan lokalnya, seperti mode rendering, mode cermin, dan sudut rotasi. Ini hanya memengaruhi gambar video yang dilihat oleh pengguna lokal. Untuk menetapkan tampilan pratinjau lokal, Anda dapat memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#fea843803078q" id="b6f22fe87a2es">setLocalViewConfig</a>.

• Jika parameter view dari AliVideoCanvas: rendering canvas null, rendering berhenti.

• Untuk mengatur ulang nilai renderMode dari AliVideoCanvas: rendering canvas selama pemutaran, ubah hanya nilai renderMode dan pertahankan parameter lainnya tidak berubah.

• Untuk mengatur ulang nilai mirrorMode dari AliVideoCanvas: rendering canvas selama pemutaran, ubah hanya nilai mirrorMode dan pertahankan parameter lainnya tidak berubah.

Kapan Harus Menghubungi

Kami merekomendasikan memanggil metode ini ketika Anda menerima callback onRemoteTrackAvailableNotify, yang dipicu ketika video pengguna remote tersedia.

Parameter

Deskripsi respons

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

Memeriksa apakah kamera menyala.

- (BOOL)isCameraOn;

Deskripsi respons

Nilai YES menunjukkan bahwa kamera menyala. Nilai NO menunjukkan bahwa kamera dimatikan.

Menetapkan properti pengkodean video.

- (void)setVideoEncoderConfiguration:(AliRtcVideoEncoderConfiguration* _Nonnull)config;

Metode ini menetapkan parameter pengkodean stream video, seperti resolusi, laju frame, bitrate, dan orientasi. Kami merekomendasikan memanggil metode ini untuk semua skenario video.

Kapan dipanggil

Anda dapat memanggil metode ini sebelum atau setelah bergabung ke channel. Untuk menetapkan properti pengkodean stream kamera sekali per sesi, kami merekomendasikan memanggilnya sebelum bergabung.

Batasan

Baik metode ini maupun setVideoMirrorMode mengontrol pencerminan stream video. Kami merekomendasikan hanya menggunakan salah satunya. Menggunakan keduanya dapat menyebabkan efek cermin tumpang tindih, yang mengakibatkan perilaku yang tidak benar.

Parameter

Menetapkan properti decoding video.

- (void)setVideoDecoderConfiguration:(AliRtcVideoDecoderConfiguration* _Nonnull)config;

Metode ini menetapkan parameter decoding video untuk stream kamera.

Kapan Harus Menghubungi

Anda dapat memanggil metode ini sebelum rapat dimulai.

Parameter

Beralih antara kamera depan dan belakang. Secara default, kamera depan digunakan. Metode ini hanya berlaku untuk iOS.

- (int)switchCamera;

Metode ini mengontrol apakah kamera depan atau belakang digunakan. Anda dapat beralih kamera secara dinamis selama runtime aplikasi berdasarkan perangkat keras yang tersedia tanpa me-restart stream video atau mengonfigurasi ulang sumber video.

Kapan harus memanggil

Anda hanya dapat memanggil metode ini setelah kamera berhasil dihidupkan.

Batasan

Metode ini hanya didukung pada platform iOS dan Android.

Deskripsi pengembalian

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

Memeriksa jenis kamera saat ini. Secara default, kamera depan digunakan. Metode ini hanya berlaku untuk iOS.

- (AliRtcCameraDirection)getCurrentCameraDirection;

Deskripsi pengembalian

Mengembalikan enumerasi arah kamera.

Memulai pratinjau lokal. Kamera secara otomatis dihidupkan.

- (int)startPreview;

API ini mengaktifkan pratinjau video lokal dan secara otomatis membuka kamera. Untuk menghentikan pratinjau lokal, panggil API `stopPreview`.

Kapan Harus Menghubungi

• Sebelum memanggil metode ini, Anda dapat mengatur tampilan pratinjau menggunakan setLocalViewConfig. Jika tidak, pratinjau gagal—tetapi ingest stream tetap tidak terpengaruh.

• Anda dapat memanggil metode ini sebelum joinChannel untuk memulai pratinjau lebih awal. Kamera mulai secara otomatis.

Deskripsi Pengembalian

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

Menghentikan pratinjau lokal.

- (int)stopPreview;

Metode ini menghentikan pratinjau video lokal dan menonaktifkan kamera. Setelah dihentikan, pratinjau lokal membeku pada frame terakhir. Ingest stream tidak terpengaruh.

Kapan Harus Menghubungi

Anda dapat memanggil metode ini untuk menghentikan pratinjau.

Deskripsi pengembalian

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

Mengatur zoom kamera.

 - (int)setCameraZoom:(float)zoom;

Parameter

Nilai kembali

Mengembalikan 0 pada keberhasilan. Nilai lainnya menunjukkan kegagalan.

Mengambil faktor zoom kamera maksimum.

 - (float)GetCameraMaxZoomFactor;

Nilai kembali

Faktor zoom kamera maksimum.

Memperoleh tingkat zoom kamera saat ini.

- (float)GetCurrentZoom;

Nilai kembali

Tingkat zoom kamera saat ini.

Anda dapat mengatur tingkat eksposur kamera.

- (int)SetExposure:(float)exposure;

Parameter

Nilai kembali

0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Anda dapat memperoleh eksposur kamera.

- (float)GetCurrentExposure;

Nilai kembali

Tingkat eksposur kamera.

Peroleh eksposur kamera minimum

- (float)GetMinExposure;

nilai kembali

Tingkat eksposur minimum untuk kamera.

Mengambil tingkat eksposur kamera maksimum.

- (float)GetMaxExposure;

Nilai kembali

Tingkat eksposur kamera maksimum.

Anda dapat mengatur sakelar flash kamera.

- (int)setCameraFlash:(BOOL)flash;

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Memeriksa apakah fokus manual didukung.

- (BOOL)isCameraFocusPointSupported;

Nilai kembali

Mengembalikan TRUE jika fokus manual didukung, dan FALSE sebaliknya.

Apakah kamera mendukung pengaturan titik eksposur?

- (BOOL)isCameraExposurePointSupported;

Nilai kembali

TRUE menunjukkan bahwa pengaturan titik eksposur didukung. FALSE menunjukkan bahwa itu tidak didukung.

Mengatur titik fokus manual untuk kamera.

- (int)setCameraFocusPoint:(CGPoint)point;

Parameter

Nilai kembali

Mengembalikan 0 pada keberhasilan. Nilai lainnya menunjukkan kegagalan.

Atur nilai eksposur pada titik yang ditentukan.

- (int)setCameraExposurePoint:(CGPoint)point;

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Apakah kamera mendukung fokus wajah?

- (BOOL)isCameraAutoFocusFaceModeSupported;

Nilai kembali

Nilai TRUE menunjukkan bahwa fokus otomatis wajah didukung, dan nilai FALSE menunjukkan bahwa tidak didukung.

Anda dapat mengaktifkan atau menonaktifkan fokus otomatis wajah.

- (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable;

Parameter

Nilai kembali

Nilai kembali TRUE menunjukkan keberhasilan. Nilai kembali FALSE menunjukkan kegagalan.

Atur mode pencerminan video.

- (int)setVideoMirrorMode:(AliRtcVideoPipelineMirrorMode)mirrorMode;

Menetapkan apakah akan menerapkan pencerminan ke pratinjau lokal dan stream video yang diterbitkan.

Kapan dipanggil

Anda dapat memanggil metode ini secara dinamis sebelum atau setelah bergabung ke channel. SDK menyimpan status dan menerapkan pencerminan selama pratinjau atau pengkodean (ingest stream).

Batasan

Metode ini tumpang tindih dengan setLocalViewConfig dan setVideoEncoderConfiguration, keduanya mendukung parameter mirrorMode. Kami merekomendasikan hanya menggunakan metode ini.

Parameter

Anda dapat mengatur mode penskalaan untuk tautan video.

-(void)setCapturePipelineScaleMode:(AliRtcCapturePipelineScaleMode)mode;

Menentukan apakah data video diskalakan selama pengambilan atau selama pengkodean. Misalnya, jika resolusi pengambilan berbeda dari resolusi pengkodean, pengaturan ini menentukan apakah data pratinjau cocok dengan data ingest stream.

Kapan Dipanggil

Anda harus mengatur metode ini sebelum memulai kamera—misalnya, sebelum memanggil startPreview atau joinChannel.

Parameter

Nilai kembali

Nilai 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Mendaftarkan observer output data video.

- (void)registerVideoFrameWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

Anda dapat menggunakan metode ini untuk mendaftarkan objek yang mengekspor data video. Untuk membatalkan pendaftaran, panggil unregisterVideoSampleWithObserver.

Kapan Harus Menghubungi

Untuk memperoleh data video mentah (seperti format YUV atau RGBA) pada berbagai tahap, Anda dapat memanggil antarmuka ini untuk mendaftarkan monitor data video.

Callback terkait

Setelah Anda berhasil mendaftarkan observer output data video, SDK memicu callback yang Anda implementasikan ketika menangkap setiap frame video. Terapkan callback berikut sesuai kebutuhan:

• onCaptureVideoSample: Callback untuk data video yang diambil secara lokal.

• onRemoteVideoSample: Callback untuk data video remote.

• onPreEncodeVideoSample: Callback untuk data video lokal sebelum pengkodean.

Parameter

Anda dapat membatalkan objek output data video.

- (void)unregisterVideoSampleWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

Antarmuka ini berkorelasi dengan antarmuka <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#9a3437ab16j1w" id="f524bad30a6ys">registerVideoSampleObserver</a> dan membatalkan pendaftaran objek output data video.

Parameter

Mendaftarkan observer tekstur OpenGL untuk video kamera lokal.

- (void)registerLocalVideoTextureObserver:(id<AliRtcTextureDelegate> _Nullable)observer;

Untuk mengambil data video mentah, panggil registerVideoSampleObserver. Untuk mengambil data tekstur internal, panggil metode ini. Untuk membatalkan pendaftaran observer, panggil unRegisterLocalVideoTextureObserver.

Callback terkait

Setelah Anda berhasil mendaftarkan observer tekstur OpenGL untuk video kamera lokal, SDK memicu callback yang Anda implementasikan di AliRtcTextureObserver setiap kali frame video diambil. Anda dapat menerapkan callback berikut sesuai kebutuhan:

• onTextureCreate: Callback ini dipicu ketika SDK membuat konteks OpenGL internalnya.

• onTextureUpdate: Callback ini dipicu setelah setiap frame video diunggah ke tekstur OpenGL. Ketika observer tekstur eksternal terdaftar, Anda dapat memproses tekstur dan mengembalikan ID tekstur yang telah diproses. Nilai kembali harus merupakan ID tekstur yang valid. Jika tidak ada pemrosesan yang dilakukan, kembalikan textureId input.

• onTextureDestroy: Callback ini dipicu ketika SDK menghancurkan konteks OpenGL internalnya.

Parameter

Membatalkan pendaftaran observer tekstur OpenGL untuk video kamera lokal.

- (void)unregisterLocalVideoTextureObserver:(id<AliRtcTextureDelegate> _Nullable)observer;

Metode ini berkorelasi dengan registerLocalVideoTextureObserver dan menangani pembatalan pendaftarannya.

Parameter

Mengambil snapshot dari video.

- (int)snapshotVideo:(NSString*_Nullable)userId type:(AliRtcVideoTrack)type;

Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Menentukan apakah akan mengaktifkan sumber video eksternal.

- (int)setExternalVideoSource:(BOOL)enable sourceType:(AliRtcVideoSource)type renderMode:(AliRtcRenderMode)renderMode;

Parameter

Mengimpor data video eksternal.

- (int)pushExternalVideoFrame:(AliRtcVideoDataSample *_Nonnull)frame sourceType:(AliRtcVideoSource)type;

Parameter

Deskripsi pengembalian

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

Memulai streaming langsung yang direlay.

- (int)startPublishLiveStreamWithURL:(NSString *_Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam *_Nonnull)trancoding;

Parameter

Deskripsi Pengembalian

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

Memperbarui parameter untuk streaming langsung yang direlay.

- (int)updatePublishLiveStreamWithURL:(NSString *_Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam *_Nonnull)trancoding;

Parameter

Nilai Pengembalian

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

Hentikan streaming langsung bypass.

- (int)stopPublishLiveStreamWithURL:(NSString *_Nonnull)streamURL;

Parameter

Deskripsi Pengembalian

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

Memeriksa status streaming langsung yang direlay.

- (AliRtcLiveTranscodingState)GetPublishLiveStreamStateWithURL:(NSString *_Nonnull)streamURL;

Parameter

Deskripsi pengembalian

Status streaming langsung yang direlay dikembalikan.

Memulai pengujian kualitas jaringan.

- (int)startLastmileDetect:(AliRtcNetworkQualityProbeConfig *_Nonnull)config;

Parameter

Deskripsi Pengembalian

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

Menghentikan pengujian kualitas jaringan.

- (int)stopLastmileDetect;

Deskripsi pengembalian

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

Menetapkan parameter mode gema.

- (int)sendMediaExtensionMsg:(NSData *_Nonnull)data repeatCount:(int)repeatCount delay:(int)delay isKeyFrame:(bool)isKeyFrame;

SDK mendukung pengiriman dan penerimaan pesan ekstensi media. SDK mengirimkan pesan menggunakan protokol Supplemental Enhancement Information (SEI). Penerima dapat memperoleh pesan dengan mendengarkan callback onMediaExtensionMsgReceived.

Contoh kasus penggunaan umum meliputi:

• Anda dapat menggunakan pesan ekstensi media untuk mengirim timestamp guna menghitung latensi jaringan end-to-end atau untuk sinkronisasi dengan logika bisnis lainnya.

• Anda dapat menggunakan pesan ekstensi media untuk mengirim informasi deskriptif, dengan muatan hingga 4 KB. Untuk muatan kecil, gunakan JSON atau string biasa.

Kapan dipanggil

Panggil metode ini setelah ingest stream dimulai.

Batasan

Pesan ekstensi media menggunakan kembali saluran data audio-video. Oleh karena itu, Anda harus mengontrol frekuensi dan ukuran pesan. Batasan berikut berlaku:

• Jumlah maksimum pesan per detik sama dengan pengaturan frames per second (FPS) dalam profil. Karena pesan SEI disematkan dalam stream H.264 atau H.265, pengkodean frame video diperlukan untuk melampirkan data ekstensi.

• Untuk menghindari memengaruhi kualitas transmisi media, ukuran badan pesan dibatasi hingga 4 KB. Batasan ini cocok untuk muatan kecil.

• Anda dapat menggunakan fungsi sendMediaExtensionMsg. Parameter repeatCount menentukan redundansi pesan kustom. Jika parameter ini lebih besar dari 1, pesan dikirim beberapa kali.

• Untuk mencegah kehilangan paket menyebabkan kehilangan pesan, pengguna lain di channel juga menerima pesan duplikat. Anda harus menghapus duplikatnya.

• Pelanggan dalam sesi streaming langsung yang direlay juga menerima pesan kustom.

• Hanya satu MediaExtensionMsg yang dapat dikirimkan sekaligus. Beberapa panggilan ke sendMediaExtensionMsg menyebabkan data dari panggilan baru menimpa data dari panggilan sebelumnya.

Callback terkait

Ketika penerbit mengirim pesan ekstensi media, pelanggan menerima pesan tersebut melalui callback onMediaExtensionMsgReceived.

Deskripsi Parameter

Nilai kembali

Nilai kembali 0 menunjukkan keberhasilan. Nilai lainnya menunjukkan kegagalan.

Informasi ekstensi media dikirimkan dan diimplementasikan di lapisan bawah menggunakan SEI.

- (int)sendMediaExtensionMsgEx:(NSData *_Nonnull)data repeatCount:(int)repeatCount delay:(int)delay isKeyFrame:(bool)isKeyFrame payloadType:(int)payloadType;

SDK mendukung pengiriman dan penerimaan pesan ekstensi media. Metode ini mengirimkan pesan menggunakan protokol Supplemental Enhancement Information (SEI). Penerima dapat memperoleh pesan dengan mendengarkan callback onMediaExtensionMsgReceived. Jika payloadType adalah 5, metode ini berfungsi identik dengan sendMediaExtensionMsg.

Contoh kasus penggunaan umum meliputi:

• Anda dapat menggunakan pesan ekstensi media untuk mengirim timestamp guna menghitung latensi jaringan end-to-end atau untuk sinkronisasi dengan logika bisnis lainnya.

• Anda dapat menggunakan pesan ekstensi media untuk mengirim informasi deskriptif. Data hingga 4 KB dapat dikirim. Untuk muatan kecil, gunakan JSON atau string biasa.

Kapan Harus Menghubungi

Anda dapat memanggil setelah memulai ingest stream.

Batasan Panggilan

Pesan ekstensi media menggunakan kembali saluran data audio-video. Oleh karena itu, Anda harus mengontrol frekuensi dan ukuran pesan-pesan ini. Batasannya adalah:

• Jumlah maksimum pesan per detik sama dengan pengaturan frames per second (FPS) dalam profil. Karena pesan SEI disematkan dalam stream H.264 atau H.265, pengkodean frame video diperlukan untuk melampirkan data ekstensi.

• Untuk menghindari memengaruhi kualitas transmisi media, ukuran badan pesan dibatasi hingga 4 KB. Batasan ini cocok untuk muatan kecil.

• Parameter repeatCount dari fungsi sendMediaExtensionMsg menentukan redundansi pesan. Nilai lebih besar dari 1 memicu beberapa transmisi.

• Untuk mencegah kehilangan pesan akibat kehilangan paket, pengguna lain di channel juga menerima pesan duplikat. Anda harus menghapus duplikatnya.

• Pelanggan dalam sesi streaming langsung yang direlay juga menerima pesan kustom.

• Hanya satu MediaExtensionMsg yang dapat dikirimkan sekaligus. Beberapa panggilan ke sendMediaExtensionMsg menimpa data sebelumnya.

Parameter

Deskripsi Pengembalian

• 0: Berhasil.

• < 0: Gagal. Mengembalikan kode kesalahan.

  • ERR_INNER (-1): Kesalahan internal SDK. Kemungkinan penyebab: SDK belum diinisialisasi atau dihancurkan sebelum panggilan.

Callback yang dipanggil ketika status koneksi jaringan berubah.

- (void)onConnectionStatusChange:(AliRtcConnectionStatus)status reason:(AliRtcConnectionStatusChangeReason)reason;

Parameter

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

- (void)onLocalDeviceException:(AliRtcLocalDeviceType)deviceType exceptionType:(AliRtcLocalDeviceExceptionType)exceptionType message:(NSString *_Nullable)msg;

Parameter

Callback yang dipanggil ketika autentikasi pengguna akan segera kedaluwarsa. Autentikasi kedaluwarsa 30 detik setelah Anda menerima callback ini. Perhatikan callback ini.

- (void)onAuthInfoWillExpire;

Callback ini menunjukkan bahwa autentikasi pengguna akan segera kedaluwarsa. Setelah menerimanya, autentikasi kedaluwarsa dalam 30 detik. Anda harus menghasilkan token baru dan memperbarui autentikasi menggunakan salah satu metode berikut:

• Panggil API <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6a4495191bmd" id="918ba91977wi6">refreshAuthInfo</a> untuk memperbarui informasi autentikasi.

• Panggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="ad8235d30dprb">leaveChannel</a> untuk meninggalkan channel saat ini, lalu panggil joinChannel untuk bergabung kembali ke channel.

Kondisi Pemicu

SDK memicu callback ini 30 detik sebelum autentikasi kedaluwarsa. Setelah Anda menerimanya, perbarui autentikasi segera.

Pengguna memanggil API yang memerlukan autentikasi, dan server mengembalikan tanggapan yang telah kedaluwarsa.

- (void)onAuthInfoExpired;

Callback ini menunjukkan bahwa autentikasi pengguna telah kedaluwarsa. Untuk melanjutkan sesi, hasilkan token baru di server Anda dan perbarui autentikasi menggunakan salah satu metode berikut:

• Panggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="21390e77a1307">leaveChannel</a> untuk meninggalkan channel saat ini, lalu panggil joinChannel untuk bergabung kembali ke channel.

Ketika dipicu

Callback ini dipicu ketika autentikasi pengguna kedaluwarsa.

Callback ini melaporkan hasil bergabung ke channel. Fungsionalitasnya setara dengan operasi blocking metode joinChannel. Anda dapat menggunakan pendekatan mana pun untuk menangani event yang terjadi setelah bergabung ke channel.

- (void)onJoinChannelResult:(int)result channel:(NSString *_Nonnull)channel elapsed:(int) elapsed;

Kondisi pemicu

Callback ini dipicu ketika aplikasi Anda memanggil metode joinChannel. Callback ini melaporkan apakah operasi berhasil atau gagal dan mengembalikan informasi terkait, termasuk latensi bergabung.

Parameter

Callback ini dipanggil setelah Anda memanggil leaveChannel. Jika Anda memanggil destroy segera setelah leaveChannel, callback ini tidak dipicu.

- (void)onLeaveChannelResult:(int)result stats:(AliRtcStats)stats;

Parameter

Callback yang dipanggil ketika pengguna remote offline.

- (void)onRemoteUserOffLineNotify:(NSString *_Nonnull)uid offlineReason:(AliRtcUserOfflineReason)reason;

Callback ini memberi tahu pengguna lokal ketika pengguna remote keluar dari channel karena alasan apa pun. Callback ini dipicu ketika pengguna remote menjadi offline.

Kondisi pemicu

• Callback ini dipicu ketika pengguna remote keluar dari channel.

• Streamer remote memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#892915dd4edcy" id="78b1952ad5lwp">setClientRole</a> untuk beralih ke peran viewer (AliRtcClientRoleLive), dan callback dipicu.

• Sistem mendeteksi bahwa tidak ada data yang diterima dari streamer remote dalam periode waktu yang lama dan menganggap mereka offline.

Parameter

Callback yang dipanggil ketika pengguna remote online.

- (void)onRemoteUserOnLineNotify:(NSString *_Nonnull)uid elapsed:(int)elapsed;

Metode ini dipicu ketika pengguna remote bergabung ke channel.

Kondisi pemicu

• Pengguna remote berhasil bergabung ke channel.

• Setelah pengguna lokal bergabung ke channel, mereka menerima callback bergabung untuk pengguna yang sudah berada di channel untuk menampilkan pengguna yang telah bergabung sebelumnya.

Parameter

Callback yang dipanggil ketika stream pengguna remote berubah.

- (void)onRemoteTrackAvailableNotify:(NSString *_Nonnull)uid audioTrack:(AliRtcAudioTrack)audioTrack videoTrack:(AliRtcVideoTrack)videoTrack;

Callback ini dipicu ketika status penerbitan pengguna remote berubah. Anda dapat menggunakannya untuk memantau apakah pengguna remote menerbitkan stream audio dan video serta memperbarui UI sesuai dengan menampilkan atau menyembunyikan media mereka.

Kondisi pemicu

Callback ini dipicu dalam kasus berikut:

• Pengguna remote berpindah dari tidak menerbitkan ke menerbitkan audio dan/atau video.

• Pengguna remote berpindah dari menerbitkan ke tidak menerbitkan audio dan/atau video.

• Dalam mode interaktif, pengguna remote memanggil setClientRole untuk beralih dari viewer ke streamer saat menerbitkan stream.

Misalnya, callback ini tidak dipicu jika pengguna remote menonaktifkan ingest stream video:

• Jika pengguna remote mulai menerbitkan video kamera (status penerbitan: tanpa video → hanya kamera), callback ini mengembalikan AliRtcVideoTrackCamera, menunjukkan bahwa stream kamera pengguna remote tersedia.

• Jika pengguna yang sama kemudian juga menerbitkan berbagi layar (status penerbitan: hanya kamera → kamera + berbagi layar), callback ini mengembalikan AliRtcVideoTrackBoth, menunjukkan bahwa stream kamera dan berbagi layar tersedia.

• Jika pengguna berhenti menerbitkan video kamera tetapi terus berbagi layar (status penerbitan: kamera + berbagi layar → hanya berbagi layar), callback ini mengembalikan AliRtcVideoTrackScreen, menunjukkan bahwa hanya stream berbagi layar yang tersedia.

• Jika pengguna berhenti menerbitkan berbagi layar (status penerbitan: hanya berbagi layar → tanpa video), callback ini mengembalikan AliRtcVideoTrackNo, menunjukkan bahwa tidak ada stream video yang tersedia.

Parameter

Callback yang dipanggil ketika pengguna dipaksa keluar dari channel.

- (void)onBye:(int)code;

Callback ini dipicu ketika pengguna terputus atau sesi berakhir. Pengembang dapat menggunakan parameter code untuk mengidentifikasi penyebab dan menanganinya secara tepat.

Kondisi Pemicu

• Pengguna diputus oleh server.

• Sesi berakhir (server menghentikan channel).

• Pengguna terputus secara pasif. Klien harus mencoba pemulihan atau koneksi ulang sesi.

Parameter

Callback yang dipanggil ketika status ingest stream untuk track audio berubah.

- (void)onAudioPublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Callback ini memantau perubahan status penerbitan audio pengguna lokal.

Kondisi pemicu

Callback ini dipicu ketika status penerbitan audio pengguna berubah—misalnya:

• Hentikan ingest stream.

• Anda dapat memanggil <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#892915dd4edcy" id="81771ef0798we">setClientRole</a> untuk beralih ke viewer.

Parameter

Callback yang dipanggil ketika status langganan ke track audio berubah.

- (void)onAudioSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Callback ini memberi tahu pengguna lokal ketika status langganan ke stream audio pengguna remote berubah. Anda dapat menggunakannya untuk melacak perubahan status langganan untuk stream kamera pengguna remote tertentu dan interval waktu antar status.

Parameter

Callback yang dipanggil ketika pengguna membisukan track audio.

- (void)onUserAudioMuted:(NSString *_Nonnull)uid audioMuted:(BOOL)isMute;

Parameter

Callback yang dipanggil ketika track audio pengguna terganggu. Misalnya, track audio dapat diambil alih ketika pengguna melakukan panggilan telepon.

- (void)onUserAudioInterruptedBegin:(NSString *_Nonnull)uid;

Parameter

Callback yang dipanggil ketika gangguan track audio pengguna berakhir. Callback ini berpasangan dengan callback onUserAudioInterruptedBegin.

- (void)onUserAudioInterruptedEnded:(NSString *_Nonnull)uid;

Parameter

Callback yang dipanggil ketika status ingest stream untuk track video berubah.

- (void)onVideoPublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Callback ini memantau perubahan status penerbitan video pengguna lokal.

Parameter

Callback yang dipanggil ketika status langganan ke track video berubah.

- (void)onVideoSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Callback ini memberi tahu pengguna lokal tentang perubahan status langganan ke stream kamera pengguna remote. Callback ini menyediakan status langganan baru dan waktu yang berlalu antara perubahan status.

Callback terkait

Stream video mencakup stream kamera dan stream berbagi layar. Callback ini dipicu oleh perubahan langganan ke stream kamera. Perubahan langganan ke stream berbagi layar memicu callback onScreenShareSubscribeStateChanged.

Parameter

Notifikasi pembisuan video pengguna.

- (void)onUserVideoMuted:(NSString *_Nonnull)uid videoMuted:(BOOL)isMute;

Parameter

Notifikasi dikirim ketika pengambilan video lokal dinonaktifkan atau diaktifkan kembali.

- (void)onUserVideoEnabled:(NSString *_Nullable)uid videoEnabled:(BOOL)isEnable;

Parameter

Callback yang dipanggil ketika pengguna remote beralih aplikasi ke latar belakang.

- (void)onUserWillResignActive:(NSString *_Nonnull)uid;

Parameter