From b77c6e4894468a030bc35449f1ba5e9b596bb360 Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Tue, 26 Sep 2023 06:09:18 +0000 Subject: [PATCH] Sync cn prototype to en prototype --- ...ayconfiguration_removedestchannelinfo.dita | 10 +-- ...relayconfiguration_setdestchannelinfo.dita | 12 ++-- .../api_iaudiodevicecollection_getdevice.dita | 4 +- .../api_iaudiodevicecollection_setdevice.dita | 10 +-- ...icemanager_followsystemloopbackdevice.dita | 22 +++---- ...icemanager_followsystemplaybackdevice.dita | 20 +++--- ...cemanager_followsystemrecordingdevice.dita | 8 +-- ...iaudiodevicemanager_getloopbackdevice.dita | 16 ++--- ...iaudiodevicemanager_getplaybackdevice.dita | 6 +- ...iodevicemanager_getplaybackdeviceinfo.dita | 6 +- ...iodevicemanager_getplaybackdevicemute.dita | 4 +- ...devicemanager_getplaybackdevicevolume.dita | 4 +- ...audiodevicemanager_getrecordingdevice.dita | 10 +-- ...odevicemanager_getrecordingdeviceinfo.dita | 6 +- ...odevicemanager_getrecordingdevicemute.dita | 4 +- ...evicemanager_getrecordingdevicevolume.dita | 4 +- ...iaudiodevicemanager_setloopbackdevice.dita | 22 +++---- ...iaudiodevicemanager_setplaybackdevice.dita | 10 +-- ...iodevicemanager_setplaybackdevicemute.dita | 8 +-- ...devicemanager_setplaybackdevicevolume.dita | 8 +-- ...audiodevicemanager_setrecordingdevice.dita | 10 +-- ...odevicemanager_setrecordingdevicemute.dita | 8 +-- ...evicemanager_setrecordingdevicevolume.dita | 16 ++--- ...emanager_startaudiodeviceloopbacktest.dita | 10 +-- ...devicemanager_startplaybackdevicetest.dita | 8 +-- ...evicemanager_startrecordingdevicetest.dita | 20 +++--- ...cemanager_stopaudiodeviceloopbacktest.dita | 8 +-- ...odevicemanager_stopplaybackdevicetest.dita | 10 +-- ...devicemanager_stoprecordingdevicetest.dita | 20 +++--- ...audioengine_muteallremoteaudiostreams.dita | 24 +++---- ...atialaudioengine_mutelocalaudiostream.dita | 26 ++++---- ...tialaudioengine_muteremoteaudiostream.dita | 28 ++++----- ...espatialaudioengine_setaudiorecvrange.dita | 8 +-- ...asespatialaudioengine_setdistanceunit.dita | 8 +-- ...atialaudioengine_setmaxaudiorecvcount.dita | 8 +-- ...atialaudioengine_setplayerattenuation.dita | 26 ++++---- .../api_ibasespatialaudioengine_setzones.dita | 22 +++---- ...spatialaudioengine_updateselfposition.dita | 18 +++--- ...atialaudioengine_clearremotepositions.dita | 8 +-- ...atialaudioengine_removeremoteposition.dita | 8 +-- ...audioengine_setremoteaudioattenuation.dita | 30 ++++----- ..._imediaengine_destroycustomaudiotrack.dita | 18 +++--- .../API/api_imediaengine_pullaudioframe.dita | 30 ++++----- ...api_imediaengine_setexternalaudiosink.dita | 10 +-- ..._imediaengine_setexternalaudiosource2.dita | 28 ++++----- ...i_imediaengine_setexternalvideosource.dita | 10 +-- ...iaengine_unregisteraudioframeobserver.dita | 16 ++--- ...e_unregistervideoencodedframeobserver.dita | 16 ++--- ...iaengine_unregistervideoframeobserver.dita | 18 +++--- .../api_imediaplayer_adjustplayoutvolume.dita | 8 +-- ...mediaplayer_adjustpublishsignalvolume.dita | 8 +-- ...imediaplayer_enableautoswitchagoracdn.dita | 8 +-- .../API/api_imediaplayer_getduration.dita | 6 +- .../RTC-NG/API/api_imediaplayer_getmute.dita | 6 +- .../api_imediaplayer_getplayoutvolume.dita | 6 +- ...i_imediaplayer_getpublishsignalvolume.dita | 6 +- .../API/api_imediaplayer_getstreaminfo.dita | 4 +- .../RTC-NG/API/api_imediaplayer_mute.dita | 10 +-- .../RTC-NG/API/api_imediaplayer_open.dita | 10 +-- .../api_imediaplayer_openwithagoracdnsrc.dita | 8 +-- .../api_imediaplayer_openwithmediasource.dita | 12 ++-- .../RTC-NG/API/api_imediaplayer_pause.dita | 8 +-- .../RTC-NG/API/api_imediaplayer_play.dita | 8 +-- .../api_imediaplayer_playpreloadedsrc.dita | 8 +-- .../API/api_imediaplayer_preloadsrc.dita | 8 +-- ...ediaplayer_registeraudioframeobserver.dita | 20 +++--- ...diaplayer_registeraudioframeobserver2.dita | 24 +++---- ...iaplayer_registerplayersourceobserver.dita | 8 +-- ...pi_imediaplayer_renewagoracdnsrctoken.dita | 8 +-- .../RTC-NG/API/api_imediaplayer_resume.dita | 8 +-- .../RTC-NG/API/api_imediaplayer_seek.dita | 8 +-- .../api_imediaplayer_selectaudiotrack.dita | 10 +-- ...i_imediaplayer_selectinternalsubtitle.dita | 14 ++--- ...api_imediaplayer_setaudiodualmonomode.dita | 8 +-- .../API/api_imediaplayer_setaudiopitch.dita | 8 +-- .../API/api_imediaplayer_setloopcount.dita | 8 +-- .../api_imediaplayer_setplaybackspeed.dita | 8 +-- .../API/api_imediaplayer_setplayeroption.dita | 20 +++--- .../RTC-NG/API/api_imediaplayer_setview.dita | 8 +-- .../RTC-NG/API/api_imediaplayer_stop.dita | 8 +-- ...mediaplayer_switchagoracdnlinebyindex.dita | 8 +-- .../api_imediaplayer_switchagoracdnsrc.dita | 8 +-- .../API/api_imediaplayer_switchsrc.dita | 10 +-- .../API/api_imediaplayer_unloadsrc.dita | 8 +-- ...iaplayer_unregisteraudioframeobserver.dita | 12 ++-- ...player_unregisterplayersourceobserver.dita | 8 +-- ...iaplayer_unregistervideoframeobserver.dita | 16 ++--- ...diaplayercachemanager_removeallcaches.dita | 16 ++--- ...ediarecorder_setmediarecorderobserver.dita | 24 +++---- .../API/api_imediarecorder_stoprecording.dita | 16 ++--- .../RTC-NG/API/api_irtcengine_addhandler.dita | 22 +++---- .../api_irtcengine_addinjectstreamurl.dita | 6 +- .../api_irtcengine_addpublishstreamurl.dita | 6 +- .../API/api_irtcengine_addvideowatermark.dita | 8 +-- .../api_irtcengine_addvideowatermark2.dita | 30 ++++----- ...engine_adjustaudiomixingplayoutvolume.dita | 8 +-- ...engine_adjustaudiomixingpublishvolume.dita | 8 +-- ...pi_irtcengine_adjustaudiomixingvolume.dita | 18 +++--- ...engine_adjustcustomaudioplayoutvolume.dita | 20 +++--- ...engine_adjustcustomaudiopublishvolume.dita | 12 ++-- ...irtcengine_adjustloopbacksignalvolume.dita | 10 +-- ...irtcengine_adjustplaybacksignalvolume.dita | 8 +-- ...rtcengine_adjustrecordingsignalvolume.dita | 10 +-- ...engine_adjustuserplaybacksignalvolume.dita | 10 +-- .../api_irtcengine_clearvideowatermarks.dita | 8 +-- .../RTC-NG/API/api_irtcengine_complain.dita | 16 ++--- .../RTC-NG/API/api_irtcengine_create.dita | 24 +++---- ...pi_irtcengine_destroycustomvideotrack.dita | 16 ++--- .../api_irtcengine_destroymediaplayer.dita | 10 +-- .../API/api_irtcengine_disableaudio.dita | 8 +-- ...rtcengine_disableaudiospectrummonitor.dita | 8 +-- .../api_irtcengine_disablelastmiletest.dita | 14 ++--- .../API/api_irtcengine_disablevideo.dita | 8 +-- .../API/api_irtcengine_enableaudio.dita | 8 +-- ...irtcengine_enableaudiospectrummonitor.dita | 14 ++--- ...rtcengine_enableaudiovolumeindication.dita | 12 ++-- .../api_irtcengine_enablecontentinspect.dita | 26 ++++---- .../api_irtcengine_enabledualstreammode.dita | 6 +- ...engine_enableechocancellationexternal.dita | 8 +-- .../API/api_irtcengine_enableextension.dita | 6 +- .../api_irtcengine_enablefacedetection.dita | 8 +-- ...rtcengine_enableinstantmediarendering.dita | 18 +++--- .../api_irtcengine_enablelastmiletest.dita | 22 +++---- .../API/api_irtcengine_enablelocalaudio.dita | 8 +-- .../API/api_irtcengine_enablelocalvideo.dita | 8 +-- ...pi_irtcengine_enableloopbackrecording.dita | 20 +++--- ...rtcengine_enableremotesuperresolution.dita | 16 ++--- ...cengine_enablesoundpositionindication.dita | 8 +-- .../api_irtcengine_enablespatialaudio.dita | 10 +-- .../API/api_irtcengine_enablevideo.dita | 8 +-- ...api_irtcengine_enablevideoimagesource.dita | 12 ++-- ...tcengine_enablewebsdkinteroperability.dita | 8 +-- .../api_irtcengine_getaudiodeviceinfo.dita | 14 ++--- ...cengine_getaudiomixingcurrentposition.dita | 8 +-- ...api_irtcengine_getaudiomixingduration.dita | 6 +- ...rtcengine_getaudiomixingplayoutvolume.dita | 4 +- ...rtcengine_getaudiomixingpublishvolume.dita | 4 +- .../RTC-NG/API/api_irtcengine_getcallid.dita | 6 +- ...rtcengine_getcurrentmonotonictimeinms.dita | 12 ++-- .../API/api_irtcengine_geteffectsvolume.dita | 4 +- .../api_irtcengine_getextensionproperty.dita | 2 +- .../API/api_irtcengine_getnativehandle.dita | 12 ++-- .../API/api_irtcengine_getuserinfobyuid.dita | 4 +- .../API/api_irtcengine_getvolumeofeffect.dita | 4 +- ..._irtcengine_iscameraexposuresupported.dita | 14 ++--- ...irtcengine_joinchannelwithuseraccount.dita | 10 +-- ...tcengine_joinchannelwithuseraccountex.dita | 8 +-- .../API/api_irtcengine_leavechannel.dita | 30 ++++----- .../API/api_irtcengine_leavechannel2.dita | 24 +++---- .../api_irtcengine_loadextensionprovider.dita | 20 +++--- ..._irtcengine_muteallremoteaudiostreams.dita | 20 +++--- ..._irtcengine_muteallremotevideostreams.dita | 10 +-- .../api_irtcengine_mutelocalaudiostream.dita | 20 +++--- .../api_irtcengine_mutelocalvideostream.dita | 22 +++---- .../api_irtcengine_muterecordingsignal.dita | 10 +-- .../api_irtcengine_muteremoteaudiostream.dita | 20 +++--- .../api_irtcengine_muteremotevideostream.dita | 8 +-- ..._irtcengine_pauseallchannelmediarelay.dita | 10 +-- .../API/api_irtcengine_pausealleffects.dita | 8 +-- .../API/api_irtcengine_pauseaudiomixing.dita | 8 +-- .../API/api_irtcengine_pauseeffect.dita | 8 +-- .../API/api_irtcengine_playalleffects.dita | 8 +-- .../API/api_irtcengine_playeffect2.dita | 6 +- .../API/api_irtcengine_playeffect3.dita | 16 ++--- .../API/api_irtcengine_preloadchannel2.dita | 34 +++++----- .../API/api_irtcengine_preloadeffect.dita | 8 +-- .../API/api_irtcengine_pushaudioframe2.dita | 12 ++-- .../api_irtcengine_pushcaptureaudioframe.dita | 8 +-- .../dita/RTC-NG/API/api_irtcengine_rate.dita | 8 +-- .../API/api_irtcengine_registerextension.dita | 28 ++++----- ...i_irtcengine_registerlocaluseraccount.dita | 10 +-- .../api_irtcengine_removeinjectstreamurl.dita | 8 +-- ...api_irtcengine_removepublishstreamurl.dita | 8 +-- .../RTC-NG/API/api_irtcengine_renewtoken.dita | 6 +- ...irtcengine_resumeallchannelmediarelay.dita | 8 +-- .../API/api_irtcengine_resumealleffects.dita | 8 +-- .../API/api_irtcengine_resumeaudiomixing.dita | 8 +-- .../API/api_irtcengine_resumeeffect.dita | 8 +-- .../API/api_irtcengine_selectaudiotrack.dita | 22 +++---- .../API/api_irtcengine_sendstreammessage.dita | 8 +-- .../API/api_irtcengine_setainsmode.dita | 20 +++--- ...i_irtcengine_setaudioeffectparameters.dita | 8 +-- .../api_irtcengine_setaudioeffectpreset.dita | 10 +-- .../api_irtcengine_setaudiomixingpitch.dita | 8 +-- ...api_irtcengine_setaudiomixingposition.dita | 8 +-- .../API/api_irtcengine_setaudioprofile.dita | 10 +-- .../API/api_irtcengine_setaudioprofile2.dita | 6 +- .../API/api_irtcengine_setaudioscenario.dita | 22 +++---- ...e_setaudiosessionoperationrestriction.dita | 8 +-- .../API/api_irtcengine_setavsyncsource.dita | 8 +-- ...api_irtcengine_setbeautyeffectoptions.dita | 16 ++--- ..._setcameraautoexposurefacemodeenabled.dita | 8 +-- ...ine_setcameraautofocusfacemodeenabled.dita | 10 +-- ...engine_setcameracapturerconfiguration.dita | 10 +-- ...irtcengine_setcameradeviceorientation.dita | 10 +-- ...pi_irtcengine_setcameraexposurefactor.dita | 16 ++--- ..._irtcengine_setcameraexposureposition.dita | 8 +-- ...ngine_setcamerafocuspositioninpreview.dita | 8 +-- .../API/api_irtcengine_setcameratorchon.dita | 8 +-- .../api_irtcengine_setcamerazoomfactor.dita | 6 +- .../API/api_irtcengine_setcloudproxy.dita | 6 +- ...ne_setdefaultaudioroutetospeakerphone.dita | 14 ++--- ...e_setdefaultmuteallremoteaudiostreams.dita | 8 +-- ...e_setdefaultmuteallremotevideostreams.dita | 8 +-- ...tdirectcdnstreamingaudioconfiguration.dita | 8 +-- ...tdirectcdnstreamingvideoconfiguration.dita | 22 +++---- ..._setearmonitoringaudioframeparameters.dita | 32 +++++----- .../API/api_irtcengine_seteffectposition.dita | 12 ++-- .../API/api_irtcengine_seteffectsvolume.dita | 8 +-- .../api_irtcengine_setenablespeakerphone.dita | 8 +-- .../API/api_irtcengine_setencryptionmode.dita | 8 +-- .../api_irtcengine_setencryptionsecret.dita | 8 +-- .../api_irtcengine_setextensionproperty.dita | 8 +-- ...tcengine_setextensionproviderproperty.dita | 8 +-- ...i_irtcengine_setheadphoneeqparameters.dita | 16 ++--- ...i_irtcengine_setinearmonitoringvolume.dita | 8 +-- .../api_irtcengine_setlocalvoicechanger.dita | 62 +++++++++---------- ..._irtcengine_setlocalvoiceequalization.dita | 8 +-- .../api_irtcengine_setlocalvoiceformant.dita | 16 ++--- .../api_irtcengine_setlocalvoicepitch.dita | 8 +-- .../api_irtcengine_setlocalvoicereverb.dita | 8 +-- ..._irtcengine_setlocalvoicereverbpreset.dita | 40 ++++++------ .../RTC-NG/API/api_irtcengine_setlogfile.dita | 8 +-- .../API/api_irtcengine_setlogfilesize.dita | 8 +-- .../API/api_irtcengine_setlogfilter.dita | 8 +-- .../API/api_irtcengine_setloglevel.dita | 8 +-- .../api_irtcengine_setmaxmetadatasize.dita | 8 +-- ...tcengine_setmixedaudioframeparameters.dita | 10 +-- .../API/api_irtcengine_setparameters.dita | 14 ++--- ...ybackaudioframebeforemixingparameters.dita | 10 +-- ...ngine_setplaybackaudioframeparameters.dita | 10 +-- ...gine_setrecordingaudioframeparameters.dita | 10 +-- ...ngine_setremotedefaultvideostreamtype.dita | 16 ++--- .../api_irtcengine_setremoterendermode.dita | 22 +++---- .../api_irtcengine_setremoterendermode2.dita | 10 +-- ...gine_setremotesubscribefallbackoption.dita | 12 ++-- .../api_irtcengine_setremoteuserpriority.dita | 18 +++--- ...i_irtcengine_setremotevideostreamtype.dita | 12 ++-- ...ine_setremotevideosubscriptionoptions.dita | 32 +++++----- ...api_irtcengine_setremotevoiceposition.dita | 8 +-- ...i_irtcengine_setscreencapturescenario.dita | 10 +-- ...irtcengine_setsubscribeaudioallowlist.dita | 26 ++++---- ...irtcengine_setsubscribeaudioblocklist.dita | 14 ++--- ...irtcengine_setsubscribevideoallowlist.dita | 32 +++++----- ...irtcengine_setsubscribevideoblocklist.dita | 32 +++++----- .../API/api_irtcengine_setvideoscenario.dita | 22 +++---- ...tcengine_setvoicebeautifierparameters.dita | 8 +-- ...i_irtcengine_setvoicebeautifierpreset.dita | 10 +-- ...i_irtcengine_setvoiceconversionpreset.dita | 50 +++++++-------- .../API/api_irtcengine_setvolumeofeffect.dita | 8 +-- .../API/api_irtcengine_startaudiomixing.dita | 12 ++-- .../API/api_irtcengine_startaudiomixing2.dita | 14 ++--- .../api_irtcengine_startaudiorecording.dita | 22 +++---- .../api_irtcengine_startaudiorecording2.dita | 26 ++++---- .../API/api_irtcengine_startechotest2.dita | 12 ++-- ...api_irtcengine_startlastmileprobetest.dita | 8 +-- ..._irtcengine_startlocalvideotranscoder.dita | 18 +++--- ...irtcengine_startmediarenderingtracing.dita | 20 +++--- .../API/api_irtcengine_startpreview.dita | 2 +- .../API/api_irtcengine_startpreview2.dita | 10 +-- ...engine_startrtmpstreamwithtranscoding.dita | 20 +++--- .../API/api_irtcengine_stopalleffects.dita | 8 +-- .../API/api_irtcengine_stopaudiomixing.dita | 8 +-- .../api_irtcengine_stopaudiorecording.dita | 8 +-- .../API/api_irtcengine_stopcameracapture.dita | 14 ++--- .../api_irtcengine_stopchannelmediarelay.dita | 8 +-- ...api_irtcengine_stopdirectcdnstreaming.dita | 6 +- .../API/api_irtcengine_stopechotest.dita | 6 +- .../RTC-NG/API/api_irtcengine_stopeffect.dita | 8 +-- .../api_irtcengine_stoplastmileprobetest.dita | 8 +-- ...i_irtcengine_stoplocalvideotranscoder.dita | 8 +-- .../API/api_irtcengine_stoppreview.dita | 2 +- .../API/api_irtcengine_stoppreview2.dita | 10 +-- .../API/api_irtcengine_stoprhythmplayer.dita | 8 +-- .../API/api_irtcengine_stoprtmpstream.dita | 18 +++--- .../API/api_irtcengine_stopscreencapture.dita | 8 +-- .../api_irtcengine_stopscreencapture2.dita | 20 +++--- .../API/api_irtcengine_switchcamera.dita | 10 +-- .../API/api_irtcengine_takesnapshot.dita | 18 +++--- .../API/api_irtcengine_unloadalleffects.dita | 8 +-- .../API/api_irtcengine_unloadeffect.dita | 8 +-- ...tcengine_unregisteraudioframeobserver.dita | 18 +++--- ...ngine_unregisteraudiospectrumobserver.dita | 10 +-- ...ngine_unregistermediametadataobserver.dita | 8 +-- ..._irtcengine_updatechannelmediaoptions.dita | 6 +- ...pi_irtcengine_updatechannelmediarelay.dita | 8 +-- ...ne_updatelocaltranscoderconfiguration.dita | 10 +-- ..._irtcengine_updatepreloadchanneltoken.dita | 14 ++--- .../api_irtcengine_updatertmptranscoding.dita | 22 +++---- .../API/api_irtcengine_uploadlogfile.dita | 6 +- ...pi_irtcengineex_addpublishstreamurlex.dita | 8 +-- .../api_irtcengineex_addvideowatermarkex.dita | 8 +-- ...neex_adjustuserplaybacksignalvolumeex.dita | 28 ++++----- ...pi_irtcengineex_clearvideowatermarkex.dita | 8 +-- ...ngineex_enableaudiovolumeindicationex.dita | 36 +++++------ ...i_irtcengineex_enablecontentinspectex.dita | 28 ++++----- ...i_irtcengineex_enabledualstreammodeex.dita | 32 +++++----- ...rtcengineex_enableloopbackrecordingex.dita | 28 ++++----- .../API/api_irtcengineex_leavechannelex.dita | 34 +++++----- .../API/api_irtcengineex_leavechannelex2.dita | 40 ++++++------ ...cengineex_muteallremoteaudiostreamsex.dita | 26 ++++---- ...cengineex_muteallremotevideostreamsex.dita | 24 +++---- ...i_irtcengineex_mutelocalaudiostreamex.dita | 26 ++++---- ...i_irtcengineex_mutelocalvideostreamex.dita | 22 +++---- ..._irtcengineex_muteremoteaudiostreamex.dita | 8 +-- ..._irtcengineex_muteremotevideostreamex.dita | 8 +-- ...cengineex_pauseallchannelmediarelayex.dita | 24 +++---- ...engineex_resumeallchannelmediarelayex.dita | 20 +++--- .../api_irtcengineex_sendstreammessageex.dita | 8 +-- ...pi_irtcengineex_setremoterendermodeex.dita | 10 +-- ...tcengineex_setremotevideostreamtypeex.dita | 24 +++---- ...irtcengineex_setremotevoicepositionex.dita | 8 +-- ...engineex_setsubscribeaudioallowlistex.dita | 32 +++++----- ...engineex_setsubscribeaudioblocklistex.dita | 34 +++++----- ...engineex_setsubscribevideoallowlistex.dita | 32 +++++----- ...engineex_setsubscribevideoblocklistex.dita | 32 +++++----- ...engineex_startmediarenderingtracingex.dita | 22 +++---- ...neex_startrtmpstreamwithtranscodingex.dita | 28 ++++----- ..._irtcengineex_stopchannelmediarelayex.dita | 20 +++--- .../api_irtcengineex_stoprtmpstreamex.dita | 22 +++---- .../API/api_irtcengineex_takesnapshotex.dita | 36 +++++------ ...rtcengineex_updatechannelmediarelayex.dita | 26 ++++---- ..._irtcengineex_updatertmptranscodingex.dita | 26 ++++---- .../api_ivideodevicecollection_getdevice.dita | 4 +- .../api_ivideodevicecollection_setdevice.dita | 10 +-- .../api_ivideodevicemanager_getdevice.dita | 6 +- ...deodevicemanager_numberofcapabilities.dita | 10 +-- .../api_ivideodevicemanager_setdevice.dita | 18 +++--- ...i_ivideodevicemanager_startdevicetest.dita | 8 +-- ...pi_ivideodevicemanager_stopdevicetest.dita | 8 +-- .../API/class_contentinspectmodule.dita | 8 +-- 331 files changed, 2207 insertions(+), 2207 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita index 6d5d1397dc0..551dece91d3 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="removeDestChannelInfo"/> + <ph keyref="removeDestChannelInfo" /> Deletes the information of target channel. - + @@ -34,9 +34,9 @@
    -
  • : Success.
    • -
  • : Failure. See for details and resolution suggestions.
    • +
  • : Success.
    • +
  • : Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita index f1e374782f3..1be99d03556 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="setDestChannelInfo"/> + <ph keyref="setDestChannelInfo" /> Sets the information of the target channel. - + @@ -36,10 +36,10 @@ destInfo destinationInfo -

The information of the target channel. See . It contains the following members:

    +

    The information of the target channel. See . It contains the following members:

    • channelName: The name of the target channel.
    • token: The token for joining the target channel. This token is generated with the channelName and uid you set in destInfos.
        -
      • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
        • +
      • If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
      • If you have enabled the App Certificate, you must use the token generated with the channelName and uid.

      If the token of any target channel expires, the whole media relay stops; hence Agora recommends that you specify the same expiration time for the tokens of all the target channels.

    • uid: The unique user ID to identify the relay stream in the target channel. The value ranges from 0 to (2 32-1). To avoid user ID conflicts, this user ID must be different from any other user ID in the target channel. The default value is 0, which means the SDK generates a random user ID.
      • @@ -49,8 +49,8 @@
        -
      • : Success.
        • -
      • : Failure. See for details and resolution suggestions.
        • +
      • : Success.
        • +
      • : Failure. See for details and resolution suggestions.
      diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita index 40d3f4251da..74ed73f5c61 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita @@ -20,7 +20,7 @@ public abstract string GetDevice(); Future<String> getDevice(); -

      +

      Parameters @@ -42,7 +42,7 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      Retrieves the volume of the audio recording device.

      diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita index d97eff7ab46..073711169ca 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita @@ -20,7 +20,7 @@ public abstract int SetDevice(string deviceIdUTF8); Future<void> setDevice(String deviceIdUTF8); -

      +

      Details @@ -35,11 +35,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita index 9839b9e0709..dfb04765049 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita @@ -1,12 +1,12 @@ - <ph keyref="followSystemLoopbackDevice"/> + <ph keyref="followSystemLoopbackDevice" /> Sets whether the loopback device follows the system default playback device. - + @@ -18,9 +18,9 @@ virtual int followSystemLoopbackDevice(bool enable) = 0; abstract followSystemLoopbackDevice(enable: boolean): number; public abstract int FollowSystemLoopbackDevice(bool enable); - - Future<void> followSystemLoopbackDevice(bool enable); -

      + + Future<void> followSystemLoopbackDevice(bool enable); +

      Details @@ -38,17 +38,17 @@ enable Whether to follow the system default audio playback device:
        -
      • : Follow the system default audio playback device. When the default playback device of the system is changed, the SDK immediately switches to the loopback device.
        • -
      • : Do not follow the system default audio playback device. The SDK switches the audio loopback device to the system default audio playback device only when the current audio playback device is disconnected.
        • +
      • : Follow the system default audio playback device. When the default playback device of the system is changed, the SDK immediately switches to the loopback device.
        • +
      • : Do not follow the system default audio playback device. The SDK switches the audio loopback device to the system default audio playback device only when the current audio playback device is disconnected.
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemplaybackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemplaybackdevice.dita index 5c711b901e2..982bc11caa6 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemplaybackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemplaybackdevice.dita @@ -1,12 +1,12 @@ - <ph keyref="followSystemPlaybackDevice"/> + <ph keyref="followSystemPlaybackDevice" /> Sets the audio playback device used by the SDK to follow the system default audio playback device. - + @@ -19,29 +19,29 @@ abstract followSystemPlaybackDevice(enable: boolean): number; public abstract int FollowSystemPlaybackDevice(bool enable); Future<void> followSystemPlaybackDevice(bool enable); -

      +

      Details This method is for Windows and macOS only.
      - <ph keyref="callback-section-title"/> + <ph keyref="callback-section-title" /> enable Whether to follow the system default audio playback device:
        -
      • : Follow the system default audio playback device. The SDK immediately switches the audio playback device when the system default audio playback device changes.
        • -
      • : Do not follow the system default audio playback device. The SDK switches the audio playback device to the system default audio playback device only when the currently used audio playback device is disconnected.
        • +
      • : Follow the system default audio playback device. The SDK immediately switches the audio playback device when the system default audio playback device changes.
        • +
      • : Do not follow the system default audio playback device. The SDK switches the audio playback device to the system default audio playback device only when the currently used audio playback device is disconnected.
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemrecordingdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemrecordingdevice.dita index 9f2364da82e..9144494304b 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemrecordingdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemrecordingdevice.dita @@ -19,7 +19,7 @@ public abstract int FollowSystemRecordingDevice(bool enable); abstract followSystemRecordingDevice(enable: boolean): number; Future<void> followSystemRecordingDevice(bool enable); -

      +

      Details @@ -36,11 +36,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita index dcf2e096498..4435434481f 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita @@ -1,12 +1,12 @@ - <ph keyref="getLoopbackDevice"/> + <ph keyref="getLoopbackDevice" /> Gets the current loopback device. - + @@ -18,9 +18,9 @@ virtual int getLoopbackDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract getLoopbackDevice(): string; public abstract int GetLoopbackDevice(ref string deviceId); - - Future<String> getLoopbackDevice(); -

      + + Future<String> getLoopbackDevice(); +

      Details @@ -37,15 +37,15 @@ deviceId - Output parameter, the ID of the current loopback device.The maximum length is . + Output parameter, the ID of the current loopback device.The maximum length is .
      Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      The ID of the current loopback device.

      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevice.dita index 0a3a28a155d..940ced7f8ae 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevice.dita @@ -20,7 +20,7 @@ public abstract int GetPlaybackDevice(ref string deviceId); abstract getPlaybackDevice(): string; Future<String> getPlaybackDevice(); -

      +

      Details @@ -38,9 +38,9 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      The current audio playback device.

      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdeviceinfo.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdeviceinfo.dita index d406111fd17..0632899360c 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdeviceinfo.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdeviceinfo.dita @@ -20,7 +20,7 @@ public abstract int GetPlaybackDeviceInfo(ref string deviceId, ref string deviceName); abstract getPlaybackDeviceInfo(): AudioDeviceInfo; Future<AudioDeviceInfo> getPlaybackDeviceInfo(); -

      +

      Details @@ -42,9 +42,9 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      An object, which contains the ID and device name of the audio devices.

      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevicemute.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevicemute.dita index 994bb2ad1bd..e1ce1f617dc 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevicemute.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevicemute.dita @@ -20,7 +20,7 @@ public abstract bool GetPlaybackDeviceMute(); abstract getPlaybackDeviceMute(): boolean; Future<bool> getPlaybackDeviceMute(); -

      +

      Parameters @@ -39,7 +39,7 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      • : The audio playback device is muted.
        • diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevicevolume.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevicevolume.dita index 5111a45fef8..b6ae0ee1a58 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevicevolume.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevicevolume.dita @@ -20,7 +20,7 @@ public abstract int GetPlaybackDeviceVolume(); abstract getPlaybackDeviceVolume(): number; Future<int> getPlaybackDeviceVolume(); -

        +

      Parameters @@ -34,7 +34,7 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      The volume of the audio playback device. The value range is [0,255].

      diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita index 5b9eb1f667d..5400c9bc7c9 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita @@ -1,12 +1,12 @@ - <ph keyref="getRecordingDevice"/> + <ph keyref="getRecordingDevice" /> Gets the current audio recording device. - + @@ -20,7 +20,7 @@ public abstract int GetRecordingDevice(ref string deviceId); abstract getRecordingDevice(): string; Future<String> getRecordingDevice(); -

      +

      Details @@ -38,9 +38,9 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      The current audio recording device.

      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdeviceinfo.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdeviceinfo.dita index 4bc145d0be7..1d7e9f19283 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdeviceinfo.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdeviceinfo.dita @@ -20,7 +20,7 @@ public abstract int GetRecordingDeviceInfo(ref string deviceId, ref string deviceName); abstract getRecordingDeviceInfo(): AudioDeviceInfo; Future<AudioDeviceInfo> getRecordingDeviceInfo(); -

      +

      Details @@ -42,9 +42,9 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      An object, which includes the device ID and device name.

      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevicemute.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevicemute.dita index d64cbd145c6..dff7ad2420e 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevicemute.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevicemute.dita @@ -20,7 +20,7 @@ public abstract bool GetRecordingDeviceMute(); abstract getRecordingDeviceMute(): boolean; Future<bool> getRecordingDeviceMute(); -

      +

      Parameters @@ -37,7 +37,7 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      • : The microphone is muted.
        • diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevicevolume.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevicevolume.dita index ef4b26713b3..eaa2f15045a 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevicevolume.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevicevolume.dita @@ -20,7 +20,7 @@ public abstract int GetRecordingDeviceVolume(); abstract getRecordingDeviceVolume(): number; Future<int> getRecordingDeviceVolume(); -

        +

      Parameters @@ -34,7 +34,7 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      The volume of the audio recording device. The value range is [0,255].

      diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita index 4090d5e3459..92ec968f351 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita @@ -1,12 +1,12 @@ - <ph keyref="setLoopbackDevice"/> + <ph keyref="setLoopbackDevice" /> Sets the loopback device. - + @@ -18,9 +18,9 @@ virtual int setLoopbackDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract setLoopbackDevice(deviceId: string): number; public abstract int SetLoopbackDevice(string deviceId); - - Future<void> setLoopbackDevice(String deviceId); -

      + + Future<void> setLoopbackDevice(String deviceId); +

      Details @@ -47,17 +47,17 @@ deviceId -

      Specifies the loopback device of the SDK. You can get the device ID by calling . Connecting or disconnecting the audio device does not change the value of deviceId.

      -

      The maximum length is .

      +

      Specifies the loopback device of the SDK. You can get the device ID by calling . Connecting or disconnecting the audio device does not change the value of deviceId.

      +

      The maximum length is .
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevice.dita index cfed86777a6..90062eb1103 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevice.dita @@ -20,7 +20,7 @@ public abstract int SetPlaybackDevice(string deviceId); abstract setPlaybackDevice(deviceId: string): number; Future<void> setPlaybackDevice(String deviceId); -

      +

      Details @@ -39,11 +39,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicemute.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicemute.dita index efdc041b265..c4305e72252 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicemute.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicemute.dita @@ -20,7 +20,7 @@ public abstract int SetPlaybackDeviceMute(bool mute); abstract setPlaybackDeviceMute(mute: boolean): number; Future<void> setPlaybackDeviceMute(bool mute); -

      +

      Parameters @@ -36,11 +36,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicevolume.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicevolume.dita index 518e163f9ed..bb92f8a556c 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicevolume.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicevolume.dita @@ -20,7 +20,7 @@ public abstract int SetPlaybackDeviceVolume(int volume); abstract setPlaybackDeviceVolume(volume: number): number; Future<void> setPlaybackDeviceVolume(int volume); -

      +

      Parameters @@ -31,11 +31,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevice.dita index 08d1cc1f5ea..e4e1596f287 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevice.dita @@ -20,7 +20,7 @@ public abstract int SetRecordingDevice(string deviceId); abstract setRecordingDevice(deviceId: string): number; Future<void> setRecordingDevice(String deviceId); -

      +

      Details @@ -39,11 +39,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicemute.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicemute.dita index 8663c82b95d..e276a161622 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicemute.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicemute.dita @@ -20,7 +20,7 @@ public abstract int SetRecordingDeviceMute(bool mute); abstract setRecordingDeviceMute(mute: boolean): number; Future<void> setRecordingDeviceMute(bool mute); -

      +

      Parameters @@ -36,11 +36,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita index bd543a74d23..a96c9d528d9 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita @@ -1,12 +1,12 @@ - <ph keyref="setRecordingDeviceVolume"/> + <ph keyref="setRecordingDeviceVolume" /> Sets the volume of the audio capture device. - + @@ -19,8 +19,8 @@ abstract setRecordingDeviceVolume(volume: number): number; public abstract int SetRecordingDeviceVolume(int volume); abstract setRecordingDeviceVolume(volume: number): number; - Future<void> setRecordingDeviceVolume(int volume); -

      + Future<void> setRecordingDeviceVolume(int volume); +

      Details @@ -35,11 +35,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startaudiodeviceloopbacktest.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startaudiodeviceloopbacktest.dita index 54f4b7ff9f8..95388091e27 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startaudiodeviceloopbacktest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startaudiodeviceloopbacktest.dita @@ -20,7 +20,7 @@ public abstract int StartAudioDeviceLoopbackTest(int indicationInterval); abstract startAudioDeviceLoopbackTest(indicationInterval: number): number; Future<void> startAudioDeviceLoopbackTest(int indicationInterval); -

      +

      Details @@ -31,7 +31,7 @@
    • You can call this method either before or after joining a channel.
    • This method only takes effect when called by the host.
    • This method tests local audio devices and does not report the network conditions.
      • -
    • When you finished testing, call to stop the audio device loopback test.
      • +
    • When you finished testing, call to stop the audio device loopback test.
    Parameters @@ -42,11 +42,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startplaybackdevicetest.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startplaybackdevicetest.dita index e0cb329b2e1..5588149db57 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startplaybackdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startplaybackdevicetest.dita @@ -20,7 +20,7 @@ public abstract int StartPlaybackDeviceTest(string testAudioFilePath); abstract startPlaybackDeviceTest(testAudioFilePath: string): number; Future<void> startPlaybackDeviceTest(String testAudioFilePath); -

    +

    Details @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startrecordingdevicetest.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startrecordingdevicetest.dita index cabfee00c66..d0114fb74a1 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startrecordingdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startrecordingdevicetest.dita @@ -1,12 +1,12 @@ - <ph keyref="startRecordingDeviceTest"/> + <ph keyref="startRecordingDeviceTest" /> Starts the audio capture device test. - + @@ -19,12 +19,12 @@ abstract startRecordingDeviceTest(indicationInterval: number): number; public abstract int StartRecordingDeviceTest(int indicationInterval); abstract startRecordingDeviceTest(indicationInterval: number): number; - Future<void> startRecordingDeviceTest(int indicationInterval); -

    + Future<void> startRecordingDeviceTest(int indicationInterval); +

    Details -

    This method tests whether the audio capture device works properly. After calling this method, the SDK triggers the callback at the time interval set in this method, which reports uid = 0 and the volume information of the capturing device.

    +

    This method tests whether the audio capture device works properly. After calling this method, the SDK triggers the callback at the time interval set in this method, which reports uid = 0 and the volume information of the capturing device.

    • This method is for Windows and macOS only.
      • @@ -36,15 +36,15 @@ indicationInterval - The time interval (ms) at which the SDK triggers the callback. Agora recommends setting a value greater than 200 ms. This value must not be less than 10 ms; otherwise, you can not receive the callback. + The time interval (ms) at which the SDK triggers the callback. Agora recommends setting a value greater than 200 ms. This value must not be less than 10 ms; otherwise, you can not receive the callback.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopaudiodeviceloopbacktest.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopaudiodeviceloopbacktest.dita index bf33aadccf6..ffe661d8cb1 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopaudiodeviceloopbacktest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopaudiodeviceloopbacktest.dita @@ -20,7 +20,7 @@ public abstract int StopAudioDeviceLoopbackTest(); abstract stopAudioDeviceLoopbackTest(): number; Future<void> stopAudioDeviceLoopbackTest(); -

    +

    Details @@ -32,11 +32,11 @@
  • Ensure that you call this method to stop the loopback test after calling the method.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
 \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopplaybackdevicetest.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopplaybackdevicetest.dita index 2d8fb181390..715589c5286 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopplaybackdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopplaybackdevicetest.dita @@ -20,7 +20,7 @@ public abstract int StopPlaybackDeviceTest(); abstract stopPlaybackDeviceTest(): number; Future<void> stopPlaybackDeviceTest(); -

+

Details @@ -28,11 +28,11 @@
  • This method is for Windows and macOS only.
  • Ensure that you call this method before joining a channel.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stoprecordingdevicetest.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stoprecordingdevicetest.dita index 96cfc61f3c2..532bcbe1028 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stoprecordingdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stoprecordingdevicetest.dita @@ -1,30 +1,30 @@ - <ph keyref="stopRecordingDeviceTest"/> + <ph keyref="stopRecordingDeviceTest" /> Stops the audio capture device test. - +

- + - (int)stopRecordingDeviceTest; virtual int stopRecordingDeviceTest() = 0; abstract stopRecordingDeviceTest(): number; public abstract int StopRecordingDeviceTest(); abstract stopRecordingDeviceTest(): number; - Future<void> stopRecordingDeviceTest(); -

+ Future<void> stopRecordingDeviceTest(); +

Details -

This method stops the audio capture device test. You must call this method to stop the test after calling the method.

+

This method stops the audio capture device test. You must call this method to stop the test after calling the method.

  • This method is for Windows and macOS only.
    • @@ -32,11 +32,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
 - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita index 9a48e7034cc..8d6cf3e21d7 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita @@ -1,12 +1,12 @@ - <ph keyref="muteAllRemoteAudioStreams_IBaseSpatialAudioEngine"/> + <ph keyref="muteAllRemoteAudioStreams_IBaseSpatialAudioEngine" /> Stops or resumes subscribing to the audio streams of all remote users. - + @@ -20,16 +20,16 @@ public abstract int MuteAllRemoteAudioStreams(bool mute); abstract muteAllRemoteAudioStreams(mute: boolean): number; Future<void> muteAllRemoteAudioStreams(bool mute); -

+

Details

After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.

    -
  • Call this method after .
    • -
  • When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the method in .
    • -
  • After calling this method, you need to call and to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
    • +
  • Call this method after .
    • +
  • When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the method in .
    • +
  • After calling this method, you need to call and to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
Parameters @@ -38,18 +38,18 @@ mute

Whether to stop subscribing to the audio streams of all remote users:

    -
  • : Stop subscribing to the audio streams of all remote users.
    • -
  • : Subscribe to the audio streams of all remote users.
    • +
  • : Stop subscribing to the audio streams of all remote users.
    • +
  • : Subscribe to the audio streams of all remote users.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita index da571d6db49..f2d26fc45c9 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita @@ -1,12 +1,12 @@ - <ph keyref="muteLocalAudioStream_IBaseSpatialAudioEngine"/> + <ph keyref="muteLocalAudioStream_IBaseSpatialAudioEngine" /> Stops or resumes publishing the local audio stream. - + @@ -18,18 +18,18 @@ virtual int muteLocalAudioStream(bool mute) = 0; abstract muteLocalAudioStream(mute: boolean): number; public abstract int MuteLocalAudioStream(bool mute); - + Future<void> muteLocalAudioStream(bool mute); -

+

Details
  • This method does not affect any ongoing audio recording, because it does not disable the audio capture device.
    • -
  • Call this method after .
    • -
  • When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the method in .
    • -
  • A successful call of this method triggers the and callbacks on the remote client.
    • +
  • Call this method after .
    • +
  • When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the method in .
    • +
  • A successful call of this method triggers the and callbacks on the remote client.
Parameters @@ -38,18 +38,18 @@ mute

Whether to stop publishing the local audio stream:

    -
  • : Stop publishing the local audio stream.
    • -
  • : Publish the local audio stream.
    • +
  • : Stop publishing the local audio stream.
    • +
  • : Publish the local audio stream.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita index a51dce106bb..eca5e91ade8 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita @@ -1,12 +1,12 @@ - <ph keyref="muteRemoteAudioStream_IBaseSpatialAudioEngine"/> + <ph keyref="muteRemoteAudioStream_IBaseSpatialAudioEngine" /> Stops or resumes subscribing to the audio stream of a specified user. - + @@ -19,8 +19,8 @@ abstract muteRemoteAudioStream(uid: number, mute: boolean): number; public abstract int MuteRemoteAudioStream(uint uid, bool mute); abstract muteRemoteAudioStream(uid: number, mute: boolean): number; - Future<void> muteRemoteAudioStream({required int uid, required bool mute}); -

+ Future<void> muteRemoteAudioStream({required int uid, required bool mute}); +

Details
@@ -32,8 +32,8 @@

    -
  • Call this method after .
    • -
  • When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the method in .
    • +
  • Call this method after .
    • +
  • When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the method in .

@@ -42,26 +42,26 @@ Parameters - - + + mute

Whether to subscribe to the specified remote user's audio stream.

    -
  • : Stop subscribing to the audio stream of the specified user.
    • -
  • : (Default) Subscribe to the audio stream of the specified user. The SDK decides whether to subscribe according to the distance between the local user and the remote user.
    • +
  • : Stop subscribing to the audio stream of the specified user.
    • +
  • : (Default) Subscribe to the audio stream of the specified user. The SDK decides whether to subscribe according to the distance between the local user and the remote user.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setaudiorecvrange.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setaudiorecvrange.dita index c63509414c6..06827e2336e 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setaudiorecvrange.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setaudiorecvrange.dita @@ -20,7 +20,7 @@ public abstract int SetAudioRecvRange(float range); abstract setAudioRecvRange(range: number): number; Future<void> setAudioRecvRange(double range); -

+

Details @@ -35,11 +35,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita index 2dde4279277..9f6c1e2b8c2 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita @@ -20,7 +20,7 @@ public abstract int SetDistanceUnit(float unit); abstract setDistanceUnit(unit: number): number; Future<void> setDistanceUnit(double unit); -

+

Details @@ -36,11 +36,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita index 5448151311f..dc8811dfce6 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita @@ -20,7 +20,7 @@ public abstract int SetMaxAudioRecvCount(int maxCount); abstract setMaxAudioRecvCount(maxCount: number): number; Future<void> setMaxAudioRecvCount(int maxCount); -

+

Details @@ -38,11 +38,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setplayerattenuation.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setplayerattenuation.dita index 15dc182e461..d5cf63b73c7 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setplayerattenuation.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setplayerattenuation.dita @@ -1,12 +1,12 @@ - <ph keyref="setPlayerAttenuation"/> + <ph keyref="setPlayerAttenuation" /> Sets the sound attenuation properties of the media player. - + @@ -27,11 +27,11 @@ attenuation: number, forceSet: boolean ): number; - Future<void> setPlayerAttenuation( + Future<void> setPlayerAttenuation( {required int playerId, required double attenuation, required bool forceSet}); -

+

Details @@ -46,8 +46,8 @@ Parameters - - + + attenuation @@ -61,20 +61,20 @@ forceSet Whether to force the sound attenuation effect of the media player:
    -
  • : Force attenuation to set the attenuation of the media player. At this time, the attenuation coefficient of the sound insulation are set in the audioAttenuation in the does not take effect for the media player.
    • -
  • : Do not force attenuation to set the sound attenuation effect of the media player, as shown in the following two cases.
      -
    • If the sound source and listener are inside and outside the sound isolation area, the sound attenuation effect is determined by the audioAttenuation in .
      • +
    • : Force attenuation to set the attenuation of the media player. At this time, the attenuation coefficient of the sound insulation are set in the audioAttenuation in the does not take effect for the media player.
      • +
    • : Do not force attenuation to set the sound attenuation effect of the media player, as shown in the following two cases.
        +
      • If the sound source and listener are inside and outside the sound isolation area, the sound attenuation effect is determined by the audioAttenuation in .
      • If the sound source and the listener are in the same sound insulation area or outside the same sound insulation area, the sound attenuation effect is determined by attenuation in this method.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita index f5e78ad34c4..322f0a1e688 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita @@ -1,12 +1,12 @@ - <ph keyref="setZones"/> + <ph keyref="setZones" /> Sets the sound insulation area. - + @@ -19,9 +19,9 @@ abstract setZones(zones: SpatialAudioZone, zoneCount: number): number; public abstract int SetZones(SpatialAudioZone[] zones, uint zoneCount); abstract setZones(zones: SpatialAudioZone, zoneCount: number): number; - Future<void> setZones( + Future<void> setZones( {required SpatialAudioZone zones, required int zoneCount}); -

+

Details @@ -33,8 +33,8 @@

In virtual interactive scenarios, you can use this method to set the sound insulation area and sound attenuation coefficient. When the sound source (which can be the user or the media player) and the listener belong to the inside and outside of the sound insulation area, they can experience the attenuation effect of sound similar to the real environment when it encounters a building partition.

    -
  • When the sound source and the listener belong to the inside and outside of the sound insulation area, the sound attenuation effect is determined by the sound attenuation coefficient in .
    • -
  • If the user or media player is in the same sound insulation area, it is not affected by , and the sound attenuation effect is determined by the attenuation parameter in or . If you do not call or , the default sound attenuation coefficient of the SDK is 0.5, which simulates the attenuation of the sound in the real environment.
    • +
  • When the sound source and the listener belong to the inside and outside of the sound insulation area, the sound attenuation effect is determined by the sound attenuation coefficient in .
    • +
  • If the user or media player is in the same sound insulation area, it is not affected by , and the sound attenuation effect is determined by the attenuation parameter in or . If you do not call or , the default sound attenuation coefficient of the SDK is 0.5, which simulates the attenuation of the sound in the real environment.
  • If the sound source and the receiver belong to two sound insulation areas, the receiver cannot hear the sound source.
If this method is called multiple times, the last sound insulation area set takes effect.
@@ -43,7 +43,7 @@ zones - Sound insulation area settings. See .On the Windows platform, it is necessary to ensure that the number of members in the zones array is equal to the value of zoneCount; otherwise, it may cause a crash. + Sound insulation area settings. See .On the Windows platform, it is necessary to ensure that the number of members in the zones array is equal to the value of zoneCount; otherwise, it may cause a crash. zoneCount @@ -51,11 +51,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita index e14995bd92b..5e4b2933d98 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita @@ -30,12 +30,12 @@ axisRight: number[], axisUp: number[] ): number; - Future<void> updateSelfPosition( - {required List<double> position, - required List<double> axisForward, - required List<double> axisRight, - required List<double> axisUp}); -

+ Future<void> updateSelfPosition( + {required List<double> position, + required List<double> axisForward, + required List<double> axisRight, + required List<double> axisUp}); +

Details @@ -73,11 +73,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_clearremotepositions.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_clearremotepositions.dita index 95762b621df..2e73d3badfc 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_clearremotepositions.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_clearremotepositions.dita @@ -20,7 +20,7 @@ public abstract int ClearRemotePositions(); abstract clearRemotePositions(): number; Future<void> clearRemotePositions(); -

+

Details @@ -28,11 +28,11 @@

After leaving the channel, to avoid wasting resources, you can also call this method to delete the spatial positions of all remote users.

- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita index 0940d3f18ea..3001d240dba 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita @@ -20,7 +20,7 @@ public abstract int RemoveRemotePosition(uint uid); abstract removeRemotePosition(uid: number): number; Future<void> removeRemotePosition(int uid); -

+

Details @@ -36,11 +36,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_setremoteaudioattenuation.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_setremoteaudioattenuation.dita index 5d8a979ef52..f547fda89ad 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_setremoteaudioattenuation.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_setremoteaudioattenuation.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteAudioAttenuation"/> + <ph keyref="setRemoteAudioAttenuation" /> Sets the sound attenuation effect for the specified user. - + @@ -27,9 +27,9 @@ attenuation: number, forceSet: boolean ): number; - Future<void> setRemoteAudioAttenuation( + Future<void> setRemoteAudioAttenuation( {required int uid, required double attenuation, required bool forceSet}); -

+

Details @@ -39,37 +39,37 @@
v4.0.1
-

+

Parameters - - + + attenuation For the user's sound attenuation coefficient, the value range is [0,1]. The values are as follows:
    -
  • +
forceSet Whether to force the user's sound attenuation effect:
    -
  • : Force attenuation to set the sound attenuation of the user. At this time, the attenuation coefficient of the sound insulation area set in the audioAttenuation of the does not take effect for the user.
    • -
  • : Do not force attenuation to set the user's sound attenuation effect, as shown in the following two cases.
      -
    • +
    • : Force attenuation to set the sound attenuation of the user. At this time, the attenuation coefficient of the sound insulation area set in the audioAttenuation of the does not take effect for the user.
      • +
    • : Do not force attenuation to set the user's sound attenuation effect, as shown in the following two cases.
        +
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita index 930529a15b9..414bf70873c 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="destroyCustomAudioTrack"/> + <ph keyref="destroyCustomAudioTrack" /> Destroys the specified audio track. - + @@ -19,8 +19,8 @@ abstract destroyCustomAudioTrack(trackId: number): number; public abstract int DestroyCustomAudioTrack(uint trackId); abstract destroyCustomAudioTrack(trackId: number): number; - Future<void> destroyCustomAudioTrack(int trackId); -

+ Future<void> destroyCustomAudioTrack(int trackId); +

Details @@ -36,15 +36,15 @@ trackId - The custom audio track ID returned in . + The custom audio track ID returned in .
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita index ae043251c43..a8937fc9c41 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita @@ -1,12 +1,12 @@ - <ph keyref="pullAudioFrame"/> + <ph keyref="pullAudioFrame" /> Pulls the remote audio data. - + @@ -21,19 +21,19 @@ public abstract int PullAudioFrame(AudioFrame frame); abstract pullAudioFrame(): AudioFrame; Future<void> pullAudioFrame(AudioFrame frame); -

+

Details -

Before calling this method, you need to call to notify the app to enable and set the external rendering.

+

Before calling this method, you need to call to notify the app to enable and set the external rendering.

After a successful method call, the app pulls the decoded and mixed audio data for playback.

  • This method only supports pulling data from custom audio source. If you need to pull the data captured by the SDK, do not call this method.
  • Call this method after joining a channel.
    • -
  • Once you enable the external audio sink, the app will not retrieve any audio data from the callback.
    • -
  • The difference between this method and the callback is as follows:
      -
    • The SDK sends the audio data to the app through the callback. Any delay in processing the audio frames may result in audio jitter.
      • +
    • Once you enable the external audio sink, the app will not retrieve any audio data from the callback.
      • +
    • The difference between this method and the callback is as follows:
        +
      • The SDK sends the audio data to the app through the callback. Any delay in processing the audio frames may result in audio jitter.
      • After a successful method call, the app automatically pulls the audio data from the SDK. After setting the audio data parameters, the SDK adjusts the frame buffer and avoids problems caused by jitter in the external audio playback.
@@ -42,7 +42,7 @@ frame - Pointers to . + Pointers to . data @@ -50,23 +50,23 @@ lengthInByte - The data length (byte). The value of this parameter is related to the audio duration, and the values of the sampleRate and channels parameters that you set in . lengthInByte = sampleRate/1000 × 2 × channels × audio duration (ms). + The data length (byte). The value of this parameter is related to the audio duration, and the values of the sampleRate and channels parameters that you set in . lengthInByte = sampleRate/1000 × 2 × channels × audio duration (ms).
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
    -
  • : Success.
    • -
  • : Failure. See for details and resolution suggestions.
    • +
  • : Success.
    • +
  • : Failure. See for details and resolution suggestions.
  • The instance, if the method call succeeds.
  • An error code, if the call fails,.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita index 162d02dce03..2c07f26ddee 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita @@ -29,9 +29,9 @@ sampleRate: number, channels: number ): number; - Future<void> setExternalAudioSink( + Future<void> setExternalAudioSink( {required bool enabled, required int sampleRate, required int channels}); -

+

Details @@ -69,11 +69,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita index d9e67e44483..c882b72019b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita @@ -1,12 +1,12 @@ - <ph keyref="setExternalAudioSource2"/> + <ph keyref="setExternalAudioSource2" /> Sets the external audio source parameters. - + @@ -39,13 +39,13 @@ localPlayback?: boolean, publish?: boolean ): number; - Future<void> setExternalAudioSource( + Future<void> setExternalAudioSource( {required bool enabled, required int sampleRate, required int channels, bool localPlayback = false, bool publish = true}); -

+

Details @@ -63,8 +63,8 @@ enabled

Whether to enable the external audio source:

    -
  • : Enable the external audio source.
    • -
  • : (Default) Disable the external audio source.
    • +
  • : Enable the external audio source.
    • +
  • : (Default) Disable the external audio source.

 @@ -80,8 +80,8 @@ localPlayback

Whether to play the external audio source:

    -
  • : Play the external audio source.
    • -
  • : (Default) Do not play the external source.
    • +
  • : Play the external audio source.
    • +
  • : (Default) Do not play the external source.

 @@ -89,18 +89,18 @@ publish

Whether to publish audio to the remote users:

    -
  • : (Default) Publish audio to the remote users.
    • -
  • : Do not publish audio to the remote users.
    • +
  • : (Default) Publish audio to the remote users.
    • +
  • : Do not publish audio to the remote users.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita index 2285a5f3e1b..171b8301bcb 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita @@ -32,12 +32,12 @@ sourceType?: ExternalVideoSourceType, encodedVideoOption?: SenderOptions ): number; - Future<void> setExternalVideoSource( + Future<void> setExternalVideoSource( {required bool enabled, required bool useTexture, ExternalVideoSourceType sourceType = ExternalVideoSourceType.videoFrame, SenderOptions encodedVideoOption = const SenderOptions()}); -

+

Details @@ -70,11 +70,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita index 1a963ce609d..211d08fa6e0 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="unregisterAudioFrameObserver_IMediaEngine"/> + <ph keyref="unregisterAudioFrameObserver_IMediaEngine" /> Unregisters an audio frame observer. - + @@ -17,10 +17,10 @@ abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; - + abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; void unregisterAudioFrameObserver(AudioFrameObserver observer); -

+

Parameters @@ -31,12 +31,12 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita index e007c0909f5..28d65a834bc 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="unregisterVideoEncodedFrameObserver"/> + <ph keyref="unregisterVideoEncodedFrameObserver" /> Unregisters a receiver object for the encoded video frame. - + @@ -24,22 +24,22 @@ observer: IVideoEncodedFrameObserver ): number; void unregisterVideoEncodedFrameObserver(VideoEncodedFrameObserver observer); -

+

Parameters observer - The video observer, reporting the reception of each video frame. See . + The video observer, reporting the reception of each video frame. See .
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita index e897daa3624..4b8bc590185 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="unregisterVideoFrameObserver_IMediaEngine"/> - Unregisters the video frame observer. + <ph keyref="unregisterVideoFrameObserver_IMediaEngine" /> + Unregisters the video frame observer. - + @@ -20,23 +20,23 @@ public abstract int UnRegisterVideoFrameObserver(); abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number; void unregisterVideoFrameObserver(VideoFrameObserver observer); -

+

Parameters observer - The video observer, reporting the reception of each video frame. See . + The video observer, reporting the reception of each video frame. See .
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita index f94c926c196..f98b0422a68 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita @@ -20,7 +20,7 @@ public abstract int AdjustPlayoutVolume(int volume); abstract adjustPlayoutVolume(volume: number): number; Future<void> adjustPlayoutVolume(int volume); -

+

Parameters @@ -34,11 +34,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita index fd4c70570d1..7753366f175 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita @@ -20,7 +20,7 @@ public abstract int AdjustPublishSignalVolume(int volume); abstract adjustPublishSignalVolume(volume: number): number; Future<void> adjustPublishSignalVolume(int volume); -

+

Details @@ -39,11 +39,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita index 6c4f785fdc3..59804567fa9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita @@ -20,7 +20,7 @@ public abstract int EnableAutoSwitchAgoraCDN(bool enable); abstract enableAutoSwitchAgoraCDN(enable: boolean): number; Future<void> enableAutoSwitchAgoraCDN(bool enable); -

+

Details @@ -40,11 +40,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getduration.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getduration.dita index 655942647b7..79b5ad35369 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getduration.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getduration.dita @@ -20,7 +20,7 @@ public abstract int GetDuration(ref Int64 duration); abstract getDuration(): number; Future<int> getDuration(); -

+

Parameters @@ -34,12 +34,12 @@ Returns
  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.

The total duration (ms) of the media file.

  • If the method call succeeds, the SDK returns the total duration(ms) of the media file.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita index f00baee8507..403928f350b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita @@ -20,7 +20,7 @@ public abstract int GetMute(ref bool muted); abstract getMute(): boolean; Future<bool> getMute(); -

+

Parameters @@ -38,10 +38,10 @@ Returns
  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
  • : Reports whether the media resource is muted.
  • : Reports whether the media resource is muted.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita index 3875ba36879..c4d4dd1c9f8 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita @@ -20,7 +20,7 @@ public abstract int GetPlayoutVolume(ref int volume); abstract getPlayoutVolume(): number; Future<int> getPlayoutVolume(); -

+

Parameters @@ -37,11 +37,11 @@ Returns
  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.

The local playback volume, which ranges from 0 to 100.

  • 0: Mute.
  • 100: (Default) The original volume.

- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita index cb8c0b33010..567afc2ca9e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita @@ -20,7 +20,7 @@ public abstract int GetPublishSignalVolume(ref int volume); abstract getPublishSignalVolume(): number; Future<int> getPublishSignalVolume(); -

+

Parameters @@ -34,11 +34,11 @@ Returns
  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
  • ≥ 0: The remote playback volume.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita index 0a48cb19abb..9809e60e017 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita @@ -20,7 +20,7 @@ public abstract int GetStreamInfo(Int64 index, ref PlayerStreamInfo info); abstract getStreamInfo(index: number): PlayerStreamInfo; Future<PlayerStreamInfo> getStreamInfo(int index); -

+

Details @@ -47,7 +47,7 @@
  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita index 5784b65738f..71d6a1cfec1 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita @@ -20,7 +20,7 @@ public abstract int Mute(bool muted); abstract mute(muted: boolean): number; Future<void> mute(bool muted); -

+

Parameters @@ -35,11 +35,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita index 4c646236b48..a44b74b704b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita @@ -22,7 +22,7 @@ public abstract int Open(string url, Int64 startPos); abstract open(url: string, startPos: number): number; Future<void> open({required String url, required int startPos}); -

+

Details @@ -46,11 +46,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita index b77f4a62e74..26988dc27aa 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita @@ -24,7 +24,7 @@ abstract openWithAgoraCDNSrc(src: string, startPos: number): number; Future<void> openWithAgoraCDNSrc( {required String src, required int startPos}); -

+

Details @@ -54,11 +54,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita index 46ea80348fb..d2f38fb65ce 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita @@ -20,11 +20,11 @@ public abstract int OpenWithMediaSource(MediaSource source); abstract openWithMediaSource(source: MediaSource): number; Future<void> openWithMediaSource(MediaSource source); -

+

Details

This method supports opening media files of different sources, including a custom media source, and allows you to configure the playback scenarios.

-

+

Parameters @@ -35,11 +35,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita index 0d6fa5cff7d..4ae537bab8f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita @@ -22,14 +22,14 @@ public abstract int Pause(); abstract pause(): number; Future<void> pause(); -

+

- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita index ed8a27fc819..2f3133e907a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita @@ -20,18 +20,18 @@ public abstract int Play(); abstract play(): number; Future<void> play(); -

+

Details

After calling or , you can call this method to play the media file.

- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita index 32c36559728..1771724c048 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita @@ -23,7 +23,7 @@ public abstract int PlayPreloadedSrc(string src); abstract playPreloadedSrc(src: string): number; Future<void> playPreloadedSrc(String src); -

+

Details @@ -41,11 +41,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita index d162df568c4..b7e8a359fad 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita @@ -23,7 +23,7 @@ public abstract int PreloadSrc(string src, Int64 startPos); abstract preloadSrc(src: string, startPos: number): number; Future<void> preloadSrc({required String src, required int startPos}); -

+

Details @@ -46,11 +46,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita index c5b4599582e..26da8e2d3c5 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerAudioFrameObserver1_IMediaPlayer"/> + <ph keyref="registerAudioFrameObserver1_IMediaPlayer" /> Registers a PCM audio frame observer object. - + @@ -18,28 +18,28 @@ virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink* observer) = 0; public abstract int RegisterAudioFrameObserver(IAudioPcmFrameSink observer); - - -

+ + +

Details -

You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

+

You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

Parameters observer - The audio frame observer, reporting the reception of each audio frame. See . + The audio frame observer, reporting the reception of each audio frame. See .
- <ph keyref="return-section-title"/> + <ph keyref="return-section-title" />
  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita index 6dbe99edb9a..11867289361 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita @@ -1,12 +1,12 @@ - <ph keyref="registerAudioFrameObserver2_IMediaPlayer"/> + <ph keyref="registerAudioFrameObserver2_IMediaPlayer" /> Registers an audio frame observer object. - + @@ -15,7 +15,7 @@

int registerAudioFrameObserver(IMediaPlayerAudioFrameObserver audioFrameObserver, int mode); - + virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink* observer, RAW_AUDIO_FRAME_OP_MODE_TYPE mode) = 0; abstract registerAudioFrameObserver( @@ -31,7 +31,7 @@ {required AudioPcmFrameSink observer, RawAudioFrameOpModeType mode = RawAudioFrameOpModeType.rawAudioFrameOpModeReadOnly}); -

+

Parameters @@ -40,28 +40,28 @@ audioFrameObserver observer -

The audio frame observer, reporting the reception of each audio frame. See .

-

The audio frame observer, reporting the reception of each audio frame. See .

+

The audio frame observer, reporting the reception of each audio frame. See .

+

The audio frame observer, reporting the reception of each audio frame. See .

 mode -

The use mode of the audio frame. See .

+

The use mode of the audio frame. See .

The use mode of the audio frame:

    -
  • (0): (Default) Read only mode. For example, when users acquire the data with the Agora SDK, then push the RTMP or RTMPS streams.
    • -
  • (2): Read and write mode: Users read the data from AudioFrame, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
    • +
  • (0): (Default) Read only mode. For example, when users acquire the data with the Agora SDK, then push the RTMP or RTMPS streams.
    • +
  • (2): Read and write mode: Users read the data from AudioFrame, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
Returns -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita index 5e53d71a153..828efabde4a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita @@ -25,7 +25,7 @@ observer: IMediaPlayerSourceObserver ): number; void registerPlayerSourceObserver(MediaPlayerSourceObserver observer); -

+

Parameters @@ -37,11 +37,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita index cb96cc9e62b..48f1719625d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita @@ -23,7 +23,7 @@ public abstract int RenewAgoraCDNSrcToken(string token, Int64 ts); abstract renewAgoraCDNSrcToken(token: string, ts: number): number; Future<void> renewAgoraCDNSrcToken({required String token, required int ts}); -

+

Details @@ -45,11 +45,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita index 24c4f41fdc7..fc25ad649e9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita @@ -20,14 +20,14 @@ public abstract int Resume(); abstract resume(): number; Future<void> resume(); -

+

- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita index b572c5a1cdd..ea31b91ec98 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita @@ -22,7 +22,7 @@ public abstract int Seek(Int64 newPos); abstract seek(newPos: number): number; Future<void> seek(int newPos); -

+

Details @@ -42,11 +42,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita index 84caca8440f..4b3e74cdb6e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita @@ -20,7 +20,7 @@ public abstract int SelectAudioTrack(int index); abstract selectAudioTrack(index: number): number; Future<void> selectAudioTrack(int index); -

+

Details @@ -35,11 +35,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_selectinternalsubtitle.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_selectinternalsubtitle.dita index dc8a9c9a070..5cb40d731e4 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_selectinternalsubtitle.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_selectinternalsubtitle.dita @@ -1,12 +1,12 @@ - <ph keyref="selectInternalSubtitle"/> + <ph keyref="selectInternalSubtitle" /> Select internal subtitles in the video. - + @@ -20,9 +20,9 @@ virtual int selectInternalSubtitle(int index) = 0; public abstract int SelectInternalSubtitle(int playerId, int index); - - -

+ + +

Details @@ -45,7 +45,7 @@ Returns
  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita index df234c1d1ee..c6a710a7a74 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita @@ -20,7 +20,7 @@ public abstract int SetAudioDualMonoMode(AUDIO_DUAL_MONO_MODE mode); abstract setAudioDualMonoMode(mode: AudioDualMonoMode): number; Future<void> setAudioDualMonoMode(AudioDualMonoMode mode); -

+

Details @@ -44,11 +44,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita index 279e86ea10e..232adca82ee 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita @@ -20,7 +20,7 @@ public abstract int SetAudioPitch(int pitch); abstract setAudioPitch(pitch: number): number; Future<void> setAudioPitch(int pitch); -

+

Details @@ -34,11 +34,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita index bcff0820b19..9612ce18868 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita @@ -22,7 +22,7 @@ public abstract int SetLoopCount(int loopCount); abstract setLoopCount(loopCount: number): number; Future<void> setLoopCount(int loopCount); -

+

Details @@ -38,11 +38,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita index 301cfeec22c..bfab06bdf8a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita @@ -20,7 +20,7 @@ public abstract int SetPlaybackSpeed(int speed); abstract setPlaybackSpeed(speed: number): number; Future<void> setPlaybackSpeed(int speed); -

+

Details @@ -39,11 +39,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita index 8164b7ce901..a69d75ee283 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita @@ -1,12 +1,12 @@ - <ph keyref="setPlayerOption"/> + <ph keyref="setPlayerOption" /> Sets the private options for the media player. - + @@ -20,16 +20,16 @@ abstract setPlayerOptionInInt(key: string, value: number): number; public abstract int SetPlayerOption(string key, int value); abstract setPlayerOptionInInt(key: string, value: number): number; - Future<void> setPlayerOptionInInt({required String key, required int value}); -

+ Future<void> setPlayerOptionInInt({required String key, required int value}); +

Details

The media player supports setting private options by key and value. Under normal circumstances, you do not need to know the private option settings, and just use the default option settings.

    -
  • Ensure that you call this method before .
    • -
  • If you need to push streams with SEI into the CDN, call ("sei_data_with_uuid", 1); otherwise, the loss of SEI might occurs.
    • +
  • Ensure that you call this method before .
    • +
  • If you need to push streams with SEI into the CDN, call ("sei_data_with_uuid", 1); otherwise, the loss of SEI might occurs.
Parameters @@ -44,11 +44,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita index 2e6a1eb4f1e..4329768a833 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita @@ -22,7 +22,7 @@ public abstract int SetView(); abstract setView(view: any): number; Future<void> setView(int view); -

+

Parameters @@ -34,11 +34,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita index ead19837ebe..f562a3a7e91 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita @@ -21,14 +21,14 @@ public abstract int Stop(); abstract stop(): number; Future<void> stop(); -

+

- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnlinebyindex.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnlinebyindex.dita index 4696e50bb3d..db53dbf4b46 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnlinebyindex.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnlinebyindex.dita @@ -23,7 +23,7 @@ public abstract int SwitchAgoraCDNLineByIndex(int index); abstract switchAgoraCDNLineByIndex(index: number): number; Future<void> switchAgoraCDNLineByIndex(int index); -

+

Details @@ -42,11 +42,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnsrc.dita index 3dda48e5aa6..4db0131377b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnsrc.dita @@ -23,7 +23,7 @@ public abstract int SwitchAgoraCDNSrc(string src, bool syncPts = false); abstract switchAgoraCDNSrc(src: string, syncPts?: boolean): number; Future<void> switchAgoraCDNSrc({required String src, bool syncPts = false}); -

+

Details @@ -55,11 +55,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita index 3cf1b00c7c7..ca488800d66 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita @@ -23,7 +23,7 @@ public abstract int SwitchSrc(string src, bool syncPts = true); abstract switchSrc(src: string, syncPts?: boolean): number; Future<void> switchSrc({required String src, bool syncPts = true}); -

+

Details @@ -60,11 +60,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita index ba648826e1c..3c18bf99c5c 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita @@ -23,7 +23,7 @@ public abstract int UnloadSrc(string src); abstract unloadSrc(src: string): number; Future<void> unloadSrc(String src); -

+

Details @@ -41,11 +41,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_unregisteraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_unregisteraudioframeobserver.dita index 50434487a54..1279318b101 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregisteraudioframeobserver.dita @@ -20,23 +20,23 @@ public abstract int UnregisterAudioFrameObserver(); abstract unregisterAudioFrameObserver(observer: IAudioPcmFrameSink): number; void unregisterAudioFrameObserver(AudioPcmFrameSink observer); -

+

Parameters observer - The audio observer. See . + The audio observer. See .
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita index d831a1ab374..3a6877ba900 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita @@ -24,15 +24,15 @@ observer: IMediaPlayerSourceObserver ): number; void unregisterPlayerSourceObserver(MediaPlayerSourceObserver observer); -

+

- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita index bff110cb471..bd3fbb0a092 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="unregisterVideoFrameObserver_IMediaPlayer"/> + <ph keyref="unregisterVideoFrameObserver_IMediaPlayer" /> Unregisters the video frame observer. - + @@ -24,22 +24,22 @@ observer: IMediaPlayerVideoFrameObserver ): number; void unregisterVideoFrameObserver(MediaPlayerVideoFrameObserver observer); -

+

Parameters observer - The video observer, reporting the reception of each video frame. See . + The video observer, reporting the reception of each video frame. See .
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita index e441a33bc12..ab9697cd3f0 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita @@ -1,12 +1,12 @@ - <ph keyref="removeAllCaches"/> + <ph keyref="removeAllCaches" /> Deletes all cached media files in the media player. - + @@ -19,8 +19,8 @@ abstract removeAllCaches(): number; public abstract int RemoveAllCaches(); abstract removeAllCaches(): number; - Future<void> removeAllCaches(); -

+ Future<void> removeAllCaches(); +

Details @@ -28,11 +28,11 @@

The cached media file currently being played will not be deleted.

- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See .
    • +
  • < 0: Failure. See .
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita index 8dd61f9d191..4f64c5d5753 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="setMediaRecorderObserver"/> - Registers one oberver. + <ph keyref="setMediaRecorderObserver" /> + Registers one oberver. - + @@ -19,17 +19,17 @@ abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number; public abstract int SetMediaRecorderObserver(IMediaRecorderObserver callback); abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number; - Future<void> setMediaRecorderObserver( + Future<void> setMediaRecorderObserver( {required RtcConnection connection, required MediaRecorderObserver callback}); -

+

Details

This method is used to set the callbacks of audio and video recording, so as to notify the app of the recording status and information of the audio and video stream during recording.

Before calling this method, ensure the following:

    -
  • The object is created and initialized.
    • -
  • The recording object is created through .
    • +
  • The object is created and initialized.
    • +
  • The recording object is created through .

@@ -38,15 +38,15 @@ callback delegate - The callbacks for recording audio and video streams. See . + The callbacks for recording audio and video streams. See .
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita index 21021cead23..b4fae1d0a96 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita @@ -1,12 +1,12 @@ - <ph keyref="stopRecording"/> + <ph keyref="stopRecording" /> Stops recording audio and video streams. - + @@ -20,19 +20,19 @@ public abstract int StopRecording(); abstract stopRecording(): number; Future<void> stopRecording(); -

+

Details - After calling , if you want to stop the recording, you must call this method; otherwise, the generated recording files may not be playable.
+ After calling , if you want to stop the recording, you must call this method; otherwise, the generated recording files may not be playable.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
  • < 0: Failure.
      -
    • -7: The method is called before is initialized. Ensure the object is created before calling this method.
      • +
    • -7: The method is called before is initialized. Ensure the object is created before calling this method.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita index 1de45539f2c..1f012b33859 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita @@ -1,12 +1,12 @@ - <ph keyref="addHandler"/> + <ph keyref="addHandler" /> Adds event handlers - + @@ -22,11 +22,11 @@ public abstract int InitEventHandler(IRtcEngineEventHandler engineEventHandler); abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean; void registerEventHandler(RtcEngineEventHandler eventHandler); -

+

Details -

The SDK uses the class to send callbacks to the app. The app inherits the methods of this class to receive these callbacks. All methods in this class have default (empty) implementations. Therefore, apps only need to inherits callbacks according to the scenarios. In the callbacks, avoid time-consuming tasks or calling APIs that can block the thread, such as the method. +

The SDK uses the class to send callbacks to the app. The app inherits the methods of this class to receive these callbacks. All methods in this class have default (empty) implementations. Therefore, apps only need to inherits callbacks according to the scenarios. In the callbacks, avoid time-consuming tasks or calling APIs that can block the thread, such as the method. Otherwise, the SDK may not work properly.

@@ -36,20 +36,20 @@ Otherwise, the SDK may not work properly.

handler engineEventHandler eventHandler - Callback events to be added. See . + Callback events to be added. See .
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
    -
  • : Success.
    • -
  • : Failure. See for details and resolution suggestions.
    • +
  • : Success.
    • +
  • : Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addinjectstreamurl.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addinjectstreamurl.dita index bd234ea3536..6fba62b724e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addinjectstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addinjectstreamurl.dita @@ -21,7 +21,7 @@ Future<void> addInjectStreamUrl( {required String url, required InjectStreamConfig config}); -

+

Details @@ -53,8 +53,8 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
  • < 0: Failure.
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita index 494ccead409..f3067a3764b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita @@ -24,7 +24,7 @@ ): number; Future<void> addPublishStreamUrl( {required String url, required bool transcodingEnabled}); -

      +

Details @@ -60,8 +60,8 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
  • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita index 0cd95ed4af7..030e1d48ddb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita @@ -23,7 +23,7 @@ options: WatermarkOptions ): number; Future<void> addVideoWatermark(RtcImage watermark); -

    +

Details @@ -50,11 +50,11 @@ Use instead.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita index 4594dd5933e..8c8eb728b8c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita @@ -1,12 +1,12 @@ - <ph keyref="addVideoWatermark2"/> + <ph keyref="addVideoWatermark2" /> Adds a watermark image to the local video. - + @@ -27,23 +27,23 @@ ): number; Future<void> addVideoWatermark( {required String watermarkUrl, required WatermarkOptions options}); -

+

Details

This method adds a PNG watermark image to the local video in the live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), and the capturing device can see and capture it. The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one.

-

The watermark coordinates are dependent on the settings in the method:

    -
  • If the orientation mode of the encoding video () is fixed landscape mode or the adaptive landscape mode, the watermark uses the landscape orientation.
    • -
  • If the orientation mode of the encoding video () is fixed portrait mode or the adaptive portrait mode, the watermark uses the portrait orientation.
    • -
  • When setting the watermark position, the region must be less than the dimensions set in the method; otherwise, the watermark image will be cropped.
    • +

    The watermark coordinates are dependent on the settings in the method:

      +
    • If the orientation mode of the encoding video () is fixed landscape mode or the adaptive landscape mode, the watermark uses the landscape orientation.
      • +
    • If the orientation mode of the encoding video () is fixed portrait mode or the adaptive portrait mode, the watermark uses the portrait orientation.
      • +
    • When setting the watermark position, the region must be less than the dimensions set in the method; otherwise, the watermark image will be cropped.

      -
    • Ensure that calling this method after .
      • -
    • If you only want to add a watermark to the media push, you can call this method or the method.
      • +
    • Ensure that calling this method after .
      • +
    • If you only want to add a watermark to the media push, you can call this method or the method.
    • This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray.
    • If the dimensions of the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings.
      • -
    • If you have enabled the local video preview by calling the method, you can use the visibleInPreview member to set whether or not the watermark is visible in the preview.
      • +
    • If you have enabled the local video preview by calling the method, you can use the visibleInPreview member to set whether or not the watermark is visible in the preview.
    • If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer.
@@ -56,15 +56,15 @@ options - The options of the watermark image to be added. See . + The options of the watermark image to be added. See .
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita index 7dca3b5eb68..244429188ab 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita @@ -20,7 +20,7 @@ public abstract int AdjustAudioMixingPlayoutVolume(int volume); abstract adjustAudioMixingPlayoutVolume(volume: number): number; Future<void> adjustAudioMixingPlayoutVolume(int volume); -

+

Details @@ -34,11 +34,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita index d03a7cda650..e32f1afa859 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita @@ -20,7 +20,7 @@ public abstract int AdjustAudioMixingPublishVolume(int volume); abstract adjustAudioMixingPublishVolume(volume: number): number; Future<void> adjustAudioMixingPublishVolume(int volume); -

+

Details @@ -37,11 +37,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita index b12e8216b51..9369cbdccdf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita @@ -1,12 +1,12 @@ - <ph keyref="adjustAudioMixingVolume"/> + <ph keyref="adjustAudioMixingVolume" /> Adjusts the volume during audio mixing. - + @@ -20,15 +20,15 @@ public abstract int AdjustAudioMixingVolume(int volume); abstract adjustAudioMixingVolume(volume: number): number; Future<void> adjustAudioMixingVolume(int volume); -

+

Details

This method adjusts the audio mixing volume on both the local client and remote clients.

    -
  • Call this method after .
    • -
  • This method does not affect the playback volume you set through the method.
    • +
  • Call this method after .
    • +
  • This method does not affect the playback volume you set through the method.
Parameters @@ -39,11 +39,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudioplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudioplayoutvolume.dita index 50e6b3347c9..c131628a9cf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudioplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudioplayoutvolume.dita @@ -1,7 +1,7 @@ - <ph keyref="adjustCustomAudioPlayoutVolume"/> + <ph keyref="adjustCustomAudioPlayoutVolume" /> Adjusts the volume of the custom audio track played locally. @@ -25,9 +25,9 @@ trackId: number, volume: number ): number; - Future<void> adjustCustomAudioPlayoutVolume( + Future<void> adjustCustomAudioPlayoutVolume( {required int trackId, required int volume}); -

+

Details @@ -38,20 +38,20 @@ Parameters - - + + - - + +
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita index 89faf1a6700..bd9940f6328 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita @@ -25,9 +25,9 @@ trackId: number, volume: number ): number; - Future<void> adjustCustomAudioPublishVolume( + Future<void> adjustCustomAudioPublishVolume( {required int trackId, required int volume}); -

+

Details @@ -39,7 +39,7 @@ trackId - The audio track ID. Set this parameter to the custom audio track ID returned in . + The audio track ID. Set this parameter to the custom audio track ID returned in . volume @@ -47,11 +47,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita index 55cf9d47653..59023c85e94 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita @@ -21,7 +21,7 @@ public abstract int AdjustLoopbackSignalVolume(int volume); abstract adjustLoopbackSignalVolume(volume: number): number; Future<void> adjustLoopbackSignalVolume(int volume); -

+

Details @@ -36,11 +36,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita index b3bea1cdb03..1acb74a69df 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita @@ -20,7 +20,7 @@ public abstract int AdjustPlaybackSignalVolume(int volume); abstract adjustPlaybackSignalVolume(volume: number): number; Future<void> adjustPlaybackSignalVolume(int volume); -

+

Details @@ -38,11 +38,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita index 4d8aad6ef23..9bb7d6d6bf7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita @@ -20,7 +20,7 @@ public abstract int AdjustRecordingSignalVolume(int volume); abstract adjustRecordingSignalVolume(volume: number): number; Future<void> adjustRecordingSignalVolume(int volume); -

+

Details @@ -34,7 +34,7 @@ volume

The volume of the user. The value range is [0,400].

    -
  • 0: Mute.If you only need to mute the audio signal, Agora recommends that you use instead.
    • +
  • 0: Mute.If you only need to mute the audio signal, Agora recommends that you use instead.
  • 100: (Default) The original volume.
  • 400: Four times the original volume (amplifying the audio signals by four times).

@@ -42,11 +42,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita index ceffe8589c4..289e79fad85 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita @@ -21,7 +21,7 @@ abstract adjustUserPlaybackSignalVolume(uid: number, volume: number): number; Future<void> adjustUserPlaybackSignalVolume( {required int uid, required int volume}); -

+

Details @@ -44,11 +44,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita b/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita index d4f77afa504..50115b32d81 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita @@ -20,14 +20,14 @@ public abstract int ClearVideoWatermarks(); abstract clearVideoWatermarks(): number; Future<void> clearVideoWatermarks(); -

+

- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_complain.dita b/en-US/dita/RTC-NG/API/api_irtcengine_complain.dita index fb8c4d00a00..44bd5921ba7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_complain.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_complain.dita @@ -1,12 +1,12 @@ - <ph keyref="complain"/> + <ph keyref="complain" /> Allows a user to complain about the call quality after a call ends. - + @@ -21,7 +21,7 @@ public abstract int Complain(string callId, string description); abstract complain(callId: string, description: string): number; Future<void> complain({required String callId, required String description}); -

+

Details @@ -32,7 +32,7 @@ callId - The current call ID. You can get the call ID by calling . + The current call ID. You can get the call ID by calling . description @@ -40,11 +40,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
      +
    • < 0: Failure. See for details and resolution suggestions.
      • -2: The parameter is invalid.
      • - 3: The SDK is not ready. Possible reasons include the following:
        • The initialization of fails. Reinitialize the .
          • @@ -55,4 +55,4 @@
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_create.dita b/en-US/dita/RTC-NG/API/api_irtcengine_create.dita index b61bd92107b..bcc47d853eb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_create.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_create.dita @@ -1,12 +1,12 @@ - <ph keyref="create"/> - Creates and initializes . + <ph keyref="create" /> + Creates and initializes . - + @@ -27,35 +27,35 @@
Details -

All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.

+

All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.

    -
  • Before calling other APIs, you must call this method to create the object.
    • -
  • You can create the instance either by calling this method or by calling . The difference between and this method is that supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
    • -
  • The SDK supports creating only one instance for an app.
    • +
  • Before calling other APIs, you must call this method to create the object.
    • +
  • You can create the instance either by calling this method or by calling . The difference between and this method is that supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
    • +
  • The SDK supports creating only one instance for an app.
Parameters context - + appId - + handler delegate - The event handler for . See . + The event handler for . See .
Returns
    -
  • The instance, if the method call succeeds.
    • -
  • The method call fails and an exception is thrown, you need to catch the exception and handle it. See for details and resolution suggestions.
    • +
  • The instance, if the method call succeeds.
    • +
  • The method call fails and an exception is thrown, you need to catch the exception and handle it. See for details and resolution suggestions.
  • An error code, if the method call fails.
    • -1: A general error occurs (no specified reason).
    • -2: The parameter is invalid.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita index 1513387a75c..cf42c37c4a2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="destroyCustomVideoTrack"/> + <ph keyref="destroyCustomVideoTrack" /> Destroys the specified video track. - + @@ -20,7 +20,7 @@ public abstract int DestroyCustomVideoTrack(video_track_id_t video_track_id); abstract destroyCustomVideoTrack(videoTrackId: number): number; Future<void> destroyCustomVideoTrack(int videoTrackId); -

      +

Parameters @@ -29,15 +29,15 @@ video_track_id position videoTrackId - The video track ID returned by calling the method. + The video track ID returned by calling the method.
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita index 48c2d6ab3dd..01c2887f22e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita @@ -22,7 +22,7 @@ public abstract int DestroyMediaPlayer(IMediaPlayer mediaPlayer); abstract destroyMediaPlayer(mediaPlayer: IMediaPlayer): number; Future<void> destroyMediaPlayer(MediaPlayer mediaPlayer); -

+

Parameters @@ -36,11 +36,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • ≥ 0: Success. Returns the ID of media player instance.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita index 8fe5311153b..4b7d802e3cc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita @@ -20,7 +20,7 @@ public abstract int DisableAudio(); abstract disableAudio(): number; Future<void> disableAudio(); -

+

Details @@ -35,11 +35,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudiospectrummonitor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudiospectrummonitor.dita index 413bddb90c8..52c43789cf4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudiospectrummonitor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudiospectrummonitor.dita @@ -20,7 +20,7 @@ public abstract int DisableAudioSpectrumMonitor(); abstract disableAudioSpectrumMonitor(): number; Future<void> disableAudioSpectrumMonitor(); -

+

Details @@ -29,11 +29,11 @@

You can call this method either before or after joining a channel.

- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita index fc5f7c35f1c..0155b78d543 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita @@ -1,12 +1,12 @@ - <ph keyref="disableLastmileTest"/> + <ph keyref="disableLastmileTest" /> Disables the network connection quality test. - + @@ -18,15 +18,15 @@ virtual int disableLastmileTest() = 0; public abstract int DisableLastmileTest(); - - -

+ + +

Returns
  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_disablevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_disablevideo.dita index da330d1f56a..4e3492210cf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disablevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disablevideo.dita @@ -20,7 +20,7 @@ public abstract int DisableVideo(); abstract disableVideo(): number; Future<void> disableVideo(); -

+

Details @@ -37,11 +37,11 @@
- <ph keyref="return-section-title"/> -

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

+ <ph keyref="return-section-title" /> +

When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita index e445f10b35a..2e1cd883a26 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita @@ -20,7 +20,7 @@ public abstract int EnableAudio(); abstract enableAudio(): number; Future<void> enableAudio(); -

+

Details @@ -37,11 +37,11 @@
  • A successful call of this method resets , , and . Proceed it with caution.
    • - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita index 3f01de778da..ad794453785 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita @@ -1,12 +1,12 @@ - <ph keyref="enableAudioSpectrumMonitor"/> + <ph keyref="enableAudioSpectrumMonitor" /> Turns on audio spectrum monitoring. - + @@ -20,7 +20,7 @@ public abstract int EnableAudioSpectrumMonitor(int intervalInMS = 100); abstract enableAudioSpectrumMonitor(intervalInMS?: number): number; Future<void> enableAudioSpectrumMonitor({int intervalInMS = 100}); -

    +

    Details @@ -34,13 +34,13 @@ intervalInMS -

    The interval (in milliseconds) at which the SDK triggers the and callbacks. The default value is 100. Do not set this parameter to a value less than 10, otherwise calling this method would fail.

    +

    The interval (in milliseconds) at which the SDK triggers the and callbacks. The default value is 100. Do not set this parameter to a value less than 10, otherwise calling this method would fail.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        @@ -48,4 +48,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita index f112e96392d..9c6d286cb43 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita @@ -31,7 +31,7 @@ ): number;     Future<void> enableAudioVolumeIndication( {required int interval, required int smooth, required bool reportVad}); -

    +

    Details @@ -44,7 +44,7 @@ interval Sets the time interval between two consecutive volume indications:
    • ≤ 0: Disables the volume indication.
      • -
    • > 0: Time interval (ms) between two consecutive volume indications. The lowest value is 50.
      • +
    • > 0: Time interval (ms) between two consecutive volume indications. The lowest value is 50.
     @@ -61,11 +61,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index eb907d455e2..6fd48036542 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -1,12 +1,12 @@ - <ph keyref="enableContentInspect"/> + <ph keyref="enableContentInspect" /> Enables or disables video screenshot and upload. - + @@ -25,14 +25,14 @@ enabled: boolean, config: ContentInspectConfig ): number;     - Future<void> enableContentInspect( + Future<void> enableContentInspect( {required bool enabled, required ContentInspectConfig config}); -

    +

    Details -

    When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

    - Before calling this method, ensure that you have contacted to activate the video screenshot upload service. +

    When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

    + Before calling this method, ensure that you have contacted to activate the video screenshot upload service.
    Parameters @@ -40,22 +40,22 @@ enabled Whether to enable video screenshot and uploadvideo content moderation:
      -
    • : Enables video screenshot and upload.
      • -
    • : Disables video screenshot and upload.
      • +
    • : Enables video screenshot and upload.
      • +
    • : Disables video screenshot and upload.
         config - Configuration of video screenshot and upload. See .When the video moderation module is set to video moderation via Agora self-developed extension(), the video screenshot and upload dynamic library is required. Deleting this library disables the screenshot and upload feature. + Configuration of video screenshot and upload. See .When the video moderation module is set to video moderation via Agora self-developed extension(), the video screenshot and upload dynamic library is required. Deleting this library disables the screenshot and upload feature.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode.dita index 94a73703175..0dfff6686aa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode.dita @@ -26,7 +26,7 @@
    Deprecated:
    -
    This method is deprecated as of v4.2.0. Use instead.
    +
    This method is deprecated as of v4.2.0. Use instead.

    Dual streams are a pairing of a high-quality video stream and a low-quality video stream:

      @@ -34,7 +34,7 @@
    • Low-quality video stream: Low bitrate, low resolution.

    After you enable dual-stream mode, you can call to choose to receive either the high-quality video stream or the low-quality video stream on the subscriber side.

    - +
    Parameters @@ -53,7 +53,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita index e56b20a3a65..59edc0ef807 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita @@ -28,7 +28,7 @@ ): number;     Future<void> enableEchoCancellationExternal( {required bool enabled, required int audioSourceDelay}); -

    +

    Details @@ -53,11 +53,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita index cacb35348a5..d9119bc87e8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita @@ -37,7 +37,7 @@ required String extension, bool enable = true, MediaSourceType type = MediaSourceType.unknownMediaSource});     -

    +

    Details @@ -77,8 +77,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita index 44fb6fe65a8..68cecd7cb6b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita @@ -20,7 +20,7 @@ abstract enableFaceDetection(enabled: boolean): number; abstract enableFaceDetection(enabled: boolean): number; Future<void> enableFaceDetection(bool enabled); -

        +

    Details @@ -46,11 +46,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita index 02d8dc461d9..7d6e822c132 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita @@ -1,12 +1,12 @@ - <ph keyref="enableInstantMediaRendering"/> + <ph keyref="enableInstantMediaRendering" /> Enables audio and video frame instant rendering. - + @@ -19,7 +19,7 @@ abstract enableInstantMediaRendering(): number; public abstract int EnableInstantMediaRendering(); abstract enableInstantMediaRendering(): number; - Future<void> enableInstantMediaRendering();

    + Future<void> enableInstantMediaRendering();

    Details @@ -31,7 +31,7 @@

    After successfully calling this method, the SDK enables the instant frame rendering mode, which can speed up the first frame rendering speed after the user joins the channel.

      -
    • Once the instant rendering function is enabled, it can only be canceled by calling the method to destroy the object.
      • +
    • Once the instant rendering function is enabled, it can only be canceled by calling the method to destroy the object.
    • In this mode, the SDK uses Agora's custom encryption algorithm to shorten the time required to establish transmission links, and the security is reduced compared to the standard DTLS (Datagram Transport Layer Security). If the application scenario requires higher security standards, Agora recommends that you do not use this method.

    @@ -41,13 +41,13 @@

    Agora recommends that you enable this mode for the audience in a live streaming scenario.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        -
      • -7: The method is called before is initialized.
        • +
      • < 0: Failure. See for details and resolution suggestions.
          +
        • -7: The method is called before is initialized.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita index dc67869fc48..01e87dc9511 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita @@ -1,12 +1,12 @@ - <ph keyref="enableLastmileTest"/> + <ph keyref="enableLastmileTest" /> Enables the network connection quality test. - + @@ -18,9 +18,9 @@ virtual int enableLastmileTest() = 0; public abstract int EnableLastmileTest(); - - -

    + + +

    Details @@ -28,19 +28,19 @@
  • Before a user joins a channel, call this method to check the uplink network quality.
  • Before an audience switches to a host, call this method to check the uplink network quality.

    • -

    Regardless of the scenario, enabling this method consumes extra network traffic and affects the call quality. After receiving the callback, call to stop the test, and then join the channel or switch to the host.

    +

    Regardless of the scenario, enabling this method consumes extra network traffic and affects the call quality. After receiving the callback, call to stop the test, and then join the channel or switch to the host.

      -
    • Do not use this method together with .
      • -
    • Do not call any other methods before receiving the callback. Otherwise, the callback may be interrupted by other methods, and hence may not be triggered.
      • +
    • Do not use this method together with .
      • +
    • Do not call any other methods before receiving the callback. Otherwise, the callback may be interrupted by other methods, and hence may not be triggered.
    • A host should not call this method after joining a channel (when in a call).
      • -
    • If you call this method to test the last mile network quality, the SDK consumes the bandwidth of a video stream, whose bitrate corresponds to the bitrate you set in . After joining a channel, whether you have called or not, the SDK automatically stops consuming the bandwidth.
      • +
    • If you call this method to test the last mile network quality, the SDK consumes the bandwidth of a video stream, whose bitrate corresponds to the bitrate you set in . After joining a channel, whether you have called or not, the SDK automatically stops consuming the bandwidth.
    Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita index 9ac5fbac48a..1cf0c4dfc0b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita @@ -20,7 +20,7 @@ public abstract int EnableLocalAudio(bool enabled); abstract enableLocalAudio(enabled: boolean): number; Future<void> enableLocalAudio(bool enabled); -

    +

    Details @@ -50,11 +50,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita index 2d32d242c45..1037126d52e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita @@ -20,7 +20,7 @@ public abstract int EnableLocalVideo(bool enabled); abstract enableLocalVideo(enabled: boolean): number; Future<void> enableLocalVideo(bool enabled); -

    +

    Details @@ -46,11 +46,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableloopbackrecording.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableloopbackrecording.dita index 8e876eeb8fa..a1f2048b180 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableloopbackrecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableloopbackrecording.dita @@ -1,19 +1,19 @@ - <ph keyref="enableLoopbackRecording"/> + <ph keyref="enableLoopbackRecording" /> Enables loopback audio capturing. - +

    - + - (int)enableLoopbackRecording:(BOOL)enabled deviceName:(NSString* _Nullable)deviceName NS_SWIFT_NAME(enableLoopbackRecording(_:deviceName:)); virtual int enableLoopbackRecording(bool enabled, const char* deviceName = NULL) = 0; abstract enableLoopbackRecording( @@ -27,7 +27,7 @@ ): number; Future<void> enableLoopbackRecording( {required bool enabled, String? deviceName}); -

    +

    Details @@ -44,8 +44,8 @@ enabled Whether to enable loopback audio capturing.
      -
    • : Enable loopback audio capturing.
      • -
    • : (Default) Disable loopback audio capturing.
      • +
    • : Enable loopback audio capturing.
      • +
    • : (Default) Disable loopback audio capturing.
         @@ -60,11 +60,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita index 98f6c994a6a..8d3c3c1bb5c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita @@ -21,13 +21,13 @@ abstract enableRemoteSuperResolution(userId: number, enable: boolean): number; Future<void> enableRemoteSuperResolution( {required int userId, required bool enable}); -

    +

    Details

    This function can effectively improve the resolution of the remote video picture seen by the local user, that is, the width and height (pixels) of the video received by the specified remote user are enlarged to 2 times original size.

    After calling this method, you can confirm whether super resolution is successfully enabled through the remote video stream statistics () in the callback:

      -
    • If the parameter superResolutionType >0: Super resolution is enabled.
      • +
    • If the parameter superResolutionType >0: Super resolution is enabled.
    • If the parameter superResolutionType =0: Super resolution is not enabled.

    @@ -38,7 +38,7 @@
    • This method applies to Android and iOS only.
      • -
    • This method relies on the super resolution dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
      • +
    • This method relies on the super resolution dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • This method has certain requirements on devices. Agora recommends you use the following devices or higher:
      • Android:
        • VIVO: V1821A, NEX S, 1914A, 1916A, 1962A, 1824BA, X60, X60 Pro
          • @@ -78,17 +78,17 @@ enable Whether to enable super resolution for the remote user’s video:
            -
          • :Enable super resolution.
            • -
          • : Disable super resolution.
            • +
          • :Enable super resolution.
            • +
          • : Disable super resolution.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablesoundpositionindication.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablesoundpositionindication.dita index 256dfb4b5eb..84a4962205a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablesoundpositionindication.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablesoundpositionindication.dita @@ -20,7 +20,7 @@ public abstract int EnableSoundPositionIndication(bool enabled); abstract enableSoundPositionIndication(enabled: boolean): number; Future<void> enableSoundPositionIndication(bool enabled); -

    +

    Details @@ -38,11 +38,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita index 97051f4388e..589a51956e7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita @@ -20,7 +20,7 @@ public abstract int EnableSpatialAudio(bool enabled); abstract enableSpatialAudio(enabled: boolean): number; Future<void> enableSpatialAudio(bool enabled); -

    +

    Details @@ -28,7 +28,7 @@
    • You can call this method either before or after joining a channel.
      • -
    • This method relies on the spatial audio dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
      • +
    • This method relies on the spatial audio dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita index 9a7607f1009..e9b2f588660 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita @@ -20,7 +20,7 @@ public abstract int EnableVideo(); abstract enableVideo(): number; Future<void> enableVideo(); -

    +

    Details @@ -38,11 +38,11 @@
  • A successful call of this method resets , , and . Proceed it with caution.
    • - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita index 301d69f1840..8cc4b23ffea 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita @@ -26,9 +26,9 @@ enable: boolean, options: ImageTrackOptions ): number;     - Future<void> enableVideoImageSource( + Future<void> enableVideoImageSource( {required bool enable, required ImageTrackOptions options}); -

    +

    Details @@ -52,11 +52,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
    +
  • < 0: Failure. See for details and resolution suggestions.
    • - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablewebsdkinteroperability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablewebsdkinteroperability.dita index 2ce2c1c8e53..a373f09e389 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablewebsdkinteroperability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablewebsdkinteroperability.dita @@ -20,7 +20,7 @@ public abstract int EnableWebSdkInteroperability(bool enabled); abstract enableWebSdkInteroperability(enabled: boolean): number; Future<void> enableWebSdkInteroperability(bool enabled); -

    +

    Details @@ -45,11 +45,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiodeviceinfo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiodeviceinfo.dita index 024b06ca0db..df2fbcc1723 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiodeviceinfo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiodeviceinfo.dita @@ -20,7 +20,7 @@ public abstract int GetAudioDeviceInfo(ref DeviceInfoMobile deviceInfo); abstract getAudioDeviceInfo(): DeviceInfo; Future<DeviceInfo> getAudioDeviceInfo(); -

    +

    Details @@ -35,25 +35,25 @@ deviceInfo - Input and output parameter. A object that identifies the audio device information.
      + Input and output parameter. A object that identifies the audio device information.
      • Input value: A object.
        • -
      • Output value: A object containing audio device information.
        • +
      • Output value: A object containing audio device information.
       deviceInfo - Audio frame information. See . + Audio frame information. See .
    Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -

    The object that identifies the audio device information.

      +

      The object that identifies the audio device information.

      • Not null: Success.
        • -
      • Null: Failure. See for details and resolution suggestions.
        • +
      • Null: Failure. See for details and resolution suggestions.

    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingcurrentposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingcurrentposition.dita index afee026ceba..dcea865356b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingcurrentposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingcurrentposition.dita @@ -20,21 +20,21 @@ public abstract int GetAudioMixingCurrentPosition(); abstract getAudioMixingCurrentPosition(): number; Future<int> getAudioMixingCurrentPosition(); -

    +

    Details

    Retrieves the playback position (ms) of the audio.

      -
    • You need to call this method after calling and receiving the () callback.
      • -
    • If you need to call multiple times, ensure that the time interval between calling this method is more than 500 ms.
      • +
    • You need to call this method after calling and receiving the () callback.
      • +
    • If you need to call multiple times, ensure that the time interval between calling this method is more than 500 ms.
    Returns
    • ≥ 0: The current playback position (ms) of the audio mixing, if this method call succeeds. 0 represents that the current music file does not start playing.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita index 4dc9f455d1b..0d9a33d713f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingduration.dita @@ -20,19 +20,19 @@ public abstract int GetAudioMixingDuration(); abstract getAudioMixingDuration(): number; Future<int> getAudioMixingDuration(); -

    +

    Details

    Retrieves the total duration (ms) of the audio.

    -

    You need to call this method after calling and receiving the () callback.

    +

    You need to call this method after calling and receiving the () callback.
    Returns
    • ≥ 0: The audio mixing duration, if this method call succeeds.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita index 882700b8e9a..735cdc4a604 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita @@ -20,7 +20,7 @@ public abstract int GetAudioMixingPlayoutVolume(); abstract getAudioMixingPlayoutVolume(): number; Future<int> getAudioMixingPlayoutVolume(); -

    +

    Details @@ -32,7 +32,7 @@ Returns
    • ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100].
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita index 9bde8a7203c..2b2d65e6f49 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita @@ -20,7 +20,7 @@ public abstract int GetAudioMixingPublishVolume(); abstract getAudioMixingPublishVolume(): number; Future<int> getAudioMixingPublishVolume(); -

    +

    Details @@ -30,7 +30,7 @@ Returns
    • ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100].
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita index 8145b8b1d79..0287dc321ec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita @@ -20,7 +20,7 @@ public abstract int GetCallId(ref string callId); abstract getCallId(): string; Future<String> getCallId(); -

    +

    Details @@ -40,11 +40,11 @@

    The current call ID.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    • The current call ID, if the method succeeds.
    • An empty string, if the method call fails.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita index a2a47cf4776..eed0ca6da0b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita @@ -1,12 +1,12 @@ - <ph keyref="getCurrentMonotonicTimeInMs"/> + <ph keyref="getCurrentMonotonicTimeInMs" /> Gets the current Monotonic Time of the SDK. - + @@ -19,7 +19,7 @@ abstract getCurrentMonotonicTimeInMs(): number; public abstract long GetCurrentMonotonicTimeInMs(); abstract getCurrentMonotonicTimeInMs(): number; - Future<int> getCurrentMonotonicTimeInMs();

    + Future<int> getCurrentMonotonicTimeInMs();

    Details @@ -30,13 +30,13 @@

    Monotonic Time refers to a monotonically increasing time series whose value increases over time. The unit is milliseconds.

    -

    In custom video capture and custom audio capture scenarios, in order to ensure audio and video synchronization, Agora recommends that you call this method to obtain the current Monotonic Time of the SDK, and then pass this value into the timestamp parameter in the captured video frame () and audio frame ().

    +

    In custom video capture and custom audio capture scenarios, in order to ensure audio and video synchronization, Agora recommends that you call this method to obtain the current Monotonic Time of the SDK, and then pass this value into the timestamp parameter in the captured video frame () and audio frame ().

    Returns
    • ≥0: The method call is successful, and returns the current Monotonic Time of the SDK (in milliseconds).
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_geteffectsvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_geteffectsvolume.dita index 781b6548196..eb32c0ba7c6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_geteffectsvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_geteffectsvolume.dita @@ -20,7 +20,7 @@ public abstract int GetEffectsVolume(); abstract getEffectsVolume(): number; Future<int> getEffectsVolume(); -

    +

    Details @@ -30,7 +30,7 @@ Returns
    • Volume of the audio effects, if this method call succeeds.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty.dita index 4770eb88b7e..3c7a2f245a4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty.dita @@ -49,7 +49,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    • The extension information, if the method call succeeds.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita index 5d9d8a116a5..3c8e86a3901 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita @@ -1,12 +1,12 @@ - <ph keyref="getNativeHandle"/> + <ph keyref="getNativeHandle" /> Gets the C++ handle of the Native SDK. - + @@ -19,8 +19,8 @@ abstract getNativeHandle(): number; public abstract int GetNativeHandler(ref IntPtr nativeHandler); abstract getNativeHandle(): number; - Future<int> getNativeHandle(); -

      + Future<int> getNativeHandle(); +

      Details @@ -39,8 +39,8 @@

      The native handle of the SDK.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuid.dita index cb63f0724e3..e635cd4af8e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuid.dita @@ -20,7 +20,7 @@ public abstract int GetUserInfoByUid(uint uid, ref UserInfo userInfo); abstract getUserInfoByUid(uid: number): UserInfo; Future<UserInfo> getUserInfoByUid(int uid); -

      +

      Details @@ -62,7 +62,7 @@
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getvolumeofeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getvolumeofeffect.dita index 687ca6031aa..49963493e77 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getvolumeofeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getvolumeofeffect.dita @@ -20,7 +20,7 @@ public abstract int GetVolumeOfEffect(int soundId); abstract getVolumeOfEffect(soundId: number): number; Future<int> getVolumeOfEffect(int soundId); -

    +

    Parameters @@ -34,7 +34,7 @@ Returns
    • ≥ 0: Returns the volume of the specified audio effect, if the method call is successful. The value ranges between 0 and 100. 100 represents the original volume.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita index a1dd9ac43f1..5273c07117c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita @@ -19,8 +19,8 @@ public abstract bool IsCameraExposureSupported(); abstract isCameraExposureSupported(): boolean; - Future<bool> isCameraExposureSupported(); -

    + Future<bool> isCameraExposureSupported(); +

    Details @@ -33,16 +33,16 @@
    • This method is for Android and iOS only.
      • -
    • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
      • -
    • Before calling , Agora recoomends that you call this method to query whether the current camera supports adjusting the exposure value.
      • -
    • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling .
      • +
    • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
      • +
    • Before calling , Agora recoomends that you call this method to query whether the current camera supports adjusting the exposure value.
      • +
    • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling .
    Returns
      -
    • : Success.
      • -
    • : Failure. See for details and resolution suggestions.
      • +
    • : Success.
      • +
    • : Failure. See for details and resolution suggestions.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita index 4b4b33b4b5d..263e6128d52 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita @@ -35,12 +35,12 @@ userAccount: string, options?: ChannelMediaOptions ): number;     - Future<void> joinChannelWithUserAccount( + Future<void> joinChannelWithUserAccount( {required String token, required String channelId, required String userAccount, ChannelMediaOptions? options}); -

    +

    Details @@ -75,11 +75,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        +
      • < 0: Failure. See for details and resolution suggestions.
        • -2: The parameter is invalid.
        • -3: The initialization of the SDK fails. You can try to initialize the SDK again.
        • -5: The request is rejected.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita index d26dd74fb48..dd4bd1cbb79 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita @@ -43,7 +43,7 @@ required String channelId, required String userAccount, required ChannelMediaOptions options}); -

          +

    Details @@ -88,11 +88,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita index 462364d2bff..59d4eea50f8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita @@ -1,12 +1,12 @@ - <ph keyref="leaveChannel"/> + <ph keyref="leaveChannel" /> Leaves a channel. - + @@ -20,42 +20,42 @@ public abstract int LeaveChannel(); abstract leaveChannel(options?: LeaveChannelOptions): number; Future<void> leaveChannel({LeaveChannelOptions? options}); -

    +

    Details

    This method releases all resources related to the session.

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.

    Calling this method does not necessarily mean that the user has left the channel.

    -

    After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.

    +

    After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.

    If you successfully call this method and leave the channel, the following callbacks are triggered:

      -
    • The local client: .
      • -
    • The remote client: , if the user joining the channel is in the Communication profile, or is a host in the Live-broadcasting profile.
      • +
    • The local client: .
      • +
    • The remote client: , if the user joining the channel is in the Communication profile, or is a host in the Live-broadcasting profile.

      -
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • -
    • If you have called to join multiple channels, calling this method will leave the channels when calling and at the same time.
      • -
    • If you call this method during a Media Push, the SDK automatically calls the method.
      • +
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • +
    • If you have called to join multiple channels, calling this method will leave the channels when calling and at the same time.
      • +
    • If you call this method during a Media Push, the SDK automatically calls the method.
    Parameters - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        +
      • < 0: Failure. See for details and resolution suggestions.
        • -1: A general error occurs (no specified reason).
        • -2: The parameter is invalid.
        • -7: The SDK is not initialized.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita index 50abae34a60..d802f1ce644 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita @@ -1,12 +1,12 @@ - <ph keyref="leaveChannel2"/> + <ph keyref="leaveChannel2" /> Sets channel options and leaves the channel. - + @@ -21,35 +21,35 @@ public abstract int LeaveChannel(LeaveChannelOptions options); abstract leaveChannel(options?: LeaveChannelOptions): number; Future<void> leaveChannel({LeaveChannelOptions? options}); -

    +

    Details

    This method will release all resources related to the session, leave the channel, that is, hang up or exit the call. This method can be called whether or not a call is currently in progress.

    After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.

    -

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    -

    Calling this method does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    -
    +

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    +

    Calling this method does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    +
    Parameters options - The options for leaving the channel. See . + The options for leaving the channel. See . leaveChannelBlock -

    This callback indicates that a user leaves a channel, and provides the statistics of the call in .

    +

    This callback indicates that a user leaves a channel, and provides the statistics of the call in .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita b/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita index c53f3f8afc1..963ce80bc46 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita @@ -1,12 +1,12 @@ - <ph keyref="loadExtensionProvider"/> + <ph keyref="loadExtensionProvider" /> Adds an extension to the SDK. - + @@ -25,9 +25,9 @@ path: string, unloadAfterUse?: boolean ): number;     - Future<void> loadExtensionProvider( + Future<void> loadExtensionProvider( {required String path, bool unloadAfterUse = false}); -

    +

    Details @@ -46,18 +46,18 @@ unload_after_use unloadAfterUse Whether to uninstall the current extension when you no longer using it:
      -
    • : Uninstall the extension when the is destroyed.
      • -
    • : (Rcommended) Do not uninstall the extension until the process terminates.
      • +
    • : Uninstall the extension when the is destroyed.
      • +
    • : (Rcommended) Do not uninstall the extension until the process terminates.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita index 2d9730251c0..acba03b05c1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita @@ -1,12 +1,12 @@ - <ph keyref="muteAllRemoteAudioStreams"/> + <ph keyref="muteAllRemoteAudioStreams" /> Stops or resumes subscribing to the audio streams of all remote users. - + @@ -20,7 +20,7 @@ public abstract int MuteAllRemoteAudioStreams(bool mute); abstract muteAllRemoteAudioStreams(mute: boolean): number; Future<void> muteAllRemoteAudioStreams(bool mute); -

    +

    Details @@ -28,7 +28,7 @@
    • Call this method after joining a channel.
      • -
    • If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
      • +
    • If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
    • See recommended settings in Set the Subscribing State.
    @@ -39,18 +39,18 @@ mute

    Whether to stop subscribing to the audio streams of all remote users:

      -
    • : Stops subscribing to the audio streams of all remote users.
      • -
    • : (Default) Subscribes to the audio streams of all remote users by default.
      • +
    • : Stops subscribing to the audio streams of all remote users.
      • +
    • : (Default) Subscribes to the audio streams of all remote users by default.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita index 925c9b5464c..663cc0bf50c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita @@ -20,14 +20,14 @@ public abstract int MuteAllRemoteVideoStreams(bool mute); abstract muteAllRemoteVideoStreams(mute: boolean): number; Future<void> muteAllRemoteVideoStreams(bool mute); -

    +

    Details

    After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.

    • Call this method after joining a channel.
      • -
    • If you do not want to subscribe the video streams of remote users before joining a channel, you can call and set autoSubscribeVideo as .
      • +
    • If you do not want to subscribe the video streams of remote users before joining a channel, you can call and set autoSubscribeVideo as .
    @@ -45,11 +45,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita index 27fcd992bc4..14ddea18348 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita @@ -1,12 +1,12 @@ - <ph keyref="muteLocalAudioStream"/> + <ph keyref="muteLocalAudioStream" /> Stops or resumes publishing the local audio stream. - + @@ -20,12 +20,12 @@ public abstract int MuteLocalAudioStream(bool mute); abstract muteLocalAudioStream(mute: boolean): number; Future<void> muteLocalAudioStream(bool mute); -

    +

    Details This method does not affect any ongoing audio recording, because it does not disable the audio capture device. -

    A successful call of this method triggers the and callbacks on the remote client.

    +

    A successful call of this method triggers the and callbacks on the remote client.

    Parameters @@ -34,18 +34,18 @@ mute

    Whether to stop publishing the local audio stream:

      -
    • : Stops publishing the local audio stream.
      • -
    • : (Default) Resumes publishing the local audio stream.
      • +
    • : Stops publishing the local audio stream.
      • +
    • : (Default) Resumes publishing the local audio stream.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita index 799e380b36d..8f49548146a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita @@ -1,12 +1,12 @@ - <ph keyref="muteLocalVideoStream"/> + <ph keyref="muteLocalVideoStream" /> Stops or resumes publishing the local video stream. - + @@ -20,14 +20,14 @@ public abstract int MuteLocalVideoStream(bool mute); abstract muteLocalVideoStream(mute: boolean): number; Future<void> muteLocalVideoStream(bool mute); -

    +

    Details -

    A successful call of this method triggers the callback on the remote client.

    +

    A successful call of this method triggers the callback on the remote client.

      -
    • This method executes faster than the () method, which controls the sending of the local video stream.
      • +
    • This method executes faster than the () method, which controls the sending of the local video stream.
    • This method does not affect any ongoing video recording, because it does not disable the camera.
    @@ -38,18 +38,18 @@ mute

    Whether to stop publishing the local video stream.

      -
    • : Stop publishing the local video stream.
      • -
    • : (Default) Publish the local video stream.
      • +
    • : Stop publishing the local video stream.
      • +
    • : (Default) Publish the local video stream.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita index 6416cd973b1..71bf9f70b5b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita @@ -20,7 +20,7 @@ public abstract int MuteRecordingSignal(bool mute); abstract muteRecordingSignal(mute: boolean): number; Future<void> muteRecordingSignal(bool mute); -

    +

    Parameters @@ -33,16 +33,16 @@
  • : The media file is muted.
  • : (Default) Do not mute the recording signal.
    • - If you have already called to adjust the volume, then when you call this method and set it to , the SDK will record the current volume and mute it. To restore the previous volume, call this method again and set it to . + If you have already called to adjust the volume, then when you call this method and set it to , the SDK will record the current volume and mute it. To restore the previous volume, call this method again and set it to .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita index 9295baa383f..07532b80b98 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita @@ -1,12 +1,12 @@ - <ph keyref="muteRemoteAudioStream"/> + <ph keyref="muteRemoteAudioStream" /> Stops or resumes subscribing to the audio stream of a specified user. - + @@ -20,8 +20,8 @@ abstract muteRemoteAudioStream(uid: number, mute: boolean): number; public abstract int MuteRemoteAudioStream(uint uid, bool mute); abstract muteRemoteAudioStream(uid: number, mute: boolean): number; - Future<void> muteRemoteAudioStream({required int uid, required bool mute}); -

    + Future<void> muteRemoteAudioStream({required int uid, required bool mute}); +

    Details @@ -42,18 +42,18 @@ mute

    Whether to subscribe to the specified remote user's audio stream.

      -
    • : Stop subscribing to the audio stream of the specified user.
      • -
    • : (Default) Subscribe to the audio stream of the specified user.
      • +
    • : Stop subscribing to the audio stream of the specified user.
      • +
    • : (Default) Subscribe to the audio stream of the specified user.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita index a6d104b861f..38248fffbf3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita @@ -21,7 +21,7 @@ public abstract int MuteRemoteVideoStream(uint uid, bool mute); abstract muteRemoteVideoStream(uid: number, mute: boolean): number; Future<void> muteRemoteVideoStream({required int uid, required bool mute}); -

    +

    Details @@ -50,11 +50,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita index 4913b295ab6..c4283d612df 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita @@ -20,18 +20,18 @@ public abstract int PauseAllChannelMediaRelay(); abstract pauseAllChannelMediaRelay(): number; Future<void> pauseAllChannelMediaRelay(); -

    +

    Details

    After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call .

    - Call this method after .
    + Call this method after .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pausealleffects.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pausealleffects.dita index 80ab9053797..d6e37152cc3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pausealleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pausealleffects.dita @@ -22,14 +22,14 @@ public abstract int PauseAllEffects(); abstract pauseAllEffects(): number; Future<void> pauseAllEffects(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita index 3b77ee921e3..58b2f715474 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita @@ -20,18 +20,18 @@ public abstract int PauseAudioMixing(); abstract pauseAudioMixing(): number; Future<void> pauseAudioMixing(); -

    +

    Details

    Call this method after joining a channel.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pauseeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pauseeffect.dita index 4babf87f36b..cf996f4667d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pauseeffect.dita @@ -20,7 +20,7 @@ public abstract int PauseEffect(int soundId); abstract pauseEffect(soundId: number): number; Future<void> pauseEffect(int soundId); -

    +

    Parameters @@ -31,11 +31,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita b/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita index 74734a51abb..0e519c0d60e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita @@ -37,7 +37,7 @@ required double pan, required int gain, bool publish = false});     -

    +

    Details @@ -85,11 +85,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect2.dita index b023a86cf8c..3db0e46c9b8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect2.dita @@ -38,7 +38,7 @@
    Details - +

    To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the callback.Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See Supported Audio Formats.

    @@ -96,7 +96,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita index fd88ecfec1e..d30e7b5b09e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita @@ -63,13 +63,13 @@ required int gain, bool publish = false, int startPos = 0});     -

    +

    Details - If you use this method to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call to preload the cached audio effect file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures. -

    To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the callback.

    -

    + If you use this method to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call to preload the cached audio effect file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures. +

    To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the callback.

    +

    Parameters @@ -128,11 +128,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita index 8a6ad5ed362..08e4bac480c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel2"/> + <ph keyref="preloadChannel2" /> Preloads a channel with token, channelIdchannelName, and userAccount. - + @@ -29,7 +29,7 @@ channelId: string, userAccount: string ): number;     - Future<void> preloadChannelWithUserAccount( + Future<void> preloadChannelWithUserAccount( {required String token, required String channelId, required String userAccount});

    @@ -42,34 +42,34 @@
    v4.2.2
    -

    +

    -

    • +
      • You also need to make sure that the User Account, channel ID and token passed in for preloading are the same as the values passed in when joining the channel, otherwise, this method does not take effect.
        • -
      • -
      -

      +
    • +
    +

    Parameters - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        @@ -79,4 +79,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita index 99bb1ce243a..6a5f76ff244 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita @@ -32,7 +32,7 @@ ): number;     Future<void> preloadEffect( {required int soundId, required String filePath, int startPos = 0}); -

    +

    Details @@ -65,11 +65,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita index f0af4f28d6f..bf2cc99097e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita @@ -1,12 +1,12 @@ - <ph keyref="pushAudioFrame2"/> + <ph keyref="pushAudioFrame2" /> Pushes the external audio frame to the SDK. - + @@ -31,7 +31,7 @@
    Details -

    Before calling this method, ensure that you set publishCustomAudioTrack to , and publishCustomAudioTrackId in to the audio track ID that you want to publish in the channel.

    +

    Before calling this method, ensure that you set publishCustomAudioTrack to , and publishCustomAudioTrackId in to the audio track ID that you want to publish in the channel.
    Parameters @@ -65,14 +65,14 @@ trackId - The audio track ID. Set this parameter to the custom audio track ID returned in . + The audio track ID. Set this parameter to the custom audio track ID returned in .
    Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita index d7247994b65..f15f24606f7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita @@ -20,7 +20,7 @@ abstract pushCaptureAudioFrame(frame: AudioFrame): number; Future<void> pushCaptureAudioFrame(AudioFrame frame); -

    +

    Details @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita b/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita index ea9fbe47661..ae19fbaeb30 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita @@ -27,7 +27,7 @@ description:(NSString * _Nullable)description;     {required String callId, required int rating, required String description});     -

    +

    Details @@ -49,11 +49,11 @@ description:(NSString * _Nullable)description;
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        +
      • < 0: Failure. See for details and resolution suggestions.
        • -2 (ERR_INVALID_ARGUMENT).
        • -3 (ERR_NOT_READY).
        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita index 70cecd0b7d1..30c1efbaead 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita @@ -1,12 +1,12 @@ - <ph keyref="registerExtension"/> + <ph keyref="registerExtension" /> Registers an extension. - + @@ -28,11 +28,11 @@ extension: string, type?: MediaSourceType ): number; - Future<void> registerExtension( + Future<void> registerExtension( {required String provider, required String extension, MediaSourceType type = MediaSourceType.unknownMediaSource}); -

        +

    Details @@ -49,24 +49,24 @@ Parameters - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita index 5e5a822f589..010d9295ab3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita @@ -21,7 +21,7 @@ abstract registerLocalUserAccount(appId: string, userAccount: string): number; Future<void> registerLocalUserAccount( {required String appId, required String userAccount}); -

    +

    Details @@ -54,17 +54,17 @@
  • The 26 uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
    • -
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    • +
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    • - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita index 4629c00bf3e..6827c0f4de1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita @@ -20,7 +20,7 @@ public abstract int RemoveInjectStreamUrl(string url); Future<void> removeInjectStreamUrl(String url); -

    +

    Details @@ -36,11 +36,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita index 853fd56de34..c19761291d3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita @@ -20,7 +20,7 @@ public abstract int RemovePublishStreamUrl(string url); abstract removePublishStreamUrl(url: string): number; Future<void> removePublishStreamUrl(String url); -

    +

    Details @@ -47,11 +47,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita b/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita index cd5a9e70514..ad5b2a6425d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita @@ -20,7 +20,7 @@ public abstract int RenewToken(string token); abstract renewToken(token: string): number; Future<void> renewToken(String token); -

    +

    DetailsYou can call this method to pass a new token to the SDK. A token expires after a certain period of time. In the following two cases, the app should call this method to pass in a new token. Failure to do so will result in the SDK disconnecting from the server.
      @@ -36,8 +36,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita index e00e323b43d..84f4dfad331 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita @@ -20,18 +20,18 @@ public abstract int ResumeAllChannelMediaRelay(); abstract resumeAllChannelMediaRelay(): number; Future<void> resumeAllChannelMediaRelay(); -

        +

    Details

    After calling the method, you can call this method to resume relaying media streams to all destination channels.

    Call this method after .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita b/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita index 613c8306cb0..75ca9cb38b1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita @@ -22,14 +22,14 @@ public abstract int ResumeAllEffects(); abstract resumeAllEffects(): number; Future<void> resumeAllEffects(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita index 626b834bc08..954bd16c471 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita @@ -20,18 +20,18 @@ public abstract int ResumeAudioMixing(); abstract resumeAudioMixing(): number; Future<void> resumeAudioMixing(); -

    +

    Details

    This method resumes playing and mixing the music file. Call this method when you are in a channel.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita index 603de49a1ca..36d4f9fddae 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita @@ -22,7 +22,7 @@ public abstract int ResumeEffect(int soundId); abstract resumeEffect(soundId: number): number; Future<void> resumeEffect(int soundId); -

    +

    Parameters @@ -33,11 +33,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita index b844a6e7536..f9044a8039d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="selectAudioTrack"/> + <ph keyref="selectAudioTrack" /> Selects the audio track used during playback. - + @@ -19,16 +19,16 @@ abstract selectAudioTrack(index: number): number; public abstract int SelectAudioTrack(int index); abstract selectAudioTrack(index: number): number; - Future<void> selectAudioTrack(int index); -

    + Future<void> selectAudioTrack(int index); +

    Details

    After getting the track index of the audio file, you can call this method to specify any track to play. For example, if different tracks of a multi-track file store songs in different languages, you can call this method to set the playback language.

      -
    • For the supported formats of audio files, see .
      • -
    • You need to call this method after calling and receiving the () callback.
      • +
    • For the supported formats of audio files, see .
      • +
    • You need to call this method after calling and receiving the () callback.
    Parameters @@ -36,15 +36,15 @@ index audioIndex - The audio track you want to specify. The value range is [0, ()]. + The audio track you want to specify. The value range is [0, ()].
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita index b374d1fec24..e57e4902bf5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita @@ -28,7 +28,7 @@ ): number;     Future<void> sendStreamMessage( {required int streamId, required Uint8List data, required int length}); -

    +

    Details @@ -62,11 +62,11 @@ A failed method call triggers the callbac
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita index 14e288ca914..eca5ced70a3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita @@ -1,12 +1,12 @@ - <ph keyref="setAINSMode"/> + <ph keyref="setAINSMode" /> Sets whether to enable the AI ​​noise suppression function and set the noise suppression mode. - + @@ -19,7 +19,7 @@ abstract setAINSMode(enabled: boolean, mode: AudioAinsMode): number; public abstract int SetAINSMode(bool enabled, AUDIO_AINS_MODE mode); abstract setAINSMode(enabled: boolean, mode: AudioAinsMode): number; - Future<void> setAINSMode( + Future<void> setAINSMode( {required bool enabled, required AudioAinsMode mode});

    @@ -47,14 +47,14 @@ enabled Whether to enable the AI noise suppression function:
      -
    • : Enable the AI noise suppression.
      • -
    • : (Default) Disable the AI noise suppression.
      • +
    • : Enable the AI noise suppression.
      • +
    • : (Default) Disable the AI noise suppression.
         mode -

    The AI noise suppression modes. See .

    +

    The AI noise suppression modes. See .

    The AI noise suppression modes:

    • 0: (Default) Balance mode. This mode allows for a balanced performance on noice suppression and time delay.
    • 1: Aggressive mode. In scenarios where high performance on noise suppression is required, such as live streaming outdoor events, this mode reduces nosies more dramatically, but sometimes may affect the original character of the audio.
      • @@ -64,11 +64,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita index 5731fcd40a3..da84b872bdd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita @@ -27,7 +27,7 @@ {required AudioEffectPreset preset, required int param1, required int param2});     -

    +

    Details @@ -101,11 +101,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita index d989e44a1c0..fa147f04792 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita @@ -20,7 +20,7 @@ public abstract int SetAudioEffectPreset(AUDIO_EFFECT_PRESET preset); abstract setAudioEffectPreset(preset: AudioEffectPreset): number; Future<void> setAudioEffectPreset(AudioEffectPreset preset); -

    +

    Details @@ -42,7 +42,7 @@
    • -
  • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters @@ -77,11 +77,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita index 3aa7e89242e..cffc2148529 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita @@ -20,7 +20,7 @@ public abstract int SetAudioMixingPitch(int pitch); abstract setAudioMixingPitch(pitch: number): number; Future<void> setAudioMixingPitch(int pitch); -

    +

    Details @@ -35,11 +35,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita index 6c44d9eb3dc..573be542fea 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita @@ -20,7 +20,7 @@ public abstract int SetAudioMixingPosition(int pos); abstract setAudioMixingPosition(pos: number): number; Future<void> setAudioMixingPosition(int pos); -

    +

    Details @@ -35,11 +35,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita index 19988de4dc5..b77890c73b4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita @@ -28,7 +28,7 @@ Future<void> setAudioProfile( {required AudioProfileType profile, AudioScenarioType scenario = AudioScenarioType.audioScenarioDefault}); -

    +

    Details @@ -73,11 +73,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita index 4a559ef43a9..3e9303e85e6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita @@ -27,7 +27,7 @@
    • You can call this method either before or after joining a channel.
    • In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set profile as (4).
      • -
    • If you need to set the audio scenario, you can either call , or and set the mAudioScenarioaudioScenario in .
      • +
    • If you need to set the audio scenario, you can either call , or and set the mAudioScenarioaudioScenario in .
    Parameters @@ -43,7 +43,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita index ebe21a4d5a0..2fbe0a0c911 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita @@ -20,7 +20,7 @@ public abstract int SetAudioScenario(AUDIO_SCENARIO_TYPE scenario); abstract setAudioScenario(scenario: AudioScenarioType): number; Future<void> setAudioScenario(AudioScenarioType scenario); -

    +

    Details @@ -30,24 +30,24 @@ scenario - The audio scenarios. See . Under different audio scenarios, the device uses different volume types. + The audio scenarios. See . Under different audio scenarios, the device uses different volume types. scenario - The audio scenarios:
    • (0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.
      • -
    • (3): High-quality audio scenario, where users mainly play music.
      • -
    • (5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. In this scenario, audience members receive a pop-up window to request permission of using microphones.
      • -
    • (7): Real-time chorus scenario, where users have good network conditions and require extremely low latency.Before using this enumeration, you need to call to see whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (isLowLatencyAudioSupported = ).
      • -
    • (8): Meeting scenario that mainly involves the human voice.
    + The audio scenarios:
    • (0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.
      • +
    • (3): High-quality audio scenario, where users mainly play music.
      • +
    • (5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. In this scenario, audience members receive a pop-up window to request permission of using microphones.
      • +
    • (7): Real-time chorus scenario, where users have good network conditions and require extremely low latency.Before using this enumeration, you need to call to see whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (isLowLatencyAudioSupported = ).
      • +
    • (8): Meeting scenario that mainly involves the human voice.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita index 4e409403b01..495db424fce 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita @@ -23,7 +23,7 @@ ): number;     Future<void> setAudioSessionOperationRestriction( AudioSessionOperationRestriction restriction); -

    +

    Details @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita index 2f05040f8ff..7b3d3ffaf43 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita @@ -20,7 +20,7 @@ public abstract int SetAVSyncSource(string channelId, uint uid); abstract setAVSyncSource(channelId: string, uid: number): number; Future<void> setAVSyncSource({required String channelId, required int uid}); -

    +

    Details @@ -39,11 +39,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita index 5b1504f900d..846a47ea1c4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita @@ -31,7 +31,7 @@ {required bool enabled, required BeautyOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource});     -

    +

    Details @@ -40,7 +40,7 @@
    • Call this method before calling or .
    • This method only applies to Android 5.0 or later.
      • -
    • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
      • +
    • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    @@ -50,8 +50,8 @@ enabled enable Whether to enable the image enhancement function:
      -
    • : Enable the image enhancement function.
      • -
    • : (Default) Disable the image enhancement function.
      • +
    • : Enable the image enhancement function.
      • +
    • : (Default) Disable the image enhancement function.
     @@ -64,13 +64,13 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        -
      • (4): The current device version is below Android 5.0, and this operation is not supported.
        • +
      • (4): The current device version is below Android 5.0, and this operation is not supported.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita index 353dc3e95a8..0883dc33a59 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita @@ -21,7 +21,7 @@ public abstract int SetCameraAutoExposureFaceModeEnabled(bool enabled); abstract setCameraAutoExposureFaceModeEnabled(enabled: boolean): number; Future<void> setCameraAutoExposureFaceModeEnabled(bool enabled); -

    +

    Details @@ -46,11 +46,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita index 45378234378..b52579c788c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita @@ -21,7 +21,7 @@ public abstract int SetCameraAutoFocusFaceModeEnabled(bool enabled); abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number; Future<void> setCameraAutoFocusFaceModeEnabled(bool enabled); -

    +

    Details @@ -48,15 +48,15 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    • : Success.
      • -
    • : Failure. See for details and resolution suggestions.
      • +
    • : Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita index 0d00826dfb3..6d05f24b2d7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita @@ -25,14 +25,14 @@ ): number;     Future<void> setCameraCapturerConfiguration( CameraCapturerConfiguration config); -

    +

    Details
    • This method is for Android and iOS only.
      • -
    • This method must be called after the camera is turned on, such as calling after and .
      • +
    • This method must be called after the camera is turned on, such as calling after and .
    Parameters @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita index 2d67eff7558..dcf37ff48df 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita @@ -28,13 +28,13 @@ ): number;     Future<void> setCameraDeviceOrientation( {required VideoSourceType type, required VideoOrientation orientation}); -

    +

    Details
    • This method applies to Windows only.
      • -
    • You must call this method after . The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the callback and returns the local video state as (1).
      • +
    • You must call this method after . The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the callback and returns the local video state as (1).
    • When the video capture device does not have the gravity sensing function, you can call this method to manually adjust the rotation angle of the captured video.
    @@ -53,11 +53,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita index b97cbf2036b..ab4472cf181 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita @@ -20,8 +20,8 @@ public abstract int SetCameraExposureFactor(float factor); abstract setCameraExposureFactor(factor: number): number; - Future<void> setCameraExposureFactor(double factor); -

    + Future<void> setCameraExposureFactor(double factor); +

    Details @@ -35,9 +35,9 @@
    • This method is for Android and iOS only.
      • -
    • You must call this method after . The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the callback and returns the local video state as (1).
      • -
    • Before calling this method, Agora recommends calling to check whether the current camera supports adjusting the exposure value.
      • -
    • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling .
      • +
    • You must call this method after . The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the callback and returns the local video state as (1).
      • +
    • Before calling this method, Agora recommends calling to check whether the current camera supports adjusting the exposure value.
      • +
    • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling .
    @@ -55,11 +55,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.

    Without practical meaning.

    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita index 0adac17a02e..746ee39a5c1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita @@ -28,7 +28,7 @@ ): number;     Future<void> setCameraExposurePosition( {required double positionXinView, required double positionYinView}); -

    +

    Details @@ -55,11 +55,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita index d5b4176ac22..4428591c9fd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita @@ -28,7 +28,7 @@ ): number;     Future<void> setCameraFocusPositionInPreview( {required double positionX, required double positionY}); -

    +

    Details @@ -55,11 +55,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita index a7067350b90..cbe84f3f14e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita @@ -21,7 +21,7 @@ public abstract int SetCameraTorchOn(bool isOn); abstract setCameraTorchOn(isOn: boolean): number; Future<void> setCameraTorchOn(bool isOn); -

    +

    Details @@ -44,11 +44,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita index efed0ab66a7..f769a79ede0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita @@ -21,7 +21,7 @@ public abstract int SetCameraZoomFactor(float factor); abstract setCameraZoomFactor(factor: number): number; Future<void> setCameraZoomFactor(double factor); -

    +

    Details @@ -40,8 +40,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • The camera zoom factor value, if successful.
    • < 0: if the method if failed.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita index 5c784f186fc..8bee826a854 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita @@ -20,7 +20,7 @@ public abstract int SetCloudProxy(CLOUD_PROXY_TYPE proxyType); abstract setCloudProxy(proxyType: CloudProxyType): number; Future<void> setCloudProxy(CloudProxyType proxyType); -

      +

    Details @@ -51,8 +51,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita index 33c5966ea52..7630342e143 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -1,7 +1,7 @@ - <ph keyref="setDefaultAudioRouteToSpeakerphone"/> + <ph keyref="setDefaultAudioRouteToSpeakerphone" /> Sets the default audio playback route. @@ -25,14 +25,14 @@ defaultToSpeaker: boolean ): number; Future<void> setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker); -

        +

    Details
    • This method applies to Android and iOS only.
      • -
    • Ensure that you call this method before joining a channel. If you need to change the audio route after joining a channel, call .
      • +
    • Ensure that you call this method before joining a channel. If you need to change the audio route after joining a channel, call .

    Most mobile phones have two audio routes: an earpiece at the top, and a speakerphone at the bottom. The earpiece plays at a lower volume, and the speakerphone at a higher volume. When setting the default audio route, you determine whether audio playback comes through the earpiece or speakerphone when no external audio device is connected.

    @@ -44,7 +44,7 @@
  • Video call: Speakerphone.
  • Video broadcast: Speakerphone.

    • -

    You can call this method to change the default audio route. After a successful method call, the SDK triggers the callback.

    +

    You can call this method to change the default audio route. After a successful method call, the SDK triggers the callback.

    The system audio route changes when an external audio device, such as a headphone or a Bluetooth audio device, is connected. See Audio Route for detailed change principles.
    @@ -60,11 +60,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita index dbd11ce3a89..99aec98c91a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita @@ -20,7 +20,7 @@ public abstract int SetDefaultMuteAllRemoteAudioStreams(bool mute); abstract setDefaultMuteAllRemoteAudioStreams(mute: boolean): number; Future<void> setDefaultMuteAllRemoteAudioStreams(bool mute); -

    +

    Details @@ -52,11 +52,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita index 54e36d90f22..945ce1247b0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita @@ -20,7 +20,7 @@ public abstract int SetDefaultMuteAllRemoteVideoStreams(bool mute); abstract setDefaultMuteAllRemoteVideoStreams(mute: boolean): number; Future<void> setDefaultMuteAllRemoteVideoStreams(bool mute); -

    +

    Details @@ -46,11 +46,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita index c349e0a32b9..a9c4cfb7f49 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita @@ -25,7 +25,7 @@ ): number;     Future<void> setDirectCdnStreamingAudioConfiguration( AudioProfileType profile); -

    +

    When you set the publishMicrophoneTrack or publishCustomAudioTrack in the as to capture audios, you can call this method to set the audio profile.

    @@ -41,11 +41,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita index 4cd0fcca6f6..1355511703f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita @@ -1,12 +1,12 @@ - <ph keyref="setDirectCdnStreamingVideoConfiguration"/> + <ph keyref="setDirectCdnStreamingVideoConfiguration" /> Sets the video profile of the media streams directly pushed to the CDN by the host. - + @@ -25,30 +25,30 @@ abstract setDirectCdnStreamingVideoConfiguration( config: VideoEncoderConfiguration ): number; - Future<void> setDirectCdnStreamingVideoConfiguration( + Future<void> setDirectCdnStreamingVideoConfiguration( VideoEncoderConfiguration config); -

    +

    Details -

    This method only affects video streams captured by cameras or screens, or from custom video capture sources. That is, when you set publishCameraTrack or publishCustomVideoTrack in as to capture videos, you can call this method to set the video profiles.

    -

    If your local camera does not support the video resolution you set,the SDK automatically adjusts the video resolution to a value that is closest to your settings for capture, encoding or streaming, with the same aspect ratio as the resolution you set. You can get the actual resolution of the video streams through the callback.

    +

    This method only affects video streams captured by cameras or screens, or from custom video capture sources. That is, when you set publishCameraTrack or publishCustomVideoTrack in as to capture videos, you can call this method to set the video profiles.

    +

    If your local camera does not support the video resolution you set,the SDK automatically adjusts the video resolution to a value that is closest to your settings for capture, encoding or streaming, with the same aspect ratio as the resolution you set. You can get the actual resolution of the video streams through the callback.

    Parameters config - Video profile. See .During CDN live streaming, Agora only supports setting as or . + Video profile. See .During CDN live streaming, Agora only supports setting as or .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita index b598cac0e33..02e17451941 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="setEarMonitoringAudioFrameParameters"/> + <ph keyref="setEarMonitoringAudioFrameParameters" /> Sets the format of the in-ear monitoring raw audio data. - + @@ -35,32 +35,32 @@ mode: RawAudioFrameOpModeType, samplesPerCall: number ): number;     - Future<void> setEarMonitoringAudioFrameParameters( + Future<void> setEarMonitoringAudioFrameParameters( {required int sampleRate, required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall}); -

    +

    Details -

    This method is used to set the in-ear monitoring audio data format reported by the callback.

    +

    This method is used to set the in-ear monitoring audio data format reported by the callback.

      -
    • Before calling this method, you need to call , and set includeAudioFilters to or .
      • -
    • The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the callback according to the sampling interval.
      • +
    • Before calling this method, you need to call , and set includeAudioFilters to or .
      • +
    • The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the callback according to the sampling interval.
    Parameters sampleRate - The sample rate of the audio data reported in the callback, which can be set as 8,000, 16,000, 32,000, 44,100, or 48,000 Hz. + The sample rate of the audio data reported in the callback, which can be set as 8,000, 16,000, 32,000, 44,100, or 48,000 Hz. channel -

    The number of audio channels reported in the callback.

      +

      The number of audio channels reported in the callback.

      • 1: Mono.
      • 2: Stereo.

      @@ -69,21 +69,21 @@ mode -

      The use mode of the audio frame. See .

      -

      +

      The use mode of the audio frame. See .

      +

      samplesPerCall - The number of data samples reported in the callback, such as 1,024 for the Media Push. + The number of data samples reported in the callback, such as 1,024 for the Media Push.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita index dad6c9c533f..c7036bb985b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita @@ -19,8 +19,8 @@ abstract setEffectPosition(soundId: number, pos: number): number; public abstract int SetEffectPosition(int soundId, int pos); abstract setEffectPosition(soundId: number, pos: number): number; - Future<void> setEffectPosition({required int soundId, required int pos}); -

    + Future<void> setEffectPosition({required int soundId, required int pos}); +

    Details @@ -39,11 +39,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita index c293caa1519..7fd47bb073b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita @@ -22,7 +22,7 @@ public abstract int SetEffectsVolume(int volume); abstract setEffectsVolume(volume: number): number; Future<void> setEffectsVolume(int volume); -

    +

    Details @@ -36,11 +36,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita index 4ce86a03d7a..5382707ee89 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita @@ -46,11 +46,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita index 41ec8961cd9..14e72cb8a27 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita @@ -20,7 +20,7 @@ public abstract int SetEncryptionMode(string encryptionMode); abstract setEncryptionMode(encryptionMode: string): number; Future<void> setEncryptionMode(String encryptionMode); -

    +

    Details @@ -51,11 +51,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita index 863a749f1ec..4ac45433337 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita @@ -20,7 +20,7 @@ public abstract int SetEncryptionSecret(string secret); abstract setEncryptionSecret(secret: string): number; Future<void> setEncryptionSecret(String secret); -

    +

    Details @@ -45,11 +45,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita index 02bb5db1745..ebcaf257fa1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita @@ -43,7 +43,7 @@ required String key, required String value, MediaSourceType type = MediaSourceType.unknownMediaSource});     -

    +

    Details @@ -74,11 +74,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita index eb1573f1e78..4cf670407f7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita @@ -33,7 +33,7 @@ ): number;     Future<void> setExtensionProviderProperty( {required String provider, required String key, required String value}); -

    +

    Details @@ -60,11 +60,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita index 841d090d1db..b234e31548f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="setHeadphoneEQParameters"/> + <ph keyref="setHeadphoneEQParameters" /> Sets the low- and high-frequency parameters of the headphone equalizer. - + @@ -19,9 +19,9 @@ abstract setHeadphoneEQParameters(lowGain: number, highGain: number): number; public abstract int SetHeadphoneEQParameters(int lowGain, int highGain); abstract setHeadphoneEQParameters(lowGain: number, highGain: number): number; - Future<void> setHeadphoneEQParameters( + Future<void> setHeadphoneEQParameters( {required int lowGain, required int highGain}); -

    +

    Details @@ -31,7 +31,7 @@
    v4.1.0
    -

    In a spatial audio effect scenario, if the preset headphone equalization effect is not achieved after calling the method, you can further adjust the headphone equalization effect by calling this method.

    +

    In a spatial audio effect scenario, if the preset headphone equalization effect is not achieved after calling the method, you can further adjust the headphone equalization effect by calling this method.

    Parameters @@ -46,8 +46,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        @@ -55,4 +55,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita index 8a28db48b24..556c5705289 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita @@ -20,7 +20,7 @@ public abstract int SetInEarMonitoringVolume(int volume); abstract setInEarMonitoringVolume(volume: number): number; Future<void> setInEarMonitoringVolume(int volume); -

    +

    Details @@ -39,11 +39,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita index 4ce591586fb..00daa75ddc8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita @@ -1,12 +1,12 @@ - <ph keyref="setLocalVoiceChanger"/> + <ph keyref="setLocalVoiceChanger" /> Sets the local voice changer option. - + @@ -18,9 +18,9 @@ virtual int setLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger) = 0; public abstract int SetLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger); - - -

    + + +

    Details @@ -28,9 +28,9 @@
    Deprecated:
    This method is deprecated, please use the following method instead:
      -
    • : Audio effects.
      • -
    • : Voice beautifier effects.
      • -
    • : Voice conversion effects.
      • +
    • : Audio effects.
      • +
    • : Voice beautifier effects.
      • +
    • : Voice conversion effects.
     @@ -41,7 +41,7 @@

      -
    • To achieve better voice effect quality, Agora recommends setting the profile parameter in as (4) or (5).
      • +
    • To achieve better voice effect quality, Agora recommends setting the profile parameter in as (4) or (5).
    • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music and a human voice.
    • You can call this method either before or after joining a channel.
    @@ -51,30 +51,30 @@ voiceChanger -

    The local voice changer option. The default value is , which means the original voice. See . The gender-based beatification effect works best only when assigned a proper gender. Use for male and use and for female. Otherwise, voice distortion might occur.

    +

    The local voice changer option. The default value is , which means the original voice. See . The gender-based beatification effect works best only when assigned a proper gender. Use for male and use and for female. Otherwise, voice distortion might occur.

    The local voice changer option:

      -
    • : +
    • : (Default) Turn off the local voice changer, that is, to use the original voice.
      • -
    • : The voice of an old man.
      • -
    • : The voice of a little boy.
      • -
    • : The voice of a little girl.
      • -
    • : The voice of Zhu Bajie, a character in Journey to the West who has a voice like that of a growling bear.
      • -
    • : The ethereal voice.
      • -
    • : The voice of Hulk.
      • -
    • : A more vigorous voice.
      • -
    • : A deeper voice.
      • -
    • : A mellower voice.
      • -
    • : Falsetto.
      • -
    • : A fuller voice.
      • -
    • : A clearer voice.
      • -
    • : A more resounding voice.
      • -
    • : A more ringing voice.
      • -
    • : A more spatially resonant voice.
      • -
    • : +
    • : The voice of an old man.
      • +
    • : The voice of a little boy.
      • +
    • : The voice of a little girl.
      • +
    • : The voice of Zhu Bajie, a character in Journey to the West who has a voice like that of a growling bear.
      • +
    • : The ethereal voice.
      • +
    • : The voice of Hulk.
      • +
    • : A more vigorous voice.
      • +
    • : A deeper voice.
      • +
    • : A mellower voice.
      • +
    • : Falsetto.
      • +
    • : A fuller voice.
      • +
    • : A clearer voice.
      • +
    • : A more resounding voice.
      • +
    • : A more ringing voice.
      • +
    • : A more spatially resonant voice.
      • +
    • : (For male only) A more magnetic voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. Do not use it when the speaker is a female; otherwise, voice distortion occurs.
      • -
    • : +
    • : (For female only) A fresher voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. Do not use it when the speaker is a male; otherwise, voice distortion occurs.
      • -
    • : +
    • : (For female only) A more vital voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. Do not use it when the speaker is a male; otherwise, voice distortion occurs.

     @@ -84,7 +84,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita index 4c0206a7fe5..44e9518a70b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita @@ -30,7 +30,7 @@ Future<void> setLocalVoiceEqualization( {required AudioEqualizationBandFrequency bandFrequency, required int bandGain}); -

    +

    Details @@ -49,11 +49,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita index 507e51d325d..f46afbc775c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita @@ -1,12 +1,12 @@ - <ph keyref="setLocalVoiceFormant"/> + <ph keyref="setLocalVoiceFormant" /> Set the formant ratio to change the timbre of human voice. - + @@ -20,7 +20,7 @@ abstract setLocalVoiceFormant(formantRatio: number): number; public abstract int SetLocalVoiceFormant(double formantRatio); abstract setLocalVoiceFormant(formantRatio: number): number; - Future<void> setLocalVoiceFormant(double formantRatio);

    + Future<void> setLocalVoiceFormant(double formantRatio);

    Details @@ -31,7 +31,7 @@

    Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper.

    -

    You can call this method to set the formant ratio of local audio to change the timbre of human voice. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with .You can call this method either before or after joining a channel.

    +

    You can call this method to set the formant ratio of local audio to change the timbre of human voice. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with .You can call this method either before or after joining a channel.

    Parameters @@ -42,11 +42,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita index cdbabedbe81..19f8c4bf777 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita @@ -20,7 +20,7 @@ public abstract int SetLocalVoicePitch(double pitch); abstract setLocalVoicePitch(pitch: number): number; Future<void> setLocalVoicePitch(double pitch); -

    +

    Details @@ -34,11 +34,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita index bf14c41e91b..9f3614e9547 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita @@ -27,7 +27,7 @@ ): number;     Future<void> setLocalVoiceReverb( {required AudioReverbType reverbKey, required int value}); -

    +

    Details @@ -47,11 +47,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita index 630b5783e67..ed0435ddadc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita @@ -1,12 +1,12 @@ - <ph keyref="setLocalVoiceReverbPreset"/> + <ph keyref="setLocalVoiceReverbPreset" /> Sets the local voice reverberation option, including the virtual stereo. - + @@ -18,9 +18,9 @@ virtual int setLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset) = 0; public abstract int SetLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset); - - -

    + + +

    Details @@ -28,14 +28,14 @@
    Deprecated:
    -
    Use or instead.
    +
    Use or instead.

    This method sets the local voice reverberation for users in a COMMUNICATION channel or hosts in a live boradcasting channel. After successfully calling this method, all users in the channel can hear the voice with reverberation.

      -
    • When using the enumeration value prefixed with AUDIO_REVERB_FX, ensure that you set the profile parameter in to (4) or (5) before calling this method. Otherwise, the method setting is invalid.
      • -
    • When calling the method, Agora recommends setting the profile parameter in as (5).
      • +
    • When using the enumeration value prefixed with AUDIO_REVERB_FX, ensure that you set the profile parameter in to (4) or (5) before calling this method. Otherwise, the method setting is invalid.
      • +
    • When calling the method, Agora recommends setting the profile parameter in as (5).
    • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music and a human voice.
    • You can call this method either before or after joining a channel.
    @@ -46,17 +46,17 @@ reverbPreset preset -

    The local voice reverberation option. The default value is , which means the original voice. See . To achieve better voice effects, Agora recommends the enumeration whose name begins with AUDIO_REVERB_FX.

     +

    The local voice reverberation option. The default value is , which means the original voice. See . To achieve better voice effects, Agora recommends the enumeration whose name begins with AUDIO_REVERB_FX.

    The local voice reverberation option. To achieve better voice effects, Agora recommends the enumeration whose name begins with AUDIO_REVERB_FX.

      -
    • : (Default) Turn off local voice reverberation, that is, to use the original voice.
      • -
    • : The reverberation style typical of a KTV venue (enhanced).
      • -
    • : The reverberation style typical of a concert hall (enhanced).
      • -
    • : The reverberation style typical of an uncle's voice.
      • -
    • : The reverberation style typical of a little sister's voice.
      • -
    • : The reverberation style typical of a recording studio (enhanced).
      • -
    • : The reverberation style typical of popular music (enhanced).
      • -
    • : The reverberation style typical of R&B music (enhanced).
      • -
    • : The reverberation style typical of the vintage phonograph.
      • +
    • : (Default) Turn off local voice reverberation, that is, to use the original voice.
      • +
    • : The reverberation style typical of a KTV venue (enhanced).
      • +
    • : The reverberation style typical of a concert hall (enhanced).
      • +
    • : The reverberation style typical of an uncle's voice.
      • +
    • : The reverberation style typical of a little sister's voice.
      • +
    • : The reverberation style typical of a recording studio (enhanced).
      • +
    • : The reverberation style typical of popular music (enhanced).
      • +
    • : The reverberation style typical of R&B music (enhanced).
      • +
    • : The reverberation style typical of the vintage phonograph.

     @@ -67,7 +67,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita index 80965a3119d..699cf983f1a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita @@ -20,7 +20,7 @@ public abstract int SetLogFile(string filePath); abstract setLogFile(filePath: string): number; Future<void> setLogFile(String filePath); -

    +

    Details @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita index 929b0904df9..08e9e205504 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita @@ -20,7 +20,7 @@ public abstract int SetLogFileSize(uint fileSizeInKBytes); abstract setLogFileSize(fileSizeInKBytes: number): number; Future<void> setLogFileSize(int fileSizeInKBytes); -

    +

    Details @@ -57,11 +57,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita index 99dae0f6f92..b0f0a28982b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita @@ -20,7 +20,7 @@ public abstract int SetLogFilter(uint filter); abstract setLogFilter(filter: LogFilterType): number; Future<void> setLogFilter(LogFilterType filter); -

    +

    Details @@ -51,11 +51,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita index 026c78cdcda..7fcfd301584 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita @@ -21,7 +21,7 @@ public abstract int SetLogLevel(LOG_LEVEL level); abstract setLogLevel(level: LogLevel): number; Future<void> setLogLevel(LogLevel level); -

    +

    Details @@ -42,11 +42,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita index 5ed3f2d3c95..28c7a9d8607 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita @@ -20,7 +20,7 @@ public abstract int SetMaxMetadataSize(int size); abstract setMaxMetadataSize(size: number): number; Future<void> setMaxMetadataSize(int size); -

    +

    Details @@ -35,11 +35,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita index 9e32349fd66..4782d7d8458 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita @@ -33,7 +33,7 @@ {required int sampleRate, required int channel, required int samplesPerCall});     -

    +

    Parameters @@ -65,11 +65,11 @@

    The SDK triggers the callback according to the sample interval. Sampleinterval (sec) = samplePerCall/(sampleRate × channel) Ensure that the value of sample interval more than or equal to 0.01.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita index b0c8fb9b316..ac0bc4d66df 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="setParameters"/> + <ph keyref="setParameters" /> Provides technical preview functionalities or special customizations by configuring the SDK with JSON options. - + @@ -19,7 +19,7 @@ abstract setParameters(parameters: string): number; public abstract int SetParameters(string key, object value); abstract setParameters(parameters: string): number; - Future<void> setParameters(String parameters);

    + Future<void> setParameters(String parameters);

    @@ -48,11 +48,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita index 30149030c35..c3611ea65fb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita @@ -26,9 +26,9 @@ sampleRate: number, channel: number ): number;     - Future<void> setPlaybackAudioFrameBeforeMixingParameters( + Future<void> setPlaybackAudioFrameBeforeMixingParameters( {required int sampleRate, required int channel}); -

    +

    Parameters @@ -49,11 +49,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita index e4fd1db0458..9a6d8ceb59f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita @@ -42,7 +42,7 @@ required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall});     -

    +

    Details @@ -81,11 +81,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita index c97791f7da0..f5aba2a5674 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita @@ -41,7 +41,7 @@ required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall});     -

    +

    Details @@ -89,11 +89,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita index e290f6bd188..0d7a187bad5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita @@ -20,13 +20,13 @@ public abstract int SetRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType); abstract setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number; Future<void> setRemoteDefaultVideoStreamType(VideoStreamType streamType); -

    +

    Details

    Under limited network conditions, if the publisher has not disabled the dual-stream mode using (), the receiver can choose to receive either the high-quality video stream or the low-video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

    By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.

    -

    +

    • Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
      • @@ -40,18 +40,18 @@

      The default video-stream type. See .

      The default video-stream type:

        -
      • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
        • -
      • (1): Low-quality stream, that is, a low-resolution and low-bitrate video stream.
        • +
      • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
        • +
      • (1): Low-quality stream, that is, a low-resolution and low-bitrate video stream.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita index fc146125ad0..26220da8607 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteRenderMode1"/> + <ph keyref="setRemoteRenderMode1" /> Sets the video display mode of a specified remote user. - + @@ -19,16 +19,16 @@ virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode) = 0; public abstract int SetRemoteRenderMode(uint userId, RENDER_MODE_TYPE renderMode); - - -

    + + +

    Details
    Deprecated:
    -
    This method is deprecated. Use instead.
    +
    This method is deprecated. Use instead.

    Call this method to set the video display mode of a specified remote user. This method can be called multiple times during a call to change the display mode.

    @@ -43,10 +43,10 @@ renderMode -

    The rendering mode of the remote user view. For details, see .

    +

    The rendering mode of the remote user view. For details, see .

    The rendering mode of the remote user view.

      -
    • (1): Hidden mode. Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
      • -
    • (2): Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.
      • +
    • (1): Hidden mode. Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
      • +
    • (2): Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.

         @@ -55,7 +55,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita index 9da366f6bca..9b83d956cbf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita @@ -33,7 +33,7 @@ {required int uid, required RenderModeType renderMode, required VideoMirrorModeType mirrorMode});     -

    +

    Details @@ -73,11 +73,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita index 05c086ebab2..27ead4d2a67 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita @@ -24,12 +24,12 @@ option: StreamFallbackOptions ): number;     Future<void> setRemoteSubscribeFallbackOption(StreamFallbackOptions option); -

    +

    Details -

    When the network is not ideal, the quality of live audio and video can be degraded. If option is set as or , the SDK automatically switches the video from a high-quality stream to a low-quality stream or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. The SDK monitors the network quality and restores the video stream when the network conditions improve.

    -

    When the remote video stream falls back to audio-only or when the audio-only stream switches back to the video, the SDK triggers the callback.

    +

    When the network is not ideal, the quality of live audio and video can be degraded. If option is set as or , the SDK automatically switches the video from a high-quality stream to a low-quality stream or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. The SDK monitors the network quality and restores the video stream when the network conditions improve.

    +

    When the remote video stream falls back to audio-only or when the audio-only stream switches back to the video, the SDK triggers the callback.

    Ensure that you call this method before joining a channel.
    Parameters @@ -44,11 +44,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita index 24ef7b2d3e4..64321086e98 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteUserPriority"/> + <ph keyref="setRemoteUserPriority" /> Prioritizes a remote user's stream. - + @@ -18,8 +18,8 @@ virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0; public abstract int SetRemoteUserPriority(uint uid, PRIORITY_TYPE userPriority); - -

    + +

    Details @@ -39,9 +39,9 @@ userPriority -

    The priority of the remote user. See .

      -
    • : The user's priority is high.
      • -
    • : (Default) The user's priority is normal.
      • +

      The priority of the remote user. See .

        +
      • : The user's priority is high.
        • +
      • : (Default) The user's priority is normal.

      @@ -50,7 +50,7 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita index 68b50bcb620..bea965da0ed 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita @@ -28,7 +28,7 @@ ): number;     Future<void> setRemoteVideoStreamType( {required int uid, required VideoStreamType streamType}); -

    +

    Details @@ -46,7 +46,7 @@ streamType -

    The video stream type: .

    +

    The video stream type: .

    The video stream type:

    • 0: High-quality video stream.
    • 1: Low-quality video stream.
      • @@ -55,11 +55,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita index ab0089b9a66..77c7df806c1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteVideoSubscriptionOptions"/> + <ph keyref="setRemoteVideoSubscriptionOptions" /> Options for subscribing to remote video streams. - + @@ -26,24 +26,24 @@ uid: number, options: VideoSubscriptionOptions ): number;     - Future<void> setRemoteVideoSubscriptionOptions( + Future<void> setRemoteVideoSubscriptionOptions( {required int uid, required VideoSubscriptionOptions options}); -

    +

    Details

    When a remote user has enabled dual-stream mode, you can call this method to choose the option for subscribing to the video streams sent by the remote user.

      -
    • If you only register one object, the SDK subscribes to the raw video data and encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • -
    • If you only register one object, the SDK only subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • -
    • If you register one object and one object successively, the SDK subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • -
    • If you call this method first with the options parameter set, and then register one or object, you need to call this method again and set the options parameter as described in the above two items to get the desired results.
      • +
    • If you only register one object, the SDK subscribes to the raw video data and encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • +
    • If you only register one object, the SDK only subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • +
    • If you register one object and one object successively, the SDK subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • +
    • If you call this method first with the options parameter set, and then register one or object, you need to call this method again and set the options parameter as described in the above two items to get the desired results.

    Agora recommends the following steps:
      -
    1. Set autoSubscribeVideo to when calling to join a channel.
      2. -
    2. Call this method after receiving the callback to set the subscription options for the specified remote user's video stream.
      3. -
    3. Call the method to resume subscribing to the video stream of the specified remote user. If you set encodedFrameOnly to in the previous step, the SDK triggers the callback locally to report the received encoded video frame information.
      4. +
    4. Set autoSubscribeVideo to when calling to join a channel.
      5. +
    5. Call this method after receiving the callback to set the subscription options for the specified remote user's video stream.
      6. +
    6. Call the method to resume subscribing to the video stream of the specified remote user. If you set encodedFrameOnly to in the previous step, the SDK triggers the callback locally to report the received encoded video frame information.
    Parameters @@ -54,15 +54,15 @@ options - The video subscription options. See . + The video subscription options. See .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita index d9e5b3f6ea4..372c999b013 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita @@ -29,7 +29,7 @@ ): number;     Future<void> setRemoteVoicePosition( {required int uid, required double pan, required double gain}); -

    +

    Details @@ -62,11 +62,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita index 2a3eb28533d..96749ace09d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita @@ -23,7 +23,7 @@ public abstract int SetScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario); abstract setScreenCaptureScenario(screenScenario: ScreenScenarioType): number; Future<void> setScreenCaptureScenario(ScreenScenarioType screenScenario); -

    +

    Details @@ -40,11 +40,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita index 7b4a7018632..e016c8eff6a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeAudioAllowlist"/> + <ph keyref="setSubscribeAudioAllowlist" /> Sets the allowlist of subscriptions for audio streams. - + @@ -25,19 +25,19 @@ uidList: number[], uidNumber: number ): number;     - Future<void> setSubscribeAudioAllowlist( - {required List<int> uidList, required int uidNumber}); -

    + Future<void> setSubscribeAudioAllowlist( + {required List<int> uidList, required int uidNumber}); +

    Details

    You can call this method to specify the audio streams of a user that you want to subscribe to.

      -
    • -
    • The allowlist is not affected by the setting in , and autoSubscribeAudio in .
      • +
    • +
    • The allowlist is not affected by the setting in , and autoSubscribeAudio in .
    • Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
      • -
    • +
    Parameters @@ -47,7 +47,7 @@ allowlist

    The user ID list of users that you want to subscribe to.

    -

    If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

    +

    If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

     @@ -56,12 +56,12 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita index 638cfdcff70..b7aa7534624 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita @@ -25,9 +25,9 @@ uidList: number[], uidNumber: number ): number;     - Future<void> setSubscribeAudioBlocklist( - {required List<int> uidList, required int uidNumber}); -

    + Future<void> setSubscribeAudioBlocklist( + {required List<int> uidList, required int uidNumber}); +

    Details @@ -56,11 +56,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita index 1019d21db4c..30090d2388c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeVideoAllowlist"/> + <ph keyref="setSubscribeVideoAllowlist" /> Set the allowlist of subscriptions for video streams. - + @@ -25,19 +25,19 @@ uidList: number[], uidNumber: number ): number;     - Future<void> setSubscribeVideoAllowlist( - {required List<int> uidList, required int uidNumber}); -

    + Future<void> setSubscribeVideoAllowlist( + {required List<int> uidList, required int uidNumber}); +

    Details

    You can call this method to specify the video streams of a user that you want to subscribe to.

      -
    • -
    • The allowlist is not affected by the setting in , and autoSubscribeAudio in .
      • -
    • -
    • +
    • +
    • The allowlist is not affected by the setting in , and autoSubscribeAudio in .
      • +
    • +
    Parameters @@ -46,21 +46,21 @@ uidList

    The user ID list of users that you want to subscribe to.

    -

    If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

    +

    If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita index 8533ca93c0e..97a75d15bb3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeVideoBlocklist"/> + <ph keyref="setSubscribeVideoBlocklist" /> Set the blocklist of subscriptions for video streams. - + @@ -25,19 +25,19 @@ uidList: number[], uidNumber: number ): number;     - Future<void> setSubscribeVideoBlocklist( - {required List<int> uidList, required int uidNumber}); -

    + Future<void> setSubscribeVideoBlocklist( + {required List<int> uidList, required int uidNumber}); +

    Details

    You can call this method to specify the video streams of a user that you do not want to subscribe to.

      -
    • -
    • The blocklist is not affected by the setting in , and autoSubscribeAudio in .
      • -
    • -
    • +
    • +
    • The blocklist is not affected by the setting in , and autoSubscribeAudio in .
      • +
    • +
    Parameters @@ -47,21 +47,21 @@ blocklist

    The user ID list of users that you do not want to subscribe to.

    -

    If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.

    +

    If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.

     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita index 11316726123..000910ab81f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoScenario"/> + <ph keyref="setVideoScenario" /> Sets video application scenarios. - + @@ -19,7 +19,7 @@ abstract setVideoScenario(scenarioType: VideoApplicationScenarioType): number; public abstract int SetVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType); abstract setVideoScenario(scenarioType: VideoApplicationScenarioType): number; - Future<void> setVideoScenario(VideoApplicationScenarioType scenarioType);

    + Future<void> setVideoScenario(VideoApplicationScenarioType scenarioType);

    Details @@ -37,11 +37,11 @@ scenarioType - The type of video application scenario. See .

    If set to (1), the SDK automatically enables the following strategies:

      + The type of video application scenario. See .

      If set to (1), the SDK automatically enables the following strategies:

      • In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
      • The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
        • If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
          • -
        • If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the configuration used in the most recent calling of . If no configuration has been set by the user previously, the following values are used:
            +
          • If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the configuration used in the most recent calling of . If no configuration has been set by the user previously, the following values are used:
            • Resolution: (Windows and macOS) 1280 × 720; (Android and iOS) 960 × 540
            • Frame rate: 15 fps
            • Bitrate: (Windows and macOS) 1600 Kbps; (Android and iOS) 1000 Kbps
              • @@ -58,9 +58,9 @@
          • -
        • The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers.If the user has called to set that never send low-quality video stream (), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
            +
          • The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers.If the user has called to set that never send low-quality video stream (), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
            • If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth.
              • -
            • If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the configuration used in the most recent calling of . If no configuration has been set by the user previously, the following values are used:
                +
              • If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the configuration used in the most recent calling of . If no configuration has been set by the user previously, the following values are used:
                • Resolution: 480 × 272
                • Frame rate: 15 fps
                • Bitrate: 500 Kbps
                  • @@ -74,12 +74,12 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita index 46c4ddd360c..b4bb201c64b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita @@ -27,7 +27,7 @@ {required VoiceBeautifierPreset preset, required int param1, required int param2});     -

    +

    Details @@ -74,11 +74,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita index 30fdf732ab4..8a2510e105d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita @@ -20,7 +20,7 @@ public abstract int SetVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset); abstract setVoiceBeautifierPreset(preset: VoiceBeautifierPreset): number; Future<void> setVoiceBeautifierPreset(VoiceBeautifierPreset preset); -

    +

    Details @@ -40,7 +40,7 @@
    • -
  • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters @@ -75,11 +75,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita index 3b951e59d1f..2d829a82d0e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita @@ -1,12 +1,12 @@ - <ph keyref="setVoiceConversionPreset"/> + <ph keyref="setVoiceConversionPreset" /> Sets a preset voice beautifier effect. - + @@ -20,28 +20,28 @@ public abstract int SetVoiceConversionPreset(VOICE_CONVERSION_PRESET preset); abstract setVoiceConversionPreset(preset: VoiceConversionPreset): number; Future<void> setVoiceConversionPreset(VoiceConversionPreset preset); -

    +

    Details

    Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting an audio effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios. For the applicable scenarios of each voice beautifier effect, refer to Set the Voice Effect.

    -

    To achieve better audio effect quality, Agora recommends that you call and set the profile to (4) or (5) and scenario to (3) before calling this method.

    +

    To achieve better audio effect quality, Agora recommends that you call and set the profile to (4) or (5) and scenario to (3) before calling this method.

    • You can call this method either before or after joining a channel.
      • -
    • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
      • +
    • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
    • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
      • -
    • After calling , Agora does not recommend you to call the following methods, otherwise the effect set by will be overwritten:
        -
        • -
        • -
        • -
        • -
        • -
        • -
        • -
        • +
      • After calling , Agora does not recommend you to call the following methods, otherwise the effect set by will be overwritten:
          +
          • +
          • +
          • +
          • +
          • +
          • +
          • +
        • -
      • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
        • +
      • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    Parameters @@ -49,23 +49,23 @@ preset -

    The options for the preset voice beautifier effects: .

    +

    The options for the preset voice beautifier effects: .

    The options for SDK preset voice conversion effects.

      -
    • : Turn off voice conversion effects and use the original voice.
      • -
    • : A gender-neutral voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      • -
    • : A sweet voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      • -
    • : A steady voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
      • -
    • : A deep voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
      • +
    • : Turn off voice conversion effects and use the original voice.
      • +
    • : A gender-neutral voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      • +
    • : A sweet voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      • +
    • : A steady voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
      • +
    • : A deep voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita index f35babf3df4..da018675a82 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita @@ -23,7 +23,7 @@ public abstract int SetVolumeOfEffect(int soundId, int volume); abstract setVolumeOfEffect(soundId: number, volume: number): number; Future<void> setVolumeOfEffect({required int soundId, required int volume}); -

    +

    Parameters @@ -38,11 +38,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita index 035867c10a1..6938df3d404 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita @@ -26,12 +26,12 @@ cycle: number, startPos?: number ): number;     - Future<void> startAudioMixing( + Future<void> startAudioMixing( {required String filePath, required bool loopback, required int cycle, int startPos = 0}); -

    +

    Details @@ -85,11 +85,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita index d5c4b3064c8..b574fc826f0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita @@ -29,7 +29,7 @@ cycle: number, startPos?: number ): number;     - Future<void> startAudioMixing( + Future<void> startAudioMixing( {required String filePath, required bool loopback, required int cycle, @@ -42,10 +42,10 @@

    This method supports playing URI files starting with content://.

      -
    • You can call this method either before or after joining a channel. If you need to call multiple times, ensure that the time interval between calling this method is more than 500 ms.
      • +
    • You can call this method either before or after joining a channel. If you need to call multiple times, ensure that the time interval between calling this method is more than 500 ms.
    • If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports 701.
    • -
    • +
    • On Android, there are following considerations:
      • To use this method, ensure that the Android device is v4.2 or later, and the API version is v16 or later.
      • If you need to play an online music file, Agora does not recommend using the redirected URL address. Some Android devices may fail to open a redirected URL address.
        • @@ -83,8 +83,8 @@
        - <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

        + <ph keyref="return-section-title" /> +

        When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

        • 0: Success.
        • < 0: Failure.
            @@ -93,11 +93,11 @@
          • -3: The SDK is not ready.
            • The audio module is disabled.
            • The program is not complete.
              • -
            • The initialization of fails. Reinitialize the .
              • +
            • The initialization of fails. Reinitialize the .
        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita index f194d9953b2..6852d4dbe39 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita @@ -1,12 +1,12 @@ - <ph keyref="startAudioRecording1"/> + <ph keyref="startAudioRecording1" /> Starts audio recording on the client. - + @@ -19,9 +19,9 @@ virtual int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; public abstract int StartAudioRecording(string filePath, AUDIO_RECORDING_QUALITY_TYPE quality); - - -

        + + +

        Details @@ -30,18 +30,18 @@
      • .wav: Large file size with high fidelity.
      • .aac: Small file size with low fidelity.

      -

      Ensure that the directory for the recording file exists and is writable. This method should be called after the method. The recording automatically stops when you call the method.

      +

      Ensure that the directory for the recording file exists and is writable. This method should be called after the method. The recording automatically stops when you call the method.

      Parameters - - + + quality - Audio recording quality. See .
        + Audio recording quality. See .
        • 0: Low quality. The sample rate is 32 kHz, and the file size is around 1.2 MB after 10 minutes of recording.
        • 1: Medium quality. The sample rate is 32 kHz, and the file size is around 2 MB after 10 minutes of recording.
        • 2: High quality. The sample rate is 32 kHz, and the file size is around 3.75 MB after 10 minutes of recording.
          • @@ -52,7 +52,7 @@ Returns
          • 0: Success.
            • -
          • < 0: Failure. See for details and resolution suggestions.
            • +
          • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita index 72e7f7bb71c..d82d33d29bc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita @@ -1,12 +1,12 @@ - <ph keyref="startAudioRecording2"/> + <ph keyref="startAudioRecording2" /> Starts audio recording on the client and sets the sample rate of recording. - + @@ -18,11 +18,11 @@ virtual int startAudioRecording(const char* filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; - + public abstract int StartAudioRecording(string filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality); - - -

      + + +

      Details @@ -33,15 +33,15 @@
      • Ensure that the directory you use to save the recording file exists and is writable.
        • -
      • This method should be called after the method. The recording automatically stops when you call the method.
        • -
      • For better recording effects, set quality to or when sampleRate is 44.1 kHz or 48 kHz.
        • +
      • This method should be called after the method. The recording automatically stops when you call the method.
        • +
      • For better recording effects, set quality to or when sampleRate is 44.1 kHz or 48 kHz.
      Parameters - - + + sampleRate @@ -56,14 +56,14 @@ quality - Recording quality. See . + Recording quality. See .
      Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita index ac170c1e9cc..04da9d3ff5d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita @@ -22,14 +22,14 @@ public abstract int StartEchoTest(int intervalInSeconds); abstract startEchoTest(intervalInSeconds?: number): number; Future<void> startEchoTest({int intervalInSeconds = 10}); -

      +

      Details
      Deprecated:
      -
      This method is deprecated as of v4.0.1. Use instead.
      +
      This method is deprecated as of v4.0.1. Use instead.

      This method starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly. To conduct the test, let the user speak for a while, and the recording is played back within the set interval. If the user can hear the recording within the interval, the audio devices and network connection are working properly.

      @@ -53,11 +53,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita index faa510de4f5..ae18688dd1a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita @@ -20,7 +20,7 @@ public abstract int StartLastmileProbeTest(LastmileProbeConfig config); abstract startLastmileProbeTest(config: LastmileProbeConfig): number; Future<void> startLastmileProbeTest(LastmileProbeConfig config); -

      +

      Details @@ -47,11 +47,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita index 65ffe08dc58..051994b83b1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita @@ -25,7 +25,7 @@ config: LocalTranscoderConfiguration ): number;       Future<void> startLocalVideoTranscoder(LocalTranscoderConfiguration config); -

      +

      Details @@ -39,16 +39,16 @@
    • On Android and iOS platforms, it supports video streams captured by up to 2 cameras (the device itself needs to support dual cameras or supports external cameras) + 1 screen sharing stream.
    • On the Android platform, it supports up to 2 video streams captured by cameras (the device itself needs to support dual cameras or support external cameras) + 1 screen sharing stream.
    • On the iOS platform, it supports up to 2 video streams captured by cameras (the device itself needs to support dual cameras or support external cameras) + 1 screen sharing stream.
    -
  • If you need to mix the locally collected video streams, you need to call this method after or .
    • -
  • If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in to when calling or .
    • +
  • If you need to mix the locally collected video streams, you need to call this method after or .
    • +
  • If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in to when calling or .
    •
    Applicable scenarios

    You can enable the local video mixing function in scenarios such as remote conferences, live streaming, and online education, which allows users to view and manage multiple videos more conveniently, and supports portrait-in-picture effect and other functions.

    The following is a typical use case for implementing the portrait-in-picture effect:

      -
    1. Call , and set the custom background image to , that is, separate the portrait and the background in the video captured by the camera.
      2. -
    2. Call to start capturing the screen sharing video stream.
      3. +
    3. Call , and set the custom background image to , that is, separate the portrait and the background in the video captured by the camera.
      4. +
    4. Call to start capturing the screen sharing video stream.
    5. Call this method and set the video source for capturing portraits as one of the video sources participating in the local video mixing, and the portrait picture-invideo mixing can be added in the mixed image video.When configuring the local video mixing, it is necessary to ensure that the layer number of the video stream capturing the portrait is greater than the layer number of the screen sharing stream. Otherwise, the portrait will be covered by the screen sharing and will not be displayed in the final mixed video stream.

    @@ -63,11 +63,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita index bf7d0f91397..5338aff54bb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita @@ -1,12 +1,12 @@ - <ph keyref="startMediaRenderingTracing"/> + <ph keyref="startMediaRenderingTracing" /> Enables tracing the video frame rendering process. - + @@ -19,7 +19,7 @@ abstract startMediaRenderingTracing(): number; public abstract int StartMediaRenderingTracing(); abstract startMediaRenderingTracing(): number; - Future<void> startMediaRenderingTracing();

    + Future<void> startMediaRenderingTracing();

    Details @@ -29,7 +29,7 @@
    v4.1.1
    -

    The SDK starts tracing the rendering status of the video frames in the channel from the moment this method is successfully called and reports information about the event through the callback.

    +

    The SDK starts tracing the rendering status of the video frames in the channel from the moment this method is successfully called and reports information about the event through the callback.

    • By default, the SDK starts tracing the video rendering event automatically when the local user successfully joins the channel. You can call this method at an appropriate time according to the actual application scenario to customize the tracing process.
      • @@ -37,16 +37,16 @@
    Applicable scenarios -

    Agora recommends that you use this method in conjunction with the UI settings (such as buttons and sliders) in your app to improve the user experience. For example, call this method when the user clicks the Join Channel button, and then get the indicators in the video frame rendering process through the callback, so as to optimize the indicators accordingly.

    +

    Agora recommends that you use this method in conjunction with the UI settings (such as buttons and sliders) in your app to improve the user experience. For example, call this method when the user clicks the Join Channel button, and then get the indicators in the video frame rendering process through the callback, so as to optimize the indicators accordingly.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        -
      • -7: The method is called before is initialized.
        • +
      • < 0: Failure. See for details and resolution suggestions.
          +
        • -7: The method is called before is initialized.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita index ad77f904938..0e1fc31e7e5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita @@ -37,7 +37,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita index 2713bd15961..5446d6518a3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita @@ -22,7 +22,7 @@ abstract startPreview(sourceType?: VideoSourceType): number; Future<void> startPreview( {VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary}); -

    +

    Details @@ -48,11 +48,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita index 639a2d42539..4b9c6eaffc6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita @@ -1,12 +1,12 @@ - <ph keyref="startRtmpStreamWithTranscoding"/> + <ph keyref="startRtmpStreamWithTranscoding" /> Starts Media Push and sets the transcoding configuration. - + @@ -27,19 +27,19 @@ ): number;     Future<void> startRtmpStreamWithTranscoding( {required String url, required LiveTranscoding transcoding}); -

    +

    Details

    Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

    You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.

    -

    Under one Agora project, the maximum number of concurrent tasks to push media streams is 200 by default. If you need a higher quota, contact .

    -

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    +

    Under one Agora project, the maximum number of concurrent tasks to push media streams is 200 by default. If you need a higher quota, contact .

    +

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    • Call this method after joining a channel.
    • Only hosts in the LIVE_BROADCASTING profile can call this method.
      • -
    • If you want to retry pushing streams after a failed push, make sure to call first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
      • +
    • If you want to retry pushing streams after a failed push, make sure to call first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
    Parameters @@ -51,13 +51,13 @@ transcoding -

    The transcoding configuration for Media Push. See .

    +

    The transcoding configuration for Media Push. See .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        @@ -67,4 +67,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita index 9aa82f3e690..83697a36173 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita @@ -22,14 +22,14 @@ public abstract int StopAllEffects(); abstract stopAllEffects(): number; Future<void> stopAllEffects(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita index 46b9a4dd316..d00a848d079 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita @@ -20,18 +20,18 @@ public abstract int StopAudioMixing(); abstract stopAudioMixing(): number; Future<void> stopAudioMixing(); -

    +

    Details

    This method stops the audio mixing. Call this method when you are in a channel.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita index e2c3c95a115..e635ab313d3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita @@ -20,14 +20,14 @@ public abstract int StopAudioRecording(); abstract stopAudioRecording(): number; Future<void> stopAudioRecording(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita index aa1ec791dec..a6ecfe0dce5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita @@ -19,8 +19,8 @@ abstract stopCameraCapture(sourceType: VideoSourceType): number; public abstract int StopCameraCapture(VIDEO_SOURCE_TYPE sourceType); abstract stopCameraCapture(sourceType: VideoSourceType): number; - Future<void> stopCameraCapture(VideoSourceType sourceType); -

    + Future<void> stopCameraCapture(VideoSourceType sourceType); +

    Details @@ -31,7 +31,7 @@

    After calling to start capturing video through one or more cameras, you can call this method and set the sourceType parameter to stop the capture from the specified cameras.

    - On the iOS platform, if you want to disable multi-camera capture, you need to call after calling this method and set enabled to . + On the iOS platform, if you want to disable multi-camera capture, you need to call after calling this method and set enabled to . If you are using the local video mixing function, calling this method can cause the local video mixing to be interrupted.
    @@ -39,16 +39,16 @@ sourceType - The type of the video source. See . + The type of the video source. See .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita index d2d5dd51a43..dda92499578 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita @@ -20,18 +20,18 @@ public abstract int StopChannelMediaRelay(); abstract stopChannelMediaRelay(): number; Future<void> stopChannelMediaRelay(); -

    +

    Details

    After a successful method call, the SDK triggers the callback. If the callback reports (0) and (0), the host successfully stops the relay.

    If the method call fails, the SDK triggers the callback with the (2) or (8) status code. You can call the method to leave the channel, and the media stream relay automatically stops.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita index fe5a406f207..d305ea3eac5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita @@ -20,11 +20,11 @@ abstract stopDirectCdnStreaming(): number; Future<void> stopDirectCdnStreaming();
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita index 93c336e3747..b54f51cb3fd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita @@ -20,11 +20,11 @@ public abstract int StopEchoTest(); abstract stopEchoTest(): number; Future<void> stopEchoTest(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita index 8d98d895bba..970bf56d8fc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita @@ -22,7 +22,7 @@ public abstract int StopEffect(int soundId); abstract stopEffect(soundId: number): number; Future<void> stopEffect(int soundId); -

      +

    Parameters @@ -33,11 +33,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita index ada431cbbcc..c5be5566eb5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita @@ -20,14 +20,14 @@ public abstract int StopLastmileProbeTest(); abstract stopLastmileProbeTest(): number; Future<void> stopLastmileProbeTest(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita index e74c4b3c62c..d56994701f4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita @@ -21,20 +21,20 @@ public abstract int StopLocalVideoTranscoder(); abstract stopLocalVideoTranscoder(): number; Future<void> stopLocalVideoTranscoder(); -

    +

    Details

    After calling , call this method if you want to stop the local video mixing.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview.dita index aa7a0b41115..c6c9e04f484 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview.dita @@ -30,7 +30,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita index 9cbd9a90019..f524356482f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita @@ -22,7 +22,7 @@ abstract stopPreview(sourceType?: VideoSourceType): number; Future<void> stopPreview( {VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary}); -

    +

    Details @@ -44,12 +44,12 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita index 343521bef2c..0dcd5b374c5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita @@ -20,18 +20,18 @@ public abstract int StopRhythmPlayer(); abstract stopRhythmPlayer(): number; Future<void> stopRhythmPlayer(); -

    +

    Details

    After calling , you can call this method to disable the virtual metronome.

    This method is for Android and iOS only.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita index e50375b9f72..811409a3583 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita @@ -1,12 +1,12 @@ - <ph keyref="stopRtmpStream"/> + <ph keyref="stopRtmpStream" /> Stops pushing media streams to a CDN. - + @@ -20,28 +20,28 @@ public abstract int StopRtmpStream(string url); abstract stopRtmpStream(url: string): number; Future<void> stopRtmpStream(String url); -

    +

    Details

    Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

    You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times.

    -

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    +

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    Parameters - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita index 7a3a64e25ca..a5171174d05 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita @@ -23,14 +23,14 @@ public abstract int StopScreenCapture(); abstract stopScreenCapture(): number; Future<void> stopScreenCapture(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita index 3da20e3e41c..73b01147a7b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita @@ -18,9 +18,9 @@ virtual int stopScreenCapture(VIDEO_SOURCE_TYPE sourceType) = 0; abstract stopScreenCaptureBySourceType(sourceType: VideoSourceType): number; public abstract int StopScreenCapture(VIDEO_SOURCE_TYPE sourceType); - - Future<void> stopScreenCaptureBySourceType(VideoSourceType sourceType); -

    + + Future<void> stopScreenCaptureBySourceType(VideoSourceType sourceType); +

    Details @@ -30,26 +30,26 @@
    v4.2.0
    -

    After calling to start capturing video from one or more screens, you can call this method and set the sourceType parameter to stop capturing from the specified screens.

    +

    After calling to start capturing video from one or more screens, you can call this method and set the sourceType parameter to stop capturing from the specified screens.

    • This method applies to the macOS and Windows only.
      • -
    • If you call , , or to start screen capure, Agora recommends that you call instead to stop the capture.
      • -
    • If you call or to start screen capture, Agora recommends that you call to stop the capture and do not use this one.
     +
  • If you call , , or to start screen capure, Agora recommends that you call instead to stop the capture.
    • +
  • If you call or to start screen capture, Agora recommends that you call to stop the capture and do not use this one.
    • Parameters sourceType - The type of the video source. See . + The type of the video source. See .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita index 78520cfebc4..f39db6c51ba 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita @@ -20,20 +20,20 @@ public abstract int SwitchCamera(); abstract switchCamera(): number; Future<void> switchCamera(); -

    +

    Details
    • This method is for Android and iOS only.
      • -
    • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
     +
  • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
    • - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita index a3477003cf4..9de9b5fcf5f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita @@ -19,8 +19,8 @@ abstract takeSnapshot(uid: number, filePath: string): number; public abstract int TakeSnapshot(uint uid, string filePath); abstract takeSnapshot(uid: number, filePath: string): number; - Future<void> takeSnapshot({required int uid, required String filePath}); -

    + Future<void> takeSnapshot({required int uid, required String filePath}); +

    Details @@ -30,7 +30,7 @@
    • Call this method after joining a channel.
      • -
    • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
      • +
    • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
    • If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
    @@ -44,20 +44,20 @@ filePath

    The local path (including filename extensions) of the snapshot. For example:

      -
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg
      • +
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg
    • iOS: /App Sandbox/Library/Caches/example.jpg
    • macOS: ～/Library/Logs/example.jpg
      • -
    • Android: /storage/emulated/0/Android/data/<package name>/files/example.jpg
      • +
    • Android: /storage/emulated/0/Android/data/<package name>/files/example.jpg
    Ensure that the path you specify exists and is writable.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita index b61c9fbdfac..e30f02969fa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita @@ -21,14 +21,14 @@ public abstract int UnloadAllEffects(); abstract unloadAllEffects(): number; Future<void> unloadAllEffects(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita index 97cfec890fa..d9b32936461 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita @@ -22,7 +22,7 @@ public abstract int UnloadEffect(int soundId); abstract unloadEffect(soundId: number): number; Future<void> unloadEffect(int soundId); -

    +

    Parameters @@ -33,11 +33,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita index 2a657519463..5561b357549 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="unregisterAudioFrameObserver"/> + <ph keyref="unregisterAudioFrameObserver" /> Unregisters an audio frame observer. - + @@ -18,17 +18,17 @@ public abstract int UnRegisterAudioFrameObserver(); - - -

    + + +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita index becf9376921..8b5053bd88c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita @@ -24,7 +24,7 @@ observer: IAudioSpectrumObserver ): number;     void unregisterAudioSpectrumObserver(AudioSpectrumObserver observer); -

    +

    Details @@ -40,11 +40,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita index 1e6c7b502f6..2d69df531b6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita @@ -27,7 +27,7 @@ ): number;     void unregisterMediaMetadataObserver( {required MetadataObserver observer, required MetadataType type}); -

    +

    Parameters @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita index 38448fe15ed..212605e0059 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita @@ -20,7 +20,7 @@ public abstract int UpdateChannelMediaOptions(ChannelMediaOptions options); abstract updateChannelMediaOptions(options: ChannelMediaOptions): number; Future<void> updateChannelMediaOptions(ChannelMediaOptions options); -

    +

    Parameters @@ -32,8 +32,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita index afc3c9300cc..f24f8b6c08f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita @@ -26,7 +26,7 @@ ): number; Future<void> updateChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

        +

    Details @@ -50,11 +50,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita index fe6eb011ae3..1dac2c666a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita @@ -26,12 +26,12 @@ ): number;     Future<void> updateLocalTranscoderConfiguration( LocalTranscoderConfiguration config); -

    +

    Details

    After calling , call this method if you want to update the local video mixing configuration.

    - If you want to update the video source type used for local video mixing, such as adding a second camera or screen to capture video, you need to call this method after or . + If you want to update the video source type used for local video mixing, such as adding a second camera or screen to capture video, you need to call this method after or .
    Parameters @@ -42,11 +42,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita index 949adef08c3..43857e44215 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita @@ -1,12 +1,12 @@ - <ph keyref="updatePreloadChannelToken"/> + <ph keyref="updatePreloadChannelToken" /> Updates the wildcard token for preloading channels. - + @@ -19,7 +19,7 @@ abstract updatePreloadChannelToken(token: string): number; public abstract int UpdatePreloadChannelToken(string token); abstract updatePreloadChannelToken(token: string): number; - Future<void> updatePreloadChannelToken(String token);

    + Future<void> updatePreloadChannelToken(String token);

    Details @@ -44,13 +44,13 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    • -2: The parameter is invalid. For example, the token is invalid. You need to pass in a valid parameter and join the channel again.
    • -7: The object has not been initialized. You need to initialize the object before calling this method.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita index 5877062bf98..726d4b20e64 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita @@ -1,12 +1,12 @@ - <ph keyref="updateRtmpTranscoding"/> + <ph keyref="updateRtmpTranscoding" /> Updates the transcoding configuration. - + @@ -20,27 +20,27 @@ public abstract int UpdateRtmpTranscoding(LiveTranscoding transcoding); abstract updateRtmpTranscoding(transcoding: LiveTranscoding): number; Future<void> updateRtmpTranscoding(LiveTranscoding transcoding); -

    +

    Details

    Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

    -

    After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the callback after the transcoding configuration is updated.

    +

    After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the callback after the transcoding configuration is updated.

    Parameters - - + +
    -
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    +
    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita index 08891bd4a70..20ea54abfdf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita @@ -20,7 +20,7 @@ public abstract string UploadLogFile(); Future<void> uploadLogFile(String requestId); -

    +

    Details @@ -42,8 +42,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita index 68bcc6826f9..5f2f81573cf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita @@ -30,7 +30,7 @@ {required String url, required bool transcodingEnabled, required RtcConnection connection}); -

        +

    Details @@ -60,11 +60,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        +
      • < 0: Failure. See for details and resolution suggestions.
        • -2: Invalid parameter, usually an empty URL or a string with a length of 0.
        • -7: The engine is not initialized when streaming.
        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita index 0faa8586acb..a68b26a3504 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita @@ -36,7 +36,7 @@ {required String watermarkUrl, required WatermarkOptions options, required RtcConnection connection}); -

        +

    Details @@ -71,11 +71,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita index 95b4df55fa7..bf50f87f885 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita @@ -1,12 +1,12 @@ - <ph keyref="adjustUserPlaybackSignalVolumeEx"/> + <ph keyref="adjustUserPlaybackSignalVolumeEx" /> Adjusts the playback signal volume of a specified remote user. - + @@ -30,11 +30,11 @@ volume: number, connection: RtcConnection ): number;     - Future<void> adjustUserPlaybackSignalVolumeEx( + Future<void> adjustUserPlaybackSignalVolumeEx( {required int uid, required int volume, required RtcConnection connection}); -

    +

    Details @@ -54,24 +54,24 @@ Parameters - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita index d93dea5a48c..5db52973b7e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita @@ -20,7 +20,7 @@ public abstract int ClearVideoWatermarkEx(RtcConnection connection); abstract clearVideoWatermarkEx(connection: RtcConnection): number; Future<void> clearVideoWatermarkEx(RtcConnection connection); -

    +

    Parameters @@ -31,11 +31,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita index 1b37b8657bf..36496c9a324 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita @@ -1,12 +1,12 @@ - <ph keyref="enableAudioVolumeIndicationEx"/> - + <ph keyref="enableAudioVolumeIndicationEx" /> + - + @@ -33,43 +33,43 @@ reportVad: boolean, connection: RtcConnection ): number;     - Future<void> enableAudioVolumeIndicationEx( + Future<void> enableAudioVolumeIndicationEx( {required int interval, required int smooth, required bool reportVad, required RtcConnection connection}); -

    +

    Details -

    This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Once you call this method and users send streams in the channel, the SDK triggers the callback at the time interval set in this method.

    +

    This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Once you call this method and users send streams in the channel, the SDK triggers the callback at the time interval set in this method.

    Parameters - - + + - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita index 08580d38704..dc327aee1ea 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita @@ -1,12 +1,12 @@ - <ph keyref="enableContentInspectEx"/> + <ph keyref="enableContentInspectEx" /> Enables or disables video screenshot and upload. - + @@ -36,31 +36,31 @@
    v4.2.3
    -

    This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

    - Before calling this method, ensure that you have contacted to activate the video screenshot upload service. +

    This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

    + Before calling this method, ensure that you have contacted to activate the video screenshot upload service.
    Parameters - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita index 11facbb391e..3fedd0a8196 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita @@ -1,12 +1,12 @@ - <ph keyref="enableDualStreamModeEx"/> + <ph keyref="enableDualStreamModeEx" /> Enables or disables dual-stream mode on the sender side. - + @@ -31,11 +31,11 @@ streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number;     - Future<void> enableDualStreamModeEx( + Future<void> enableDualStreamModeEx( {required bool enabled, required SimulcastStreamConfig streamConfig, required RtcConnection connection}); -

    +

    Details @@ -45,31 +45,31 @@
    v4.0.1
    -

    -

    +

    +

    This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.

    Parameters - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita index 9a3e683a788..d4db745fe68 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita @@ -1,19 +1,19 @@ - <ph keyref="enableLoopbackRecordingEx"/> + <ph keyref="enableLoopbackRecordingEx" /> Enables loopback audio capturing. - +

    - + - (int)enableLoopbackRecordingEx:(BOOL)enabled deviceName:(NSString* _Nullable)deviceName connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(enableLoopbackRecordingEx(_:deviceName:connection:)); @@ -33,7 +33,7 @@ {required RtcConnection connection, required bool enabled, String? deviceName}); -

    +

    Details @@ -48,27 +48,27 @@ Parameters - - + + enabled Sets whether to enable loopback audio capture:
      -
    • : Enable loopback audio capturing.
      • -
    • : (Default) Disable loopback audio capturing.
      • +
    • : Enable loopback audio capturing.
      • +
    • : (Default) Disable loopback audio capturing.
         - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita index e5b8860e02b..41b02807abd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita @@ -1,12 +1,12 @@ - <ph keyref="leaveChannelEx"/> + <ph keyref="leaveChannelEx" /> Leaves a channel. - + @@ -22,40 +22,40 @@ options?: LeaveChannelOptions ): number;     public abstract int LeaveChannelEx(RtcConnection connection); - - -

    + + +

    Details

    This method lets the user leave the channel, for example, by hanging up or exiting the call.

    -

    After calling to join the channel, this method must be called to end the call before starting the next call.

    +

    After calling to join the channel, this method must be called to end the call before starting the next call.

    This method can be called whether or not a call is currently in progress. This method releases all resources related to the session.

    -

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    +

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    +

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    +

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

      -
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • -
    • If you want to leave the channels that you joined by calling and , call the method.
      • +
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • +
    • If you want to leave the channels that you joined by calling and , call the method.
    Parameters - - + + - - + +
    Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita index 118d138d1fb..ffad185e740 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita @@ -1,12 +1,12 @@ - <ph keyref="leaveChannelEx2"/> + <ph keyref="leaveChannelEx2" /> Sets channel options and leaves the channel. - + @@ -27,29 +27,29 @@ connection: RtcConnection, options?: LeaveChannelOptions ): number;     - Future<void> leaveChannelEx( + Future<void> leaveChannelEx( {required RtcConnection connection, LeaveChannelOptions? options}); -

    +

    Details

    This method lets the user leave the channel, for example, by hanging up or exiting the call.

    -

    After calling to join the channel, this method must be called to end the call before starting the next call.

    +

    After calling to join the channel, this method must be called to end the call before starting the next call.

    This method can be called whether or not a call is currently in progress. This method releases all resources related to the session.

    -

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    +

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    +

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    +

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

      -
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • -
    • If you want to leave the channels that you joined by calling and , call the method.
      • +
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • +
    • If you want to leave the channels that you joined by calling and , call the method.
    Parameters - - + + options @@ -60,20 +60,20 @@
    v4.1.0
    -

    The options for leaving the channel. See .

    - This parameter only supports the stopMicrophoneRecording member in the settings; setting other members does not take effect. +

    The options for leaving the channel. See .

    + This parameter only supports the stopMicrophoneRecording member in the settings; setting other members does not take effect.     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita index 3d53a8f7731..ae3e499e122 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteAllRemoteAudioStreamsEx"/> + <ph keyref="muteAllRemoteAudioStreamsEx" /> Stops or resumes subscribing to the audio streams of all remote users. - + @@ -26,9 +26,9 @@ mute: boolean, connection: RtcConnection ): number;     - Future<void> muteAllRemoteAudioStreamsEx( + Future<void> muteAllRemoteAudioStreamsEx( {required bool mute, required RtcConnection connection}); -

    +

    Details @@ -36,7 +36,7 @@
    • Call this method after joining a channel.
      • -
    • If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
      • +
    • If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
    • See recommended settings in Set the Subscribing State.
    @@ -47,22 +47,22 @@ mute

    Whether to stop subscribing to the audio streams of all remote users:

      -
    • : Stops subscribing to the audio streams of all remote users.
      • -
    • : (Default) Subscribes to the audio streams of all remote users by default.
      • +
    • : Stops subscribing to the audio streams of all remote users.
      • +
    • : (Default) Subscribes to the audio streams of all remote users by default.

     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita index 098e3cc1eec..c898af46183 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteAllRemoteVideoStreamsEx"/> + <ph keyref="muteAllRemoteVideoStreamsEx" /> Stops or resumes subscribing to the video streams of all remote users. - + @@ -26,7 +26,7 @@ mute: boolean, connection: RtcConnection ): number;     - Future<void> muteAllRemoteVideoStreamsEx( + Future<void> muteAllRemoteVideoStreamsEx( {required bool mute, required RtcConnection connection});

    @@ -37,27 +37,27 @@
    v4.1.0
    -

    +

    Parameters - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita index 47d306ccea9..619c5a34efa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteLocalAudioStreamEx"/> + <ph keyref="muteLocalAudioStreamEx" /> Stops or resumes publishing the local audio stream. - + @@ -25,14 +25,14 @@ mute: boolean, connection: RtcConnection ): number;     - Future<void> muteLocalAudioStreamEx( + Future<void> muteLocalAudioStreamEx( {required bool mute, required RtcConnection connection}); -

    +

    Details This method does not affect any ongoing audio recording, because it does not disable the audio capture device. -

    A successful call of this method triggers the and callbacks on the remote client.

    +

    A successful call of this method triggers the and callbacks on the remote client.

    Parameters @@ -41,22 +41,22 @@ mute

    Whether to stop publishing the local audio stream:

      -
    • : Stops publishing the local audio stream.
      • -
    • : (Default) Resumes publishing the local audio stream.
      • +
    • : Stops publishing the local audio stream.
      • +
    • : (Default) Resumes publishing the local audio stream.

     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita index 623b9b66e20..bcfd70f7ba7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteLocalVideoStreamEx"/> + <ph keyref="muteLocalVideoStreamEx" /> Stops or resumes publishing the local video stream. - + @@ -25,7 +25,7 @@ mute: boolean, connection: RtcConnection ): number;     - Future<void> muteLocalVideoStreamEx( + Future<void> muteLocalVideoStreamEx( {required bool mute, required RtcConnection connection});

    @@ -46,21 +46,21 @@ Parameters - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita index b864b145e41..9c9debbbee8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita @@ -33,7 +33,7 @@ {required int uid, required bool mute, required RtcConnection connection});     -

    +

    DetailsThis method is used to stops or resumes receiving the audio stream of a specified user. You can call this method before or after joining a channel. If a user leaves a channel, the settings in this method become invalid.
    @@ -60,11 +60,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita index 21bebda58c4..d26cc0a5262 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita @@ -33,7 +33,7 @@ {required int uid, required bool mute, required RtcConnection connection});     -

    +

    Details @@ -64,11 +64,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita index 76a657b6210..2a11980aaf9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="pauseAllChannelMediaRelayEx"/> + <ph keyref="pauseAllChannelMediaRelayEx" /> Pauses the media stream relay to all target channels. - + @@ -19,27 +19,27 @@ abstract pauseAllChannelMediaRelayEx(connection: RtcConnection): number; public abstract int PauseAllChannelMediaRelayEx(RtcConnection connection); abstract pauseAllChannelMediaRelayEx(connection: RtcConnection): number; - Future<void> pauseAllChannelMediaRelayEx(RtcConnection connection); -

    + Future<void> pauseAllChannelMediaRelayEx(RtcConnection connection); +

    Details -

    After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call .

    - Call this method after .
    +

    After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call .

    + Call this method after .
    Parameters - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita index 260533168c2..ba0b2bdbba2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="resumeAllChannelMediaRelayEx"/> + <ph keyref="resumeAllChannelMediaRelayEx" /> Resumes the media stream relay to all target channels. - + @@ -19,13 +19,13 @@ abstract resumeAllChannelMediaRelayEx(connection: RtcConnection): number; public abstract int ResumeAllChannelMediaRelayEx(RtcConnection connection); abstract resumeAllChannelMediaRelayEx(connection: RtcConnection): number; - Future<void> resumeAllChannelMediaRelayEx(RtcConnection connection); -

    + Future<void> resumeAllChannelMediaRelayEx(RtcConnection connection); +

    Details -

    After calling the method, you can call this method to resume relaying media streams to all destination channels.

    - Call this method after . +

    After calling the method, you can call this method to resume relaying media streams to all destination channels.

    + Call this method after .
    Parameters @@ -36,11 +36,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita index b584e4bd970..95f3cfb09e0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita @@ -29,7 +29,7 @@ required Uint8List data, required int length, required RtcConnection connection});     -

    +

    Details @@ -68,11 +68,11 @@ A failed method call triggers the callbac
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita index cb89e26378a..273b7d82060 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita @@ -34,7 +34,7 @@ mirrorMode: VideoMirrorModeType, connection: RtcConnection ): number;     - Future<void> setRemoteRenderModeEx( + Future<void> setRemoteRenderModeEx( {required int uid, required RenderModeType renderMode, required VideoMirrorModeType mirrorMode, @@ -45,7 +45,7 @@

    After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees.

    • Call this method after initializing the remote view by calling the method.
      • -
    • Call this method after rendering the or component corresponding to the remote user ID.
      • +
    • Call this method after rendering the or component corresponding to the remote user ID.
    • During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user.

    @@ -80,11 +80,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita index 34e47132702..05c37ea39de 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteVideoStreamTypeEx"/> + <ph keyref="setRemoteVideoStreamTypeEx" /> Sets the stream type of the remote video. - + @@ -29,15 +29,15 @@ streamType: VideoStreamType, connection: RtcConnection ): number;     - Future<void> setRemoteVideoStreamTypeEx( + Future<void> setRemoteVideoStreamTypeEx( {required int uid, required VideoStreamType streamType, required RtcConnection connection}); -

    +

    Details -

    Under limited network conditions, if the publisher has not disabled the dual-stream mode using (), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

    +

    Under limited network conditions, if the publisher has not disabled the dual-stream mode using (), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

    By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.

    The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.

    @@ -51,7 +51,7 @@ streamType -

    The video stream type: .

    +

    The video stream type: .

    The video stream type:

    • 0: High-quality video stream.
    • 1: Low-quality video stream.
      • @@ -59,16 +59,16 @@ - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita index de12657f295..78ecf4b9852 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita @@ -38,7 +38,7 @@ required double pan, required double gain, required RtcConnection connection}); -

      +

      Details @@ -74,11 +74,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita index a3aaa878266..618287136b8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeAudioAllowlistEx"/> - + <ph keyref="setSubscribeAudioAllowlistEx" /> + - + @@ -27,36 +27,36 @@ uidNumber: number, connection: RtcConnection ): number;       - Future<void> setSubscribeAudioAllowlistEx( - {required List<int> uidList, + Future<void> setSubscribeAudioAllowlistEx( + {required List<int> uidList, required int uidNumber, required RtcConnection connection}); -

      +

      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita index 94d8639762c..286b63e7fc1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeAudioBlocklistEx"/> - + <ph keyref="setSubscribeAudioBlocklistEx" /> + - + @@ -27,38 +27,38 @@ uidNumber: number, connection: RtcConnection ): number;       - Future<void> setSubscribeAudioBlocklistEx( - {required List<int> uidList, + Future<void> setSubscribeAudioBlocklistEx( + {required List<int> uidList, required int uidNumber, required RtcConnection connection}); -

      +

      -

      +

      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita index 91bedf9f5ff..e58002b6ed5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeVideoAllowlistEx"/> - + <ph keyref="setSubscribeVideoAllowlistEx" /> + - + @@ -27,36 +27,36 @@ uidNumber: number, connection: RtcConnection ): number;       - Future<void> setSubscribeVideoAllowlistEx( - {required List<int> uidList, + Future<void> setSubscribeVideoAllowlistEx( + {required List<int> uidList, required int uidNumber, required RtcConnection connection}); -

      +

      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita index 3ab433c8d92..867f9a62c78 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeVideoBlocklistEx"/> - + <ph keyref="setSubscribeVideoBlocklistEx" /> + - + @@ -27,36 +27,36 @@ uidNumber: number, connection: RtcConnection ): number;       - Future<void> setSubscribeVideoBlocklistEx( - {required List<int> uidList, + Future<void> setSubscribeVideoBlocklistEx( + {required List<int> uidList, required int uidNumber, required RtcConnection connection}); -

      +

      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita index 272e710a56f..5eb6e71b3d7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita @@ -1,12 +1,12 @@ - <ph keyref="startMediaRenderingTracingEx"/> + <ph keyref="startMediaRenderingTracingEx" /> Enables tracing the video frame rendering process. - + @@ -19,7 +19,7 @@ abstract startMediaRenderingTracingEx(connection: RtcConnection): number; public abstract int StartMediaRenderingTracingEx(RtcConnection connection); abstract startMediaRenderingTracingEx(connection: RtcConnection): number; - Future<void> startMediaRenderingTracingEx(RtcConnection connection);

      + Future<void> startMediaRenderingTracingEx(RtcConnection connection);

      Details @@ -29,8 +29,8 @@
      v4.1.1
      -

      - +

      +

      @@ -39,17 +39,17 @@ Parameters - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita index a74eb018f7a..e11a7b5f55b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita @@ -1,12 +1,12 @@ - <ph keyref="startRtmpStreamWithTranscodingEx"/> + <ph keyref="startRtmpStreamWithTranscodingEx" /> Starts Media Push and sets the transcoding configuration. - + @@ -30,7 +30,7 @@ transcoding: LiveTranscoding, connection: RtcConnection ): number;       - Future<void> startRtmpStreamWithTranscodingEx( + Future<void> startRtmpStreamWithTranscodingEx( {required String url, required LiveTranscoding transcoding, required RtcConnection connection});

      @@ -45,33 +45,33 @@

      Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

      You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.

      -

      After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

      +

      After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

      • Ensure that you enable the Media Push service before using this function. For details, see the prerequisites in Media Push.
      • Call this method after joining a channel.
      • Only hosts in the LIVE_BROADCASTING profile can call this method.
        • -
      • If you want to retry pushing streams after a failed push, make sure to call first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
        • +
      • If you want to retry pushing streams after a failed push, make sure to call first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
      • < 0: Failure.
          @@ -81,4 +81,4 @@
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita index 827d30e7206..891476111d1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="stopChannelMediaRelayEx"/> + <ph keyref="stopChannelMediaRelayEx" /> Stops the media stream relay. Once the relay stops, the host quits all the target channels. - + @@ -19,7 +19,7 @@ abstract stopChannelMediaRelayEx(connection: RtcConnection): number; public abstract int StopChannelMediaRelayEx(RtcConnection connection); abstract stopChannelMediaRelayEx(connection: RtcConnection): number; - Future<void> stopChannelMediaRelayEx(RtcConnection connection);

      + Future<void> stopChannelMediaRelayEx(RtcConnection connection);

      @@ -28,23 +28,23 @@
      v4.1.0
      -

      +

      Parameters - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita index 273acd04a31..8f20cc78fe0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita @@ -1,12 +1,12 @@ - <ph keyref="stopRtmpStreamEx"/> + <ph keyref="stopRtmpStreamEx" /> Stops pushing media streams to a CDN. - + @@ -20,30 +20,30 @@ abstract stopRtmpStreamEx(url: string, connection: RtcConnection): number; public abstract int StopRtmpStreamEx(string url, RtcConnection connection); abstract stopRtmpStreamEx(url: string, connection: RtcConnection): number; - Future<void> stopRtmpStreamEx( + Future<void> stopRtmpStreamEx( {required String url, required RtcConnection connection}); -

      +

      Details

      Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

      You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times.

      -

      After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

      +

      After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

      Parameters - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita index d1e09f82614..73747826557 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita @@ -1,12 +1,12 @@ - <ph keyref="takeSnapshotEx"/> + <ph keyref="takeSnapshotEx" /> Takes a snapshot of a video stream. - + @@ -27,45 +27,45 @@ uid: number, filePath: string ): number;       - Future<void> takeSnapshotEx( + Future<void> takeSnapshotEx( {required RtcConnection connection, required int uid, required String filePath}); -

      +

      Details -

      -

      +

      +

      The SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.

        -
      • Call this method after the method.
        • -
      • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
        • +
      • Call this method after the method.
        • +
      • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
      • If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita index 8572bfbad4a..780b8ef5b7d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="updateChannelMediaRelayEx"/> + <ph keyref="updateChannelMediaRelayEx" /> Updates the channels for media stream relay. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;       - Future<void> updateChannelMediaRelayEx( + Future<void> updateChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

      +

      Details @@ -40,8 +40,8 @@

      After the media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method.

      -

      After a successful method call, the SDK triggers the callback with the (7) state code.

      - Call the method after successfully calling the method and receiving (, ); otherwise, the method call fails.
      +

      After a successful method call, the SDK triggers the callback with the (7) state code.

      + Call the method after successfully calling the method and receiving (, ); otherwise, the method call fails.
      Parameters @@ -49,19 +49,19 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. See . - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita index f3a255941da..0ae6412c922 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita @@ -1,12 +1,12 @@ - <ph keyref="updateRtmpTranscodingEx"/> + <ph keyref="updateRtmpTranscodingEx" /> Updates the transcoding configuration. - + @@ -27,34 +27,34 @@ transcoding: LiveTranscoding, connection: RtcConnection ): number;       - Future<void> updateRtmpTranscodingEx( + Future<void> updateRtmpTranscodingEx( {required LiveTranscoding transcoding, required RtcConnection connection}); -

      +

      Details

      Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

      -

      After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the callback after the transcoding configuration is updated.

      +

      After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the callback after the transcoding configuration is updated.

      Parameters - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_getdevice.dita b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_getdevice.dita index a41a733f368..e99d384d1bf 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_getdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_getdevice.dita @@ -22,7 +22,7 @@ public abstract string GetDevice(); Future<String> getDevice(); -

      +

      Parameters @@ -44,7 +44,7 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      The information of the video capturing device.

      diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita index b7dad69719a..ea24e9ea42a 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita @@ -20,7 +20,7 @@ public abstract int SetDevice(string deviceIdUTF8); Future<void> setDevice(String deviceIdUTF8); -

      +

      Parameters @@ -37,11 +37,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getdevice.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getdevice.dita index 62334966ea1..938d15fc75c 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getdevice.dita @@ -20,7 +20,7 @@ public abstract int GetDevice(ref string deviceIdUTF8); abstract getDevice(): string; Future<String> getDevice(); -

      +

      Details @@ -38,9 +38,9 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      The video capture device.

      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita index 47324e5094b..97f5ec15fb6 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita @@ -21,7 +21,7 @@ public abstract int NumberOfCapabilities(string deviceIdUTF8); abstract numberOfCapabilities(deviceIdUTF8: string): number; Future<void> numberOfCapabilities(String deviceIdUTF8); -

      +

      Details @@ -38,11 +38,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

        -
      • > 0: Success. Returns the number of video formats supported by this device. For example: If the specified camera supports 10 different video formats, the return value is 10.
        • -
      • ≤ 0: Failure. See for details and resolution suggestions.
        • +
      • > 0: Success. Returns the number of video formats supported by this device. For example: If the specified camera supports 10 different video formats, the return value is 10.
        • +
      • ≤ 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita index cffc12389b5..3999b1526fb 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita @@ -1,12 +1,12 @@ - <ph keyref="setDevice_IVideoDeviceManager"/> + <ph keyref="setDevice_IVideoDeviceManager" /> Specifies the video capture device with the device ID. - + @@ -20,7 +20,7 @@ public abstract int SetDevice(string deviceIdUTF8); abstract setDevice(deviceIdUTF8: string): number; Future<void> setDevice(String deviceIdUTF8); -

      +

      Details @@ -33,17 +33,17 @@ deviceId deviceIdUTF8 -

      The device ID. You can get the device ID by calling .

      -

      The maximum length is .

      +

      The device ID. You can get the device ID by calling .

      +

      The maximum length is .
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita index 84102533e12..1bcb80c99a8 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita @@ -20,7 +20,7 @@ public abstract int StartDeviceTest(view_t hwnd); abstract startDeviceTest(hwnd: any): number; Future<void> startDeviceTest(int hwnd); -

      +

      Details @@ -35,11 +35,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita index 295cae2b8b3..c8a55893080 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita @@ -20,14 +20,14 @@ public abstract int StopDeviceTest(); abstract stopDeviceTest(): number; Future<void> stopDeviceTest(); -

      +

      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita index dd5dd1d85b1..35ceab71c3d 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita @@ -71,10 +71,10 @@ Types of functional module. See .

      Types of functional modules:

        -
      • (0): (Default) This module has no actual function. Do not set to this value.
        • -
      • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
        • -
      • (2): Video screenshot and upload via Agora self-developed extension. SDK takes screenshots of the video stream in the channel and uploads them.
        • -
      • (3): Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them.
        • +
      • (0): (Default) This module has no actual function. Do not set to this value.
        • +
      • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
        • +
      • (2): Video screenshot and upload via Agora self-developed extension. SDK takes screenshots of the video stream in the channel and uploads them.
        • +
      • (3): Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them.