From d936e0c5d94c0b96ab5cced36ccaabb9080c13f5 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 26 Sep 2023 14:31:16 +0800 Subject: [PATCH 1/6] New translations --- .../api_iaudiodevicecollection_setdevice.dita | 2 +- ...icemanager_followsystemloopbackdevice.dita | 6 +-- ...icemanager_followsystemplaybackdevice.dita | 2 +- ...cemanager_followsystemrecordingdevice.dita | 2 +- ...iaudiodevicemanager_setloopbackdevice.dita | 6 +-- ...iaudiodevicemanager_setplaybackdevice.dita | 2 +- ...iodevicemanager_setplaybackdevicemute.dita | 2 +- ...devicemanager_setplaybackdevicevolume.dita | 2 +- ...audiodevicemanager_setrecordingdevice.dita | 2 +- ...odevicemanager_setrecordingdevicemute.dita | 2 +- ...evicemanager_setrecordingdevicevolume.dita | 6 +-- ...emanager_startaudiodeviceloopbacktest.dita | 2 +- ...devicemanager_startplaybackdevicetest.dita | 2 +- ...evicemanager_startrecordingdevicetest.dita | 2 +- ...cemanager_stopaudiodeviceloopbacktest.dita | 2 +- ...odevicemanager_stopplaybackdevicetest.dita | 2 +- ...devicemanager_stoprecordingdevicetest.dita | 2 +- ...audioengine_muteallremoteaudiostreams.dita | 2 +- ...atialaudioengine_mutelocalaudiostream.dita | 2 +- ...tialaudioengine_muteremoteaudiostream.dita | 2 +- ...espatialaudioengine_setaudiorecvrange.dita | 2 +- ...asespatialaudioengine_setdistanceunit.dita | 2 +- ...atialaudioengine_setmaxaudiorecvcount.dita | 2 +- ...atialaudioengine_setplayerattenuation.dita | 2 +- .../api_ibasespatialaudioengine_setzones.dita | 4 +- ...laudioengine_updateplayerpositioninfo.dita | 14 +++---- ...spatialaudioengine_updateselfposition.dita | 2 +- ...atialaudioengine_clearremotepositions.dita | 2 +- ...i_ilocalspatialaudioengine_initialize.dita | 28 ++++++------- ...atialaudioengine_removeremoteposition.dita | 2 +- ...audioengine_setremoteaudioattenuation.dita | 2 +- ...atialaudioengine_updateremoteposition.dita | 12 +++--- ..._imediaengine_destroycustomaudiotrack.dita | 2 +- .../API/api_imediaengine_pullaudioframe.dita | 2 +- .../API/api_imediaengine_pushaudioframe0.dita | 10 ++--- ...pi_imediaengine_pushencodedvideoimage.dita | 24 +++++------ .../API/api_imediaengine_pushvideoframe.dita | 24 +++++------ ...ediaengine_registeraudioframeobserver.dita | 34 ++++++++-------- ...ine_registervideoencodedframeobserver.dita | 38 +++++++++--------- ...ediaengine_registervideoframeobserver.dita | 34 ++++++++-------- ...api_imediaengine_setexternalaudiosink.dita | 2 +- ..._imediaengine_setexternalaudiosource2.dita | 2 +- ...i_imediaengine_setexternalvideosource.dita | 2 +- ...iaengine_unregisteraudioframeobserver.dita | 8 ++-- ...e_unregistervideoencodedframeobserver.dita | 8 ++-- ...iaengine_unregistervideoframeobserver.dita | 8 ++-- .../api_imediaplayer_adjustplayoutvolume.dita | 2 +- ...mediaplayer_adjustpublishsignalvolume.dita | 2 +- ...imediaplayer_enableautoswitchagoracdn.dita | 2 +- .../RTC-NG/API/api_imediaplayer_mute.dita | 2 +- .../RTC-NG/API/api_imediaplayer_open.dita | 2 +- .../api_imediaplayer_openwithagoracdnsrc.dita | 2 +- .../api_imediaplayer_openwithmediasource.dita | 2 +- .../RTC-NG/API/api_imediaplayer_pause.dita | 2 +- .../RTC-NG/API/api_imediaplayer_play.dita | 2 +- .../api_imediaplayer_playpreloadedsrc.dita | 2 +- .../API/api_imediaplayer_preloadsrc.dita | 2 +- ...diaplayer_registeraudioframeobserver2.dita | 2 +- ...iaplayer_registerplayersourceobserver.dita | 2 +- ...ediaplayer_registervideoframeobserver.dita | 22 +++++----- ...pi_imediaplayer_renewagoracdnsrctoken.dita | 2 +- .../RTC-NG/API/api_imediaplayer_resume.dita | 2 +- .../RTC-NG/API/api_imediaplayer_seek.dita | 2 +- .../api_imediaplayer_selectaudiotrack.dita | 2 +- ...api_imediaplayer_setaudiodualmonomode.dita | 2 +- .../API/api_imediaplayer_setaudiopitch.dita | 2 +- .../API/api_imediaplayer_setloopcount.dita | 2 +- .../api_imediaplayer_setplaybackspeed.dita | 2 +- .../API/api_imediaplayer_setplayeroption.dita | 2 +- .../API/api_imediaplayer_setrendermode.dita | 8 ++-- ...pi_imediaplayer_setspatialaudioparams.dita | 8 ++-- .../RTC-NG/API/api_imediaplayer_setview.dita | 2 +- .../RTC-NG/API/api_imediaplayer_stop.dita | 2 +- ...mediaplayer_switchagoracdnlinebyindex.dita | 2 +- .../api_imediaplayer_switchagoracdnsrc.dita | 2 +- .../API/api_imediaplayer_switchsrc.dita | 2 +- .../API/api_imediaplayer_unloadsrc.dita | 2 +- ...iaplayer_unregisteraudioframeobserver.dita | 2 +- ...player_unregisterplayersourceobserver.dita | 2 +- ...iaplayer_unregistervideoframeobserver.dita | 6 +-- ...diaplayercachemanager_removeallcaches.dita | 2 +- ...ediarecorder_setmediarecorderobserver.dita | 4 +- .../api_imediarecorder_startrecording.dita | 28 ++++++------- .../API/api_imediarecorder_stoprecording.dita | 2 +- .../RTC-NG/API/api_irtcengine_addhandler.dita | 6 +-- .../api_irtcengine_addinjectstreamurl.dita | 2 +- .../api_irtcengine_addpublishstreamurl.dita | 2 +- .../API/api_irtcengine_addvideowatermark.dita | 2 +- .../api_irtcengine_addvideowatermark2.dita | 2 +- ...engine_adjustaudiomixingplayoutvolume.dita | 2 +- ...engine_adjustaudiomixingpublishvolume.dita | 2 +- ...pi_irtcengine_adjustaudiomixingvolume.dita | 2 +- ...engine_adjustcustomaudioplayoutvolume.dita | 2 +- ...engine_adjustcustomaudiopublishvolume.dita | 2 +- ...irtcengine_adjustloopbacksignalvolume.dita | 2 +- ...irtcengine_adjustplaybacksignalvolume.dita | 2 +- ...rtcengine_adjustrecordingsignalvolume.dita | 2 +- ...engine_adjustuserplaybacksignalvolume.dita | 2 +- .../api_irtcengine_clearvideowatermarks.dita | 2 +- .../RTC-NG/API/api_irtcengine_complain.dita | 2 +- .../api_irtcengine_configrhythmplayer.dita | 24 +++++------ ...pi_irtcengine_destroycustomvideotrack.dita | 2 +- .../api_irtcengine_destroymediaplayer.dita | 2 +- .../API/api_irtcengine_disableaudio.dita | 2 +- ...rtcengine_disableaudiospectrummonitor.dita | 2 +- .../API/api_irtcengine_disablevideo.dita | 2 +- .../API/api_irtcengine_enableaudio.dita | 2 +- ...irtcengine_enableaudiospectrummonitor.dita | 2 +- ...rtcengine_enableaudiovolumeindication.dita | 2 +- .../api_irtcengine_enablecontentinspect.dita | 4 +- .../api_irtcengine_enabledualstreammode3.dita | 24 +++++------ ...engine_enableechocancellationexternal.dita | 2 +- .../API/api_irtcengine_enableencryption.dita | 6 +-- .../API/api_irtcengine_enableextension.dita | 2 +- .../api_irtcengine_enablefacedetection.dita | 2 +- ...api_irtcengine_enableinearmonitoring2.dita | 28 ++++++------- ...rtcengine_enableinstantmediarendering.dita | 2 +- .../API/api_irtcengine_enablelocalaudio.dita | 2 +- .../API/api_irtcengine_enablelocalvideo.dita | 2 +- ...pi_irtcengine_enableloopbackrecording.dita | 2 +- .../API/api_irtcengine_enablemulticamera.dita | 40 +++++++++---------- ...rtcengine_enableremotesuperresolution.dita | 2 +- ...cengine_enablesoundpositionindication.dita | 2 +- .../api_irtcengine_enablespatialaudio.dita | 2 +- .../API/api_irtcengine_enablevideo.dita | 2 +- ...api_irtcengine_enablevideoimagesource.dita | 2 +- ...pi_irtcengine_enablevirtualbackground.dita | 36 ++++++++--------- ...tcengine_enablewebsdkinteroperability.dita | 2 +- .../RTC-NG/API/api_irtcengine_initialize.dita | 34 ++++++++-------- ...irtcengine_isfeatureavailableondevice.dita | 12 +++--- .../API/api_irtcengine_joinchannel2.dita | 14 +++---- ...irtcengine_joinchannelwithuseraccount.dita | 2 +- ...tcengine_joinchannelwithuseraccountex.dita | 2 +- .../API/api_irtcengine_leavechannel.dita | 2 +- .../API/api_irtcengine_leavechannel2.dita | 2 +- .../api_irtcengine_loadextensionprovider.dita | 6 +-- ..._irtcengine_muteallremoteaudiostreams.dita | 2 +- ..._irtcengine_muteallremotevideostreams.dita | 2 +- .../api_irtcengine_mutelocalaudiostream.dita | 2 +- .../api_irtcengine_mutelocalvideostream.dita | 2 +- .../api_irtcengine_muterecordingsignal.dita | 2 +- .../api_irtcengine_muteremoteaudiostream.dita | 2 +- .../api_irtcengine_muteremotevideostream.dita | 2 +- ..._irtcengine_pauseallchannelmediarelay.dita | 2 +- .../API/api_irtcengine_pausealleffects.dita | 2 +- .../API/api_irtcengine_pauseaudiomixing.dita | 2 +- .../API/api_irtcengine_pauseeffect.dita | 2 +- .../API/api_irtcengine_playalleffects.dita | 2 +- .../API/api_irtcengine_playeffect3.dita | 2 +- .../API/api_irtcengine_preloadchannel.dita | 26 ++++++------ .../API/api_irtcengine_preloadchannel2.dita | 2 +- .../API/api_irtcengine_preloadeffect.dita | 2 +- .../api_irtcengine_pushcaptureaudioframe.dita | 2 +- .../api_irtcengine_pushreverseaudioframe.dita | 8 ++-- .../dita/RTC-NG/API/api_irtcengine_rate.dita | 2 +- ...ine_registeraudioencodedframeobserver.dita | 12 +++--- ...cengine_registeraudiospectrumobserver.dita | 12 +++--- .../API/api_irtcengine_registerextension.dita | 6 +-- ...i_irtcengine_registerlocaluseraccount.dita | 2 +- ...cengine_registermediametadataobserver.dita | 10 ++--- .../API/api_irtcengine_removehandler.dita | 8 ++-- .../api_irtcengine_removeinjectstreamurl.dita | 2 +- ...api_irtcengine_removepublishstreamurl.dita | 2 +- .../RTC-NG/API/api_irtcengine_renewtoken.dita | 2 +- ...irtcengine_resumeallchannelmediarelay.dita | 2 +- .../API/api_irtcengine_resumealleffects.dita | 2 +- .../API/api_irtcengine_resumeaudiomixing.dita | 2 +- .../API/api_irtcengine_resumeeffect.dita | 2 +- .../API/api_irtcengine_selectaudiotrack.dita | 2 +- .../API/api_irtcengine_sendmetadata.dita | 14 +++---- .../API/api_irtcengine_sendstreammessage.dita | 2 +- ...pi_irtcengine_setadvancedaudiooptions.dita | 10 ++--- .../API/api_irtcengine_setainsmode.dita | 2 +- ...i_irtcengine_setaudioeffectparameters.dita | 2 +- .../api_irtcengine_setaudioeffectpreset.dita | 2 +- ...irtcengine_setaudiomixingdualmonomode.dita | 10 ++--- .../api_irtcengine_setaudiomixingpitch.dita | 2 +- ...api_irtcengine_setaudiomixingposition.dita | 2 +- .../API/api_irtcengine_setaudioprofile.dita | 2 +- .../API/api_irtcengine_setaudioscenario.dita | 2 +- ...e_setaudiosessionoperationrestriction.dita | 2 +- .../API/api_irtcengine_setavsyncsource.dita | 2 +- ...api_irtcengine_setbeautyeffectoptions.dita | 2 +- ..._setcameraautoexposurefacemodeenabled.dita | 2 +- ...ine_setcameraautofocusfacemodeenabled.dita | 2 +- ...engine_setcameracapturerconfiguration.dita | 2 +- ...irtcengine_setcameradeviceorientation.dita | 2 +- ...pi_irtcengine_setcameraexposurefactor.dita | 4 +- ..._irtcengine_setcameraexposureposition.dita | 2 +- ...ngine_setcamerafocuspositioninpreview.dita | 2 +- .../API/api_irtcengine_setcameratorchon.dita | 2 +- .../api_irtcengine_setcamerazoomfactor.dita | 2 +- .../API/api_irtcengine_setchannelprofile.dita | 10 ++--- .../API/api_irtcengine_setclientrole2.dita | 12 +++--- .../API/api_irtcengine_setcloudproxy.dita | 2 +- ...api_irtcengine_setcolorenhanceoptions.dita | 18 ++++----- ...ne_setdefaultaudioroutetospeakerphone.dita | 2 +- ...e_setdefaultmuteallremoteaudiostreams.dita | 2 +- ...e_setdefaultmuteallremotevideostreams.dita | 2 +- ...tdirectcdnstreamingaudioconfiguration.dita | 2 +- ...tdirectcdnstreamingvideoconfiguration.dita | 2 +- .../api_irtcengine_setdualstreammode2.dita | 32 +++++++-------- ..._setearmonitoringaudioframeparameters.dita | 2 +- .../API/api_irtcengine_seteffectposition.dita | 2 +- .../API/api_irtcengine_seteffectsvolume.dita | 2 +- .../api_irtcengine_setenablespeakerphone.dita | 2 +- .../API/api_irtcengine_setencryptionmode.dita | 2 +- .../api_irtcengine_setencryptionsecret.dita | 2 +- .../api_irtcengine_setextensionproperty.dita | 2 +- ...tcengine_setextensionproviderproperty.dita | 2 +- ...i_irtcengine_setheadphoneeqparameters.dita | 2 +- .../api_irtcengine_setheadphoneeqpreset.dita | 16 ++++---- ...i_irtcengine_setinearmonitoringvolume.dita | 2 +- .../api_irtcengine_setlivetranscoding.dita | 8 ++-- .../api_irtcengine_setlocalaccesspoint.dita | 10 ++--- ...cengine_setlocalpublishfallbackoption.dita | 8 ++-- .../api_irtcengine_setlocalrendermode.dita | 8 ++-- .../api_irtcengine_setlocalrendermode2.dita | 10 ++--- ...pi_irtcengine_setlocalvideomirrormode.dita | 8 ++-- ..._irtcengine_setlocalvoiceequalization.dita | 2 +- .../api_irtcengine_setlocalvoiceformant.dita | 2 +- .../api_irtcengine_setlocalvoicepitch.dita | 2 +- .../api_irtcengine_setlocalvoicereverb.dita | 2 +- .../RTC-NG/API/api_irtcengine_setlogfile.dita | 2 +- .../API/api_irtcengine_setlogfilesize.dita | 2 +- .../API/api_irtcengine_setlogfilter.dita | 2 +- .../API/api_irtcengine_setloglevel.dita | 2 +- ..._irtcengine_setlowlightenhanceoptions.dita | 16 ++++---- .../api_irtcengine_setmaxmetadatasize.dita | 2 +- ...tcengine_setmixedaudioframeparameters.dita | 2 +- .../API/api_irtcengine_setparameters.dita | 2 +- ...ybackaudioframebeforemixingparameters.dita | 2 +- ...ngine_setplaybackaudioframeparameters.dita | 2 +- ...gine_setrecordingaudioframeparameters.dita | 2 +- ...ngine_setremotedefaultvideostreamtype.dita | 2 +- .../api_irtcengine_setremoterendermode2.dita | 2 +- ...gine_setremotesubscribefallbackoption.dita | 2 +- ...ngine_setremoteuserspatialaudioparams.dita | 8 ++-- ...i_irtcengine_setremotevideostreamtype.dita | 2 +- ...ine_setremotevideosubscriptionoptions.dita | 2 +- ...api_irtcengine_setremotevoiceposition.dita | 2 +- ...rtcengine_setscreencapturecontenthint.dita | 6 +-- ...i_irtcengine_setscreencapturescenario.dita | 2 +- ...irtcengine_setsubscribeaudioallowlist.dita | 2 +- ...irtcengine_setsubscribeaudioblocklist.dita | 2 +- ...irtcengine_setsubscribevideoallowlist.dita | 2 +- ...irtcengine_setsubscribevideoblocklist.dita | 2 +- .../API/api_irtcengine_setuplocalvideo.dita | 14 +++---- .../API/api_irtcengine_setupremotevideo.dita | 24 +++++------ ...pi_irtcengine_setvideodenoiseroptions.dita | 34 ++++++++-------- ...tcengine_setvideoencoderconfiguration.dita | 24 +++++------ .../API/api_irtcengine_setvideoscenario.dita | 2 +- ...tcengine_setvoicebeautifierparameters.dita | 2 +- ...i_irtcengine_setvoicebeautifierpreset.dita | 2 +- ...i_irtcengine_setvoiceconversionpreset.dita | 2 +- .../API/api_irtcengine_setvolumeofeffect.dita | 2 +- .../API/api_irtcengine_startaudiomixing.dita | 2 +- .../API/api_irtcengine_startaudiomixing2.dita | 2 +- .../api_irtcengine_startaudiorecording3.dita | 8 ++-- .../api_irtcengine_startcameracapture.dita | 24 +++++------ ...api_irtcengine_startchannelmediarelay.dita | 24 +++++------ ...pi_irtcengine_startdirectcdnstreaming.dita | 14 +++---- .../API/api_irtcengine_startechotest2.dita | 2 +- ...api_irtcengine_startlastmileprobetest.dita | 2 +- ..._irtcengine_startlocalvideotranscoder.dita | 2 +- ...irtcengine_startmediarenderingtracing.dita | 2 +- ...engine_startorupdatechannelmediarelay.dita | 24 +++++------ .../API/api_irtcengine_startpreview2.dita | 2 +- .../API/api_irtcengine_startrhythmplayer.dita | 26 ++++++------ ...engine_startrtmpstreamwithtranscoding.dita | 2 +- .../api_irtcengine_startscreencapture.dita | 30 +++++++------- .../api_irtcengine_startscreencapture2.dita | 28 ++++++------- ...cengine_startscreencapturebydisplayid.dita | 6 +-- ...engine_startscreencapturebyscreenrect.dita | 6 +-- ...tcengine_startscreencapturebywindowid.dita | 6 +-- .../API/api_irtcengine_stopalleffects.dita | 2 +- .../API/api_irtcengine_stopaudiomixing.dita | 2 +- .../api_irtcengine_stopaudiorecording.dita | 2 +- .../API/api_irtcengine_stopcameracapture.dita | 2 +- .../api_irtcengine_stopchannelmediarelay.dita | 2 +- ...api_irtcengine_stopdirectcdnstreaming.dita | 2 +- .../API/api_irtcengine_stopechotest.dita | 2 +- .../RTC-NG/API/api_irtcengine_stopeffect.dita | 2 +- .../api_irtcengine_stoplastmileprobetest.dita | 2 +- ...i_irtcengine_stoplocalvideotranscoder.dita | 2 +- .../API/api_irtcengine_stoppreview2.dita | 2 +- .../API/api_irtcengine_stoprhythmplayer.dita | 2 +- .../API/api_irtcengine_stoprtmpstream.dita | 2 +- .../API/api_irtcengine_stopscreencapture.dita | 2 +- .../api_irtcengine_stopscreencapture2.dita | 2 +- .../API/api_irtcengine_switchcamera.dita | 2 +- .../API/api_irtcengine_takesnapshot.dita | 2 +- .../API/api_irtcengine_unloadalleffects.dita | 2 +- .../API/api_irtcengine_unloadeffect.dita | 2 +- ...e_unregisteraudioencodedframeobserver.dita | 20 +++++----- ...tcengine_unregisteraudioframeobserver.dita | 10 ++--- ...ngine_unregisteraudiospectrumobserver.dita | 2 +- ...ngine_unregistermediametadataobserver.dita | 2 +- ..._irtcengine_updatechannelmediaoptions.dita | 2 +- ...pi_irtcengine_updatechannelmediarelay.dita | 2 +- ...ne_updatelocaltranscoderconfiguration.dita | 2 +- ..._irtcengine_updatepreloadchanneltoken.dita | 2 +- .../api_irtcengine_updatertmptranscoding.dita | 2 +- .../api_irtcengine_updatescreencapture.dita | 14 +++---- ...cengine_updatescreencaptureparameters.dita | 6 +-- ..._irtcengine_updatescreencaptureregion.dita | 6 +-- ...irtcengine_updatescreencaptureregion2.dita | 20 +++++----- .../API/api_irtcengine_uploadlogfile.dita | 2 +- ...pi_irtcengineex_addpublishstreamurlex.dita | 2 +- .../api_irtcengineex_addvideowatermarkex.dita | 2 +- ...neex_adjustuserplaybacksignalvolumeex.dita | 2 +- ...pi_irtcengineex_clearvideowatermarkex.dita | 2 +- ...ngineex_enableaudiovolumeindicationex.dita | 2 +- ...i_irtcengineex_enablecontentinspectex.dita | 4 +- ...i_irtcengineex_enabledualstreammodeex.dita | 2 +- ...rtcengineex_enableloopbackrecordingex.dita | 2 +- .../API/api_irtcengineex_leavechannelex2.dita | 2 +- ...cengineex_muteallremoteaudiostreamsex.dita | 2 +- ...cengineex_muteallremotevideostreamsex.dita | 2 +- ...i_irtcengineex_mutelocalaudiostreamex.dita | 2 +- ...i_irtcengineex_mutelocalvideostreamex.dita | 2 +- ..._irtcengineex_muteremoteaudiostreamex.dita | 2 +- ..._irtcengineex_muteremotevideostreamex.dita | 2 +- ...cengineex_pauseallchannelmediarelayex.dita | 2 +- ...engineex_resumeallchannelmediarelayex.dita | 2 +- .../api_irtcengineex_sendstreammessageex.dita | 2 +- .../api_irtcengineex_setdualstreammodeex.dita | 34 ++++++++-------- ...pi_irtcengineex_setremoterendermodeex.dita | 2 +- ...tcengineex_setremotevideostreamtypeex.dita | 2 +- ...irtcengineex_setremotevoicepositionex.dita | 2 +- ...engineex_setsubscribeaudioallowlistex.dita | 2 +- ...engineex_setsubscribeaudioblocklistex.dita | 2 +- ...engineex_setsubscribevideoallowlistex.dita | 2 +- ...engineex_setsubscribevideoblocklistex.dita | 2 +- .../api_irtcengineex_setupremotevideoex.dita | 8 ++-- ...gineex_setvideoencoderconfigurationex.dita | 8 ++-- ...irtcengineex_startchannelmediarelayex.dita | 30 +++++++------- ...engineex_startmediarenderingtracingex.dita | 2 +- ...neex_startorupdatechannelmediarelayex.dita | 28 ++++++------- ...neex_startrtmpstreamwithtranscodingex.dita | 2 +- ..._irtcengineex_stopchannelmediarelayex.dita | 2 +- .../api_irtcengineex_stoprtmpstreamex.dita | 2 +- .../API/api_irtcengineex_takesnapshotex.dita | 2 +- ...rtcengineex_updatechannelmediarelayex.dita | 2 +- ..._irtcengineex_updatertmptranscodingex.dita | 2 +- .../api_ivideodevicecollection_setdevice.dita | 2 +- ...deodevicemanager_numberofcapabilities.dita | 2 +- .../api_ivideodevicemanager_setdevice.dita | 6 +-- ...i_ivideodevicemanager_startdevicetest.dita | 2 +- ...pi_ivideodevicemanager_stopdevicetest.dita | 2 +- ...thandler_onaudiomixingpositionchanged.dita | 2 +- .../API/class_contentinspectmodule.dita | 16 ++++---- en-US/dita/RTC-NG/API/enum_featuretype.dita | 2 +- 353 files changed, 948 insertions(+), 948 deletions(-) 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..771db37a497 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita @@ -36,7 +36,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.

Details -

After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

+

After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

Parameters @@ -58,19 +58,19 @@ frameInfo videoEncodedFrameInfo - Information about externally encoded video frames. See . + Information about externally encoded video frames. 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.

- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index 012364cc717..78a0809cae5 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -25,20 +25,20 @@ frame: ExternalVideoFrame, videoTrackId?: number ): number; - Future<void> pushVideoFrame( + Future<void> pushVideoFrame( {required ExternalVideoFrame frame, int videoTrackId = 0}); -

+

Details
Deprecated:
-
If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
+
If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
-

If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

-

You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

+

If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

+

You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

Applicable scenarios @@ -55,19 +55,19 @@ videoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value 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.
    -
  • : Pushes the external raw video frame to the SDK successfully.
  • -
  • : Fails to push external raw video frame to the SDK.
  • +
  • : Pushes the external raw video frame to the SDK successfully.
  • +
  • : Fails to push external raw video frame to the SDK.
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index f975af88eb9..99b2028c298 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerAudioFrameObserver" /> + <ph keyref="registerAudioFrameObserver"/> Registers an audio frame observer object. - + @@ -20,11 +20,11 @@ public abstract int RegisterAudioFrameObserver(IAudioFrameObserver audioFrameObserver, AUDIO_FRAME_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR); abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number; void registerAudioFrameObserver(AudioFrameObserver observer); -

+

Details -

Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.

+

Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.

Ensure that you call this method before joining a channel.
Parameters @@ -34,35 +34,35 @@ delegate audioFrameObserver -

The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

+

The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

mode - The audio data callback mode. See . + The audio data callback mode. See . position The frame position of the audio observer.
    -
  • (0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
  • -
  • (0x0002): This position can observe the collected local user's audio, corresponding to the callback.
  • -
  • (0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
  • -
  • (0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
  • -
  • (0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to the callback.
  • +
  • (0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
  • +
  • (0x0002): This position can observe the collected local user's audio, corresponding to the callback.
  • +
  • (0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
  • +
  • (0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
  • +
  • (0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to 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.
    -
  • : 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_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index ada50c18b18..dbd08f548af 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoEncodedFrameObserver" /> + <ph keyref="registerVideoEncodedFrameObserver"/> Registers a receiver object for the encoded video image. - + @@ -25,18 +25,18 @@ observer: IVideoEncodedFrameObserver ): number;
void registerVideoEncodedFrameObserver(VideoEncodedFrameObserver observer); -

+

Details -

If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

+

If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:

    -
  1. Call to register the raw video frame observer before joining the channel.
  2. -
  3. Call to register the encoded video frame observer before joining the channel.
  4. -
  5. After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
  6. -
  7. Call ()to start receiving the video streams of all remote users. Then:
      -
    • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
    • -
    • The encoded video data of group B users can be obtained through the callback in .
    • +
    • Call to register the raw video frame observer before joining the channel.
    • +
    • Call to register the encoded video frame observer before joining the channel.
    • +
    • After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
    • +
    • Call ()to start receiving the video streams of all remote users. Then:
        +
      • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
      • +
      • The encoded video data of group B users can be obtained through the callback in .

@@ -51,24 +51,24 @@ receiver observer videoEncodedImageReceiver - The video frame observer object. See . - The observer instance. See . Set the value as to release the instance. + The video frame observer object. See . + The observer instance. See . Set the value as to release the instance. mode - The video data callback mode. See . + The video data callback mode. 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_imediaengine_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index 554513bc41a..1436175f306 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoFrameObserver" /> + <ph keyref="registerVideoFrameObserver"/> Registers a raw video frame observer object. - + @@ -20,13 +20,13 @@ public abstract int RegisterVideoFrameObserver(IVideoFrameObserver videoFrameObserver, VIDEO_OBSERVER_FRAME_TYPE formatPreference, VIDEO_OBSERVER_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR); abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number; void registerVideoFrameObserver(VideoFrameObserver observer); -

+

Details -

If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one class with this method.

-

When calling this method to register a video observer, you can register callbacks in the class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

-

+

If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one class with this method.

+

When calling this method to register a video observer, you can register callbacks in the class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

+

  • Ensure that you call this method before joining a channel.
  • @@ -35,7 +35,7 @@
  • If the user adjusts the video profile, the resolution of the video returned in the callbacks also changes.
- After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as implementing virtual backgrounds and image enhacement scenarios by yourself, Agora provides an open source sample project on GitHub for your reference.
+ After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as implementing virtual backgrounds and image enhacement scenarios by yourself, Agora provides an open source sample project on GitHub for your reference.
Parameters @@ -43,31 +43,31 @@ observer delegate videoFrameObserver - The observer instance. See . To release the instance, set the value as . + The observer instance. See . To release the instance, set the value as . mode - The video data callback mode. See . + The video data callback mode. See . formatPreference - The video frame type. See . + The video frame type. See . position - A bit mask that controls the frame position of the video observer. See . + A bit mask that controls the frame position of the video 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.
    -
  • : 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_imediaengine_setexternalaudiosink.dita b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita index 162d02dce03..a4404a0f9fc 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita @@ -70,7 +70,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..9c595e19cb0 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita @@ -97,7 +97,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..62d9f50c30d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita @@ -71,7 +71,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..4f264d5042a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita @@ -13,9 +13,9 @@

    - - - + + + abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; @@ -32,7 +32,7 @@

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

    When the method call succeeds, there is no return 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.
    • 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..68fcb1da0d9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita @@ -13,9 +13,9 @@

      - - - + + + abstract unregisterVideoEncodedFrameObserver( observer: IVideoEncodedFrameObserver ): number; @@ -36,7 +36,7 @@

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

      When the method call succeeds, there is no return 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.
      • 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..c965a628b0e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita @@ -13,9 +13,9 @@

        - - - + + + abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number; public abstract int UnRegisterVideoFrameObserver(); abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number; @@ -32,7 +32,7 @@

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

        When the method call succeeds, there is no return 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.
        • 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..c83e1aa29fe 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita @@ -35,7 +35,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..8d64333e453 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita @@ -40,7 +40,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..a675117dc3f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita @@ -41,7 +41,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..bcb0eade1ac 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..56705c2e71d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita @@ -47,7 +47,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..c3d4ae32ea3 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita @@ -55,7 +55,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..8f6f4b6359f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..bb4f5052505 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita @@ -26,7 +26,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..e160ee3fa71 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita @@ -28,7 +28,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..0639cd15856 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita @@ -42,7 +42,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..d6af7dd76d5 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita @@ -47,7 +47,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..506694fc119 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita @@ -57,7 +57,7 @@
        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.
        • 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..36f68da9fb4 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita @@ -38,7 +38,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita index 75da81cd9c3..3bb2ce27f44 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoFrameObserver_IMediaPlayer" /> + <ph keyref="registerVideoFrameObserver_IMediaPlayer"/> Registers a video frame observer object. - + @@ -14,7 +14,7 @@

          int registerVideoFrameObserver(IMediaPlayerVideoFrameObserver videoFrameObserver); - + virtual int registerVideoFrameObserver(media::base::IVideoFrameObserver* observer) = 0; abstract registerVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver @@ -24,11 +24,11 @@ observer: IMediaPlayerVideoFrameObserver ): number; void registerVideoFrameObserver(MediaPlayerVideoFrameObserver 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 @@ -36,16 +36,16 @@ videoFrameObserver observer - The video observer, reporting the reception of each video frame. See . - The video observer, reporting the reception of each video frame. See . + 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_renewagoracdnsrctoken.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita index cb96cc9e62b..9bec30b6d73 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita @@ -46,7 +46,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..d9309656994 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita @@ -24,7 +24,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..71162bcb91c 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita @@ -43,7 +43,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..dd0bfe1a054 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..8248c99359c 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita @@ -45,7 +45,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..88861cce73d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita @@ -35,7 +35,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..86aa29a372a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita @@ -39,7 +39,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..eb3bd380a3a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita @@ -40,7 +40,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..e06c781ae41 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita @@ -45,7 +45,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index ccfebbc3a14..9cdc02c029c 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita @@ -22,7 +22,7 @@ public abstract int SetRenderMode(RENDER_MODE_TYPE renderMode); abstract setRenderMode(renderMode: RenderModeType): number; Future<void> setRenderMode(RenderModeType renderMode); -

          +

        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_imediaplayer_setspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita index 10edd81c0d5..33c42d6f5f6 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita @@ -20,7 +20,7 @@ public abstract int SetSpatialAudioParams(SpatialAudioParams spatial_audio_params); abstract setSpatialAudioParams(params: SpatialAudioParams): number; Future<void> setSpatialAudioParams(SpatialAudioParams params); -

        +

      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_imediaplayer_setview.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita index 2e6a1eb4f1e..70eb30f117b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita @@ -35,7 +35,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..9920a20170f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita @@ -25,7 +25,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..45a68a85112 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnlinebyindex.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnlinebyindex.dita @@ -43,7 +43,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..8d71afe9089 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnsrc.dita @@ -56,7 +56,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..ba9ffa45856 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita @@ -61,7 +61,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..ab9b4bde5a3 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita @@ -42,7 +42,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..14beeaa0b04 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregisteraudioframeobserver.dita @@ -32,7 +32,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..0b827534755 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita @@ -29,7 +29,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..bcded9d6ec2 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita @@ -13,8 +13,8 @@

        - - + + virtual int unregisterVideoFrameObserver(agora::media::base::IVideoFrameObserver* observer) = 0; abstract unregisterVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver @@ -36,7 +36,7 @@

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

        When the method call succeeds, there is no return 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.
        • 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..8a86c20dd5c 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita @@ -29,7 +29,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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 .
        • 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..05942dced56 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita @@ -14,7 +14,7 @@

          public int setMediaRecorderObserver(IMediaRecorderCallback callback) - - (int)setMediaRecorderDelegate:(id<AgoraMediaRecorderDelegate> _Nullable)delegate; + - (int)setMediaRecorderDelegate:(id<AgoraMediaRecorderDelegate> _Nullable)delegate; virtual int setMediaRecorderObserver(media::IMediaRecorderObserver* callback) = 0; abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number; public abstract int SetMediaRecorderObserver(IMediaRecorderObserver callback); @@ -43,7 +43,7 @@

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

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita index e17f2cd5ec8..5678d5a4a2c 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita @@ -1,12 +1,12 @@ - <ph keyref="startRecording" /> + <ph keyref="startRecording"/> Starts recording audio and video streams. - + @@ -19,15 +19,15 @@ abstract startRecording(config: MediaRecorderConfiguration): number; public abstract int StartRecording(MediaRecorderConfiguration config); abstract startRecording(config: MediaRecorderConfiguration): number; - Future<void> startRecording(MediaRecorderConfiguration config); -

            + Future<void> startRecording(MediaRecorderConfiguration config); +

          Details

          You can call this method to enable the recording function. Agora supports recording the media streams of local and remote users at the same time.

          Before you call this method, ensure the following:

            -
          • The recording object is created through .
          • -
          • The recording observer is registered through .
          • +
          • The recording object is created through .
          • +
          • The recording observer is registered through .
          • You have joined the channel which the remote user that you want to record is in.

          Supported formats of recording are listed as below:

            @@ -35,7 +35,7 @@
          • Video captured by a camera and encoded in H.264 or H.265.

          Once the recording is started, if the video resolution is changed, the SDK stops the recording; if the sampling rate and audio channel changes, the SDK continues recording and generates audio files respectively.

          -

          The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the (, ) callback.

          +

          The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the (, ) callback.

            @@ -47,23 +47,23 @@ config - The recording configuration. See . + The recording configuration. 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.
              • -2: The parameter is invalid. Ensure the following:
                • The specified path of the recording file exists and is writable.
                • The specified format of the recording file is supported.
                • The maximum recording duration is correctly set.
              • -
              • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
              • -
              • -7: The method is called before is initialized. Ensure the object is created before calling this method.
              • +
              • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
              • +
              • -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_imediarecorder_stoprecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita index 21021cead23..e7643b61ab9 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita @@ -27,7 +27,7 @@ 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.

        +

        When the method call succeeds, there is no return value; when fails, the 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_addhandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita index 1de45539f2c..6504b487b88 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita @@ -16,8 +16,8 @@ public void addHandler(IRtcEngineEventHandler handler) { mInstance.addHandler(handler); } - - + + abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean; public abstract int InitEventHandler(IRtcEngineEventHandler engineEventHandler); abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean; @@ -41,7 +41,7 @@ Otherwise, the SDK may not work properly.

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

        When the method call succeeds, there is no return 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.
        • 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..ccdf4564155 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addinjectstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addinjectstreamurl.dita @@ -54,7 +54,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
            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..cedf3e850ee 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita @@ -61,7 +61,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..31c097246b4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita @@ -51,7 +51,7 @@ 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.

        +

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

        • 0: Success.
        • < 0: Failure. See for details and resolution suggestions.
        • 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..410e60e1bda 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita @@ -61,7 +61,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..c1291f4f744 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita @@ -35,7 +35,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..6f15e355524 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita @@ -38,7 +38,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..f21f8813432 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita @@ -40,7 +40,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..a74f6f9b955 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudioplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudioplayoutvolume.dita @@ -48,7 +48,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..1eefbf053e3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita @@ -48,7 +48,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..be7ab62aab5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita @@ -37,7 +37,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..56161470a54 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita @@ -39,7 +39,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..b1268b9b775 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita @@ -43,7 +43,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..c084aaccbf9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita @@ -45,7 +45,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..65d26da6333 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita @@ -24,7 +24,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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..f4b1d9a1751 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_complain.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_complain.dita @@ -41,7 +41,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
            diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 3dcfc29a661..5039f14b2cd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="configRhythmPlayer" /> + <ph keyref="configRhythmPlayer"/> Configures the virtual metronome. - + @@ -19,28 +19,28 @@ abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; public abstract int ConfigRhythmPlayer(AgoraRhythmPlayerConfig config); abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; - Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); -

            + Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); +

        Details -

        After calling , you can call this method to reconfigure the virtual metronome.

        -

        After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

        -
        +

        After calling , you can call this method to reconfigure the virtual metronome.

        +

        After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

        +
      Parameters config - The metronome configuration. See . + The metronome configuration. 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_destroycustomvideotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita index 1513387a75c..a5df029d63d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita @@ -34,7 +34,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..3dc1f2fe099 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita @@ -37,7 +37,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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. Returns the ID of media player instance.
      • < 0: Failure. See for details and resolution suggestions.
      • 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..efddbb0912d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita @@ -36,7 +36,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..1da3315c6f8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudiospectrummonitor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudiospectrummonitor.dita @@ -30,7 +30,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..345388922df 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disablevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disablevideo.dita @@ -38,7 +38,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..81f8990edeb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita @@ -38,7 +38,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..73afb6e2052 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita @@ -40,7 +40,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
          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..077e8d60d2a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita @@ -62,7 +62,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..6392d1a93c7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -31,7 +31,7 @@
      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.

      +

      When video screenshot and upload function is enabled, the SDK takes screenshots and uploads 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.
      @@ -52,7 +52,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita index 57fd1fc4aba..13146048862 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita @@ -1,12 +1,12 @@ - <ph keyref="enableDualStreamMode3" /> + <ph keyref="enableDualStreamMode3"/> Enables or disables the dual-stream mode on the sender and sets the low-quality video stream. - + @@ -26,11 +26,11 @@ enabled: boolean, streamConfig?: SimulcastStreamConfig ): number; - Future<void> enableDualStreamMode( + Future<void> enableDualStreamMode( {required bool enabled, SimulcastStreamConfig? streamConfig}); -

        +

      -
      +
      Parameters @@ -38,24 +38,24 @@ enabled

      Whether to enable dual-stream mode:

        -
      • : Enable dual-stream mode.
      • -
      • : (Default) Disable dual-stream mode.
      • +
      • : Enable dual-stream mode.
      • +
      • : (Default) Disable dual-stream mode.

      streamConfig -

      The configuration of the low-quality video stream. See .

      +

      The configuration of the low-quality video stream. 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_enableechocancellationexternal.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita index e56b20a3a65..bb9f0bdf834 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita @@ -54,7 +54,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index 5057d9504c5..92eb92473f8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita @@ -21,7 +21,7 @@ abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number; Future<void> enableEncryption( {required bool enabled, required EncryptionConfig config}); -

        +

      Details @@ -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.
          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..c251a90c24a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita @@ -78,7 +78,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
          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..91f708acda3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita @@ -47,7 +47,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index c1ff454ccae..30acf9c35b2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -1,12 +1,12 @@ - <ph keyref="enableInEarMonitoring2" /> + <ph keyref="enableInEarMonitoring2"/> Enables in-ear monitoring. - + @@ -25,10 +25,10 @@ enabled: boolean, includeAudioFilters: EarMonitoringFilterType ): number; - Future<void> enableInEarMonitoring( + Future<void> enableInEarMonitoring( {required bool enabled, required EarMonitoringFilterType includeAudioFilters}); -

        +

      Details @@ -44,28 +44,28 @@ enabled Enables or disables in-ear monitoring.
        -
      • : Enables in-ear monitoring.
      • -
      • : (Default) Disables in-ear monitoring.
      • +
      • : Enables in-ear monitoring.
      • +
      • : (Default) Disables in-ear monitoring.
      includeAudioFilters - The audio filter of in-ear monitoring: See . + The audio filter of in-ear monitoring: See . The audio filter of in-ear monitoring:
        -
      • (1 << 0): Do not add an audio filter to the in-ear monitor.
      • -
      • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
      • -
      • (1 << 2): Enable noise suppression to the in-ear monitor.

        You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.

        +
      • (1 << 0): Do not add an audio filter to the in-ear monitor.
      • +
      • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
      • +
      • (1 << 2): Enable noise suppression to the in-ear monitor.

        You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.

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

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

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

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

      • 0: Success.
      • -
      • < 0: Failure. See for details and resolution suggestions.
        • - 8: Make sure the current audio routing is Bluetooth or headset.
        +
      • < 0: Failure. See for details and resolution suggestions.
        • - 8: Make sure the current audio routing is Bluetooth or headset.
      - \ 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..0ac3ee36ecd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita @@ -42,7 +42,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
          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..41e486236df 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita @@ -51,7 +51,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..54e3c98f975 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita @@ -47,7 +47,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..c28c6d3e593 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableloopbackrecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableloopbackrecording.dita @@ -61,7 +61,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita index ceca8316592..923eacd90d1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita @@ -1,19 +1,19 @@ - <ph keyref="enableMultiCamera" /> + <ph keyref="enableMultiCamera"/> Enables or disables multi-camera capture. - +

        - + - (int)enableMultiCamera:(BOOL)enabled config:(AgoraCameraCapturerConfiguration* _Nullable)config NS_SWIFT_NAME(enableMultiCamera(_:config:)); #if defined(__APPLE__) && TARGET_OS_IOS virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0; @@ -27,9 +27,9 @@ enabled: boolean, config: CameraCapturerConfiguration ): number; - Future<void> enableMultiCamera( + Future<void> enableMultiCamera( {required bool enabled, required CameraCapturerConfiguration config}); -

        +

        Details @@ -41,18 +41,18 @@

        In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:

        1. Call this method to enable multi-channel camera capture.
        2. -
        3. Call to start the local video preview.
        4. -
        5. Call , and set sourceType to start video capture with the second camera.
        6. -
        7. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.
        8. +
        9. Call to start the local video preview.
        10. +
        11. Call , and set sourceType to start video capture with the second camera.
        12. +
        13. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.

        If you want to disable multi-channel camera capture, use the following steps:

          -
        1. Call .
        2. -
        3. Call this method with enabled set to .
        4. +
        5. Call .
        6. +
        7. Call this method with enabled set to .

        -

        You can call this method before and after to enable multi-camera capture:

          -
        • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
        • -
        • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.
        • +

          You can call this method before and after to enable multi-camera capture:

            +
          • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
          • +
          • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.

          This method applies to iOS only.

          @@ -70,22 +70,22 @@ enabled Whether to enable multi-camera video capture mode:
            -
          • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
          • -
          • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
          • +
          • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
          • +
          • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
          config - Capture configuration for the second camera. See . + Capture configuration for the second camera. 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_enableremotesuperresolution.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita index 98f6c994a6a..6624d94290b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita @@ -85,7 +85,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..cc0fd34e76f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablesoundpositionindication.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablesoundpositionindication.dita @@ -39,7 +39,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..a0653658c82 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita @@ -44,7 +44,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..e1ee0a0e3c2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita @@ -39,7 +39,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..7b5c63e150e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita @@ -53,7 +53,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 88f96236625..66b7af24129 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -1,12 +1,12 @@ - <ph keyref="enableVirtualBackground" /> + <ph keyref="enableVirtualBackground"/> Enables/Disables the virtual background. - + @@ -32,17 +32,17 @@ segproperty: SegmentationProperty, type?: MediaSourceType ): number; - Future<void> enableVirtualBackground( + Future<void> enableVirtualBackground( {required bool enabled, required VirtualBackgroundSource backgroundSource, required SegmentationProperty segproperty, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

      +

      Details

      The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background.

      -

      Call this method before calling or .

      +

      Call this method before calling or .

      • This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
          @@ -64,7 +64,7 @@
        • A high-definition camera device is used, and the environment is uniformly lit.
        • There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.
      • -
      • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
      • +
      • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
      Parameters @@ -73,38 +73,38 @@ enabled enable Whether to enable virtual background:
        -
      • : Enable virtual background.
      • -
      • : Disable virtual background.
      • +
      • : Enable virtual background.
      • +
      • : Disable virtual background.
      backgroundSource backData - The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. + The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. segproperty segData - Processing properties for background images. See . + Processing properties for background images. See . type - The type of the video source. See .In this method, this parameter supports only the following two settings:
        -
      • The default value is .
      • -
      • If you want to use the second camera to capture video, set this parameter to .
      • + The type of the video source. See .In this method, this parameter supports only the following two settings:
          +
        • The default value is .
        • +
        • If you want to use the second camera to capture video, set this parameter 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.
          -
        • -1: The custom background image does not exist. Check the value of source in .
        • -
        • -2: The color format of the custom background image is invalid. Check the value of color in .
        • +
        • -1: The custom background image does not exist. Check the value of source in .
        • +
        • -2: The color format of the custom background image is invalid. Check the value of color in .
        • -3: The device does not support virtual background.
      - \ 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..9d18c770917 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablewebsdkinteroperability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablewebsdkinteroperability.dita @@ -46,7 +46,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita index 770768f8c6e..51d1f0f9c92 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -1,12 +1,12 @@ - <ph keyref="initialize" /> - Creates and initializes . Initializes . + <ph keyref="initialize"/> + Creates and initializes . Initializes . - + @@ -22,17 +22,17 @@ public abstract int Initialize(RtcEngineContext context); abstract initialize(context: RtcEngineContext): number; Future<void> initialize(RtcEngineContext context); -

      +

    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 and to create and initialize the object.
    • -
    • 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 this method 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 and to create and initialize the object.
    • +
    • 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 this method 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 @@ -41,21 +41,21 @@ context config -

    Configurations for the instance. See .

    +

    Configurations for the instance. See .

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

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

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

    When the method call succeeds, there is no return 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 instance, if the method call succeeds.
    • +
    • The instance, if the method call succeeds.
    • 0: Success.
    • -
    • 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 method call fails and an exception is thrown, you need to catch the exception and handle it. See for details and resolution suggestions.
    • < 0: Failure.
      • -1: A general error occurs (no specified reason).
      • -2: The parameter is invalid.
      • @@ -64,6 +64,6 @@
      • -101: The App ID is invalid.
    -
    +
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita b/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita index ae0a0f86647..7e1cb8789ee 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita @@ -1,12 +1,12 @@ - <ph keyref="isFeatureAvailableOnDevice" /> + <ph keyref="isFeatureAvailableOnDevice"/> Checks whether the device supports the specified advanced feature. - + @@ -39,11 +39,11 @@ type - The specific of the advanced feature, see . + The type of the advanced feature, see . -

    The specific the advanced feature.

      +

      The type of the advanced feature.

      • (1): Virutual background.
      • -
      • (2): Image enchancement.
      • +
      • (2): Image enhancement.

      @@ -55,4 +55,4 @@
    • : The current device does not support the specified feature.
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index be33f384296..46ac7c36634 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -36,12 +36,12 @@ uid: number, options: ChannelMediaOptions ): number; - Future<void> joinChannel( + Future<void> joinChannel( {required String token, required String channelId, required int uid, required ChannelMediaOptions options}); -

    +

    Details @@ -62,7 +62,7 @@ token - The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . + The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . channelId @@ -72,7 +72,7 @@
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
  • -
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
  • +
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

@@ -91,8 +91,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.
      @@ -106,4 +106,4 @@
- \ No newline at end of file + 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..927cfda5c83 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita @@ -76,7 +76,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
      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..3d6cca42856 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita @@ -89,7 +89,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..6c294b6c458 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita @@ -48,7 +48,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
      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..5eea6456fe1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita @@ -46,7 +46,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..e5c2d47dc79 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita @@ -13,8 +13,8 @@

    - - + + virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0; abstract loadExtensionProvider( path: string, @@ -54,7 +54,7 @@

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

    When the method call succeeds, there is no return 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.
    • 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..046b6b593cb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita @@ -47,7 +47,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..407409602a2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita @@ -46,7 +46,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..2760a380df7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita @@ -42,7 +42,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..5aef6dbac02 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita @@ -46,7 +46,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..f094da530aa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita @@ -39,7 +39,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..f466a644992 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita @@ -50,7 +50,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..b1e4fcbe564 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita @@ -51,7 +51,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..50d0190c730 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita @@ -28,7 +28,7 @@ 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.

    +

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

    • 0: Success.
    • < 0: Failure. See for details and resolution suggestions.
    • 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..2cc99c78583 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pausealleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pausealleffects.dita @@ -26,7 +26,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..cb08c74ae2b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita @@ -28,7 +28,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..7cec9ff396f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pauseeffect.dita @@ -32,7 +32,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..f835247c06e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita @@ -86,7 +86,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..695f8cb98b2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita @@ -129,7 +129,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index 1b04fbb0ef9..322dd21d1b0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel" /> + <ph keyref="preloadChannel"/> Preloads a channel with token, channelIdchannelName, and uidoptionalUid. - + @@ -29,7 +29,7 @@ channelId: string, uid: number ): number; - Future<void> preloadChannel( + Future<void> preloadChannel( {required String token, required String channelId, required int uid});

    @@ -41,9 +41,9 @@

    When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel.

    -
    • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
    • +
      • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
      • You also need to make sure that the channel name, user ID and token passed in for preloading are the same as the values passed in when joinning the channel, otherwise, this method does not take effect.
      • -
      • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
      • +
      • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
      • Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.

      If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.

    @@ -52,8 +52,8 @@ token - The token generated on your server for authentication. See .

    When the token for preloading channels expires, you can update the token based on the number of channels you preload.

    • When preloading one channel, calling this method to pass in the new token.
    • -
    • When preloading more than one channels:
      • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
      • + The token generated on your server for authentication. See .

        When the token for preloading channels expires, you can update the token based on the number of channels you preload.

        • When preloading one channel, calling this method to pass in the new token.
        • +
        • When preloading more than one channels:
          • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
          • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.

        @@ -65,17 +65,17 @@
      • All 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.
      @@ -84,4 +84,4 @@
- \ 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..e9ec3bb2f02 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita @@ -69,7 +69,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
      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..6184390dd50 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita @@ -66,7 +66,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..c51ee383c86 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita @@ -44,7 +44,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita index cb13450015b..7ea527829ad 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita @@ -20,7 +20,7 @@ abstract pushReverseAudioFrame(frame: AudioFrame): number; Future<void> pushReverseAudioFrame(AudioFrame frame); -

    +

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_rate.dita b/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita index ea9fbe47661..85da53860e4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita @@ -50,7 +50,7 @@ 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.

+

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

  • 0: Success.
  • < 0: Failure. See for details and resolution suggestions.
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita index af70206c7a2..e4a65e775e4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita @@ -30,7 +30,7 @@ void registerAudioEncodedFrameObserver( {required AudioEncodedFrameObserverConfig config, required AudioEncodedFrameObserver observer}); -

      +

Details @@ -57,12 +57,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.
-

One object.

+

One object.

- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita index feb57cf4a9a..d0a5b0bf066 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita @@ -25,7 +25,7 @@ observer: IAudioSpectrumObserver ): number;
void registerAudioSpectrumObserver(AudioSpectrumObserver observer); -

+

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.
-

One object.

+

One object.

- \ No newline at end of file + 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..36ca390af74 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita @@ -13,8 +13,8 @@

- - + + virtual int registerExtension(const char* provider, const char* extension, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0; abstract registerExtension( @@ -63,7 +63,7 @@

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

When the method call succeeds, there is no return 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.
  • 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..fc2edf8c9b3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita @@ -61,7 +61,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index 70e5b021968..af9c5b16819 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita @@ -28,7 +28,7 @@ ): number; void registerMediaMetadataObserver( {required MetadataObserver observer, required MetadataType type}); -

    +

Details @@ -51,12 +51,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_removehandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita index 1d5ff941292..d7f21a93df8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita @@ -24,7 +24,7 @@ eventHandler: IRtcEngineEventHandler ): boolean;
void unregisterEventHandler(RtcEngineEventHandler eventHandler); -

+

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.

  • : 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_removeinjectstreamurl.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita index 4629c00bf3e..68b150673e9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita @@ -37,7 +37,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..caa1e695764 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita @@ -48,7 +48,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..ed09f99aa85 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita @@ -37,7 +37,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
      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..d63d59eafbe 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita @@ -28,7 +28,7 @@ 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.

+

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

  • 0: Success.
  • < 0: Failure. See for details and resolution suggestions.
  • 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..0ec6af5ad86 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita @@ -26,7 +26,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..dbb4d533ae2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita @@ -28,7 +28,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..cdddeebe685 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita @@ -34,7 +34,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..7b02e7a25ad 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita @@ -41,7 +41,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita index a2233e2ec6f..e0312cb2de3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita @@ -21,7 +21,7 @@ abstract sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number; Future<void> sendMetaData( {required Metadata metadata, required VideoSourceType sourceType}); -

    +

Details @@ -33,20 +33,20 @@ metadata - Media metadata See . + Media metadata See . sourceType source_type - 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_sendstreammessage.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita index b374d1fec24..0f2d3292a9e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita @@ -63,7 +63,7 @@ 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.

+

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

  • 0: Success.
  • < 0: Failure. See for details and resolution suggestions.
  • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita index cd1b84e9283..9718eed03f2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita @@ -19,8 +19,8 @@ abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; public abstract int SetAdvancedAudioOptions(AdvancedAudioOptions options); abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; - Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); -

    + Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); +

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_setainsmode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita index 14e288ca914..88320634bd9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita @@ -65,7 +65,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..63aec2b70f4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita @@ -102,7 +102,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..91ddbd9f53f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita @@ -78,7 +78,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index 759d8d78c9f..e2c710dacd0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita @@ -20,7 +20,7 @@ public abstract int SetAudioMixingDualMonoMode(AUDIO_MIXING_DUAL_MONO_MODE mode); abstract setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): number; Future<void> setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode); -

    +

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_setaudiomixingpitch.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita index 3aa7e89242e..b259bc606f4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita @@ -36,7 +36,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..1b6e4dc2ddd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita @@ -36,7 +36,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..fb4fe7d4d57 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita @@ -74,7 +74,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..9e2cf68808e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita @@ -44,7 +44,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..aaef8c5acd1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita @@ -44,7 +44,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..f23540bf95c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita @@ -40,7 +40,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..3cbfac78745 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita @@ -65,7 +65,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
      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..66bc4f8c765 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita @@ -47,7 +47,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..7f8d3aa13e3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita @@ -49,7 +49,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..c819f44e51e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita @@ -44,7 +44,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..0d46c1456a0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita @@ -54,7 +54,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..b30d846f626 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita @@ -17,7 +17,7 @@ - (CGFloat)setCameraExposureFactor:(CGFloat)exposureFactor NS_SWIFT_NAME(setCameraExposureFactor(_:)); virtual int setCameraExposureFactor(float factor) = 0; - + public abstract int SetCameraExposureFactor(float factor); abstract setCameraExposureFactor(factor: number): number; Future<void> setCameraExposureFactor(double factor); @@ -56,7 +56,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..d14c0b94c48 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita @@ -56,7 +56,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..7f2ac3edc84 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita @@ -56,7 +56,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..18ca6834c17 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita @@ -45,7 +45,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.
  • 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..42295356e4b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita @@ -41,7 +41,7 @@
<ph keyref="return-section-title"/> -

When the method call succeeds, there is no return 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.

  • The camera zoom factor value, if successful.
  • < 0: if the method if failed.
  • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita index e1a37166d64..ea6d1bd086f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita @@ -20,7 +20,7 @@ public abstract int SetChannelProfile(CHANNEL_PROFILE_TYPE profile); abstract setChannelProfile(profile: ChannelProfileType): number; Future<void> setChannelProfile(ChannelProfileType profile); -

    +

Details @@ -45,13 +45,13 @@
  • (2): Gaming.
    Deprecated:
    -
    Use instead.
    +
    Use instead.
  • (3): Interaction. The scenario is optimized for latency. Use this profile if the use case requires frequent interactions between users.
    Deprecated:
    -
    Use instead.
    +
    Use instead.
  • @@ -59,8 +59,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(ERR_OK): Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita index 5cfe8167aea..7120571cdc3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -27,7 +27,7 @@ ): number; Future<void> setClientRole( {required ClientRoleType role, ClientRoleOptions? options}); -

        +

    Details @@ -39,7 +39,7 @@
  • Triggers on the local client.
  • Triggers or on the remote client.
  • -

    The difference between this method and is that this method can set the user level in addition to the user role.

      +

      The difference between this method and is that this method can set the user level in addition to the user role.

      • The user role (role) determines the permissions that the SDK grants to a user, such as permission to send local streams, receive remote streams, and push streams to a CDN address.
      • The user level (level) determines the level of services that a user can enjoy within the permissions of the user's role. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. User level affects the pricing of services.

      @@ -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.
        • -1: A general error occurs (no specified reason).
        • -2: The parameter is invalid.
        • -5: The request is rejected.
        • @@ -73,4 +73,4 @@
    - \ No newline at end of file + 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..fbc7ebb48fd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita @@ -52,7 +52,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita index 80c45acc675..7d118bb16cc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita @@ -30,11 +30,11 @@ options: ColorEnhanceOptions, type?: MediaSourceType ): number; - Future<void> setColorEnhanceOptions( + Future<void> setColorEnhanceOptions( {required bool enabled, required ColorEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

        +

    Details @@ -48,7 +48,7 @@
  • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
  • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
  • -
  • 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.
  • Parameters @@ -66,16 +66,16 @@ The color enhancement 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_setdefaultaudioroutetospeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita index 33c5966ea52..33677524ea5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -61,7 +61,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..61e048bf7ea 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita @@ -53,7 +53,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..11f65358af1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita @@ -47,7 +47,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..ec518aab071 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita @@ -42,7 +42,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..05707efd3f1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita @@ -44,7 +44,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita index d7d24b05232..46e016bcc11 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode2" /> + <ph keyref="setDualStreamMode2"/> Sets dual-stream mode configuration on the sender, and sets the low-quality video stream. - + @@ -28,9 +28,9 @@ mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig ): number; - Future<void> setDualStreamMode( + Future<void> setDualStreamMode( {required SimulcastStreamMode mode, SimulcastStreamConfig? streamConfig}); -

      +

    Details @@ -40,11 +40,11 @@
    v4.0.1
    -

    -

    The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
    • -
    • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
    • +

      +

      The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
      • +
      • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -53,22 +53,22 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. See . streamConfig -

    The configuration of the low-quality video stream. See .

    - When setting mode to , setting streamConfig will not take effect. +

    The configuration of the low-quality video stream. See .

    + When setting mode to , setting streamConfig will 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_irtcengine_setearmonitoringaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita index b598cac0e33..f7f6e1fd11f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita @@ -80,7 +80,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..dd3eda2cde8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita @@ -40,7 +40,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..c4565e9dc52 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita @@ -37,7 +37,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..3e765442e98 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita @@ -47,7 +47,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..23361acbc4e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita @@ -52,7 +52,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..c6693608297 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita @@ -46,7 +46,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..254d29a3126 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita @@ -75,7 +75,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..73f86a83fdd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita @@ -61,7 +61,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..07050d149e0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita @@ -47,7 +47,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita index 56ad4f71422..5d00f0a7af1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita @@ -1,12 +1,12 @@ - <ph keyref="setHeadphoneEQPreset" /> + <ph keyref="setHeadphoneEQPreset"/> Sets the preset headphone equalization effect. - + @@ -19,8 +19,8 @@ abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; public abstract int SetHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset); abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; - Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); -

        + Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); +

    Details @@ -37,12 +37,12 @@ preset - The preset headphone equalization effect. See . + The preset headphone equalization effect. 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.
        @@ -50,4 +50,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..c97df2493d0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita @@ -40,7 +40,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita index e16af742e02..0d778d7c653 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita @@ -20,7 +20,7 @@ public abstract int SetLiveTranscoding(LiveTranscoding transcoding); abstract setLiveTranscoding(transcoding: LiveTranscoding): number; Future<void> setLiveTranscoding(LiveTranscoding transcoding); -

      +

    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_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita index 6ca21e715ec..101bb5567b6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita @@ -20,7 +20,7 @@ public abstract int SetLocalAccessPoint(LocalAccessPointConfiguration config); abstract setLocalAccessPoint(config: LocalAccessPointConfiguration): number; Future<void> setLocalAccessPoint(LocalAccessPointConfiguration config); -

    +

    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_setlocalpublishfallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita index 354436e12c4..7648e5ecc03 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita @@ -20,7 +20,7 @@ public abstract int SetLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option); Future<void> setLocalPublishFallbackOption(StreamFallbackOptions option); -

    +

    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_setlocalrendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita index 52a09fa51d5..06715206d69 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita @@ -27,7 +27,7 @@ mirrorMode?: VideoMirrorModeType ): number;
    Future<void> setLocalRenderMode2(RenderModeType renderMode); -

    +

    Details @@ -58,11 +58,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_setlocalrendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index 362e5a34877..27b2ee7cde7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -30,7 +30,7 @@ {required RenderModeType renderMode, VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto});
    -

    +

    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_irtcengine_setlocalvideomirrormode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita index 340b1fe564e..f124d7af263 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita @@ -20,7 +20,7 @@ public abstract int SetLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode); abstract setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number; Future<void> setLocalVideoMirrorMode(VideoMirrorModeType mirrorMode); -

    +

    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_setlocalvoiceequalization.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita index 4c0206a7fe5..d4950dccfa0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita @@ -50,7 +50,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..e5fbb184f1f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita @@ -43,7 +43,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..8b7bd43d311 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita @@ -35,7 +35,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..ea8e650f119 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita @@ -48,7 +48,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..cba0c3b46a7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita @@ -44,7 +44,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..df9782ba795 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita @@ -58,7 +58,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..8a07157f44b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita @@ -52,7 +52,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..507264f3a09 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita @@ -43,7 +43,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita index 194df414a2a..6c9ceba53d4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita @@ -30,11 +30,11 @@ options: LowlightEnhanceOptions, type?: MediaSourceType ): number; - Future<void> setLowlightEnhanceOptions( + Future<void> setLowlightEnhanceOptions( {required bool enabled, required LowlightEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

      +

    Details @@ -48,7 +48,7 @@
  • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
  • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
  • -
  • 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.
  • Parameters @@ -67,15 +67,15 @@ type - 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_setmaxmetadatasize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita index 5ed3f2d3c95..3b3172a8b09 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita @@ -36,7 +36,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..9e5851947c3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita @@ -66,7 +66,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..d755134e3ce 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita @@ -49,7 +49,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..814b8ba885b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita @@ -50,7 +50,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..c31a29cb219 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita @@ -82,7 +82,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..3afb8eed64b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita @@ -90,7 +90,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..4f35f360563 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita @@ -48,7 +48,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..c8b935ec1aa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita @@ -74,7 +74,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..5e80b66998b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita @@ -45,7 +45,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita index c83aecfc281..b0fff7039b7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita @@ -28,7 +28,7 @@ ): number; Future<void> setRemoteUserSpatialAudioParams( {required int uid, required SpatialAudioParams params}); -

      +

    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_setremotevideostreamtype.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita index 68b50bcb620..44f9ec68f69 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita @@ -56,7 +56,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..11c5ed07671 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita @@ -59,7 +59,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..7a0f7922288 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita @@ -63,7 +63,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita index 240ffaf0035..40a0f0055aa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita @@ -21,7 +21,7 @@ public abstract int SetScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint); abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number; Future<void> setScreenCaptureContentHint(VideoContentHint contentHint); -

      +

    Details @@ -37,8 +37,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_setscreencapturescenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita index 2a3eb28533d..c33b1fc297b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita @@ -41,7 +41,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..d3b874bc394 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita @@ -57,7 +57,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..2a7242f3aa8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita @@ -57,7 +57,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..b8b5295149c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita @@ -56,7 +56,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..c9e91609af9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita @@ -57,7 +57,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index abf5f1e479a..d9b7699390c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -20,7 +20,7 @@ public abstract int SetupLocalVideo(VideoCanvas canvas); abstract setupLocalVideo(canvas: VideoCanvas): number; Future<void> setupLocalVideo(VideoCanvas canvas); -

      +

    Details @@ -28,7 +28,7 @@

    After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as .

      -
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
    • +
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
    • You can call this method either before or after joining a channel.
    • To update the rendering or mirror mode of the local video view during a call, use the method.
    @@ -38,15 +38,15 @@ canvas local - The local video view and settings. See . + The local video view and settings. 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_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index 88595963864..739f94e9775 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -1,12 +1,12 @@ - <ph keyref="setupRemoteVideo" /> + <ph keyref="setupRemoteVideo"/> Initializes the video view of a remote user. - + @@ -20,19 +20,19 @@ public abstract int SetupRemoteVideo(VideoCanvas canvas); abstract setupRemoteVideo(canvas: VideoCanvas): number; Future<void> setupRemoteVideo(VideoCanvas canvas); -

    +

    Details

    This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.

    -

    You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

    +

    You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

    To unbind the remote user from the view, set the view parameter to NULL.

    Once the remote user leaves the channel, the SDK unbinds the remote user.

      -
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
    • -
    • To update the rendering or mirror mode of the remote video view during a call, use the method.
    • -
    • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
    • +
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
    • +
    • To update the rendering or mirror mode of the remote video view during a call, use the method.
    • +
    • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
    Parameters @@ -41,16 +41,16 @@ canvas remote -

    The remote video view and settings. See .

    +

    The remote video view and settings. 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_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita index 9b16e756311..22d69893533 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoDenoiserOptions" /> + <ph keyref="setVideoDenoiserOptions"/> Sets video noise reduction. - + @@ -30,11 +30,11 @@ options: VideoDenoiserOptions, type?: MediaSourceType ): number;
    - Future<void> setVideoDenoiserOptions( + Future<void> setVideoDenoiserOptions( {required bool enabled, required VideoDenoiserOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

    +

    Details @@ -42,13 +42,13 @@

    You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.

      -
    • Call this method after calling .
    • +
    • Call this method after calling .
    • Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.
    • -
    • Both this method and can turn on video noise reduction function:
        +
      • Both this method and can turn on video noise reduction function:
        • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
        • -
        • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
        • +
        • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
      • -
      • 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.
    Parameters @@ -57,25 +57,25 @@ enabled enable Whether to enable video noise reduction:
      -
    • : Enable video noise reduction.
    • -
    • : (Default) Disable video noise reduction.
    • +
    • : Enable video noise reduction.
    • +
    • : (Default) Disable video noise reduction.
    options - The video noise reduction options. See . + The video noise reduction 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_setvideoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita index 5b3f3047fd6..42fd654b465 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoEncoderConfiguration" /> + <ph keyref="setVideoEncoderConfiguration"/> Sets the video encoder configuration. - + @@ -24,32 +24,32 @@ config: VideoEncoderConfiguration ): number;
    Future<void> setVideoEncoderConfiguration(VideoEncoderConfiguration config); -

    +

    Details

    Sets the encoder configuration for the local video.

      -
    • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
    • -
    • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
    • +
    • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
    • +
    • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
    - You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. - Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
    + You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. + Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
    Parameters config - Video profile. See . + Video profile. 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_setvideoscenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita index 11316726123..f889e2401ba 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita @@ -75,7 +75,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..30e485d7573 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita @@ -75,7 +75,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..ef9976a5083 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita @@ -76,7 +76,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..1ec08bc0643 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita @@ -62,7 +62,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..3765353d271 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita @@ -39,7 +39,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..a8e3f4ce85c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita @@ -86,7 +86,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..0e11947a63d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita @@ -84,7 +84,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita index 64405795936..95648b898d0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita @@ -20,7 +20,7 @@ public abstract int StartAudioRecording(AudioRecordingConfiguration config); abstract startAudioRecording(config: AudioRecordingConfiguration): number; Future<void> startAudioRecording(AudioRecordingConfiguration config); -

        +

    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_startcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index fac5545f581..05004052ff4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startCameraCapture" /> + <ph keyref="startCameraCapture"/> Starts camera capture. - + @@ -26,10 +26,10 @@ sourceType: VideoSourceType, config: CameraCapturerConfiguration ): number;
    - Future<void> startCameraCapture( + Future<void> startCameraCapture( {required VideoSourceType sourceType, required CameraCapturerConfiguration config}); -

    +

    Details @@ -40,7 +40,7 @@

    You can call this method to start capturing video from one or more cameras by specifying sourceType.

    - On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method. + On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method.
    Parameters @@ -48,7 +48,7 @@ sourceType -

    The type of the video source. See .

    +

    The type of the video source. See .

    • On the mobile platforms, you can capture video from up to 2 cameras, provided the device has dual cameras or supports an external camera.
    • On the desktop platforms, you can capture video from up to 4 cameras.
    @@ -57,18 +57,18 @@ config -

    The configuration of the video capture. See .

    - On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
    +

    The configuration of the video capture. See .

    + On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
    - <ph keyref="return-section-title" /> -

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

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

    When the method call succeeds, there is no return value; when fails, the exception is thrown, and you need to catch the exception and handle it accordingly. 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_startchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita index f554f21fafc..a6f6282405c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelay" /> + <ph keyref="startChannelMediaRelay"/> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,7 +26,7 @@ ): number;
    Future<void> startChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

    +

    Details @@ -36,16 +36,16 @@
    This method is deprecated. Use instead.
    -

    After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

      -
    • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
    • -
    • If the callback returns (3), an exception occurs during the media stream relay.
    • +

      After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

        +
      • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
      • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
      • -
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
      • -
      • The relaying media streams across channels function needs to be enabled by contacting .
      • +
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
      • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -55,12 +55,12 @@ 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.
        @@ -71,4 +71,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita index 5e4840e581b..ffa8e88fa71 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita @@ -28,11 +28,11 @@ publishUrl: string, options: DirectCdnStreamingMediaOptions ): number;
    - Future<void> startDirectCdnStreaming( + Future<void> startDirectCdnStreaming( {required DirectCdnStreamingEventHandler eventHandler, required String publishUrl, required DirectCdnStreamingMediaOptions options}); -

    +

    Details

    Aogra does not support pushing media streams to one URL repeatedly.

    @@ -46,7 +46,7 @@
  • publishCameraTrack is set as (the default value)
  • publishMicrophoneTrack is set as (the default value)
  • -

    As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

    +

    As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

    Parameters @@ -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_startechotest2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita index ac170c1e9cc..4d2e7d6dcd6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita @@ -54,7 +54,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..6891701edfb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita @@ -48,7 +48,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..779a7d6c63f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita @@ -64,7 +64,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..c420d9fa397 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita @@ -41,7 +41,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita index 4681e3714ae..c55c28f1f6a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelay" /> + <ph keyref="startOrUpdateChannelMediaRelay"/> Starts relaying media streams across channels or updates channels for media relay. - + @@ -24,9 +24,9 @@ abstract startOrUpdateChannelMediaRelay( configuration: ChannelMediaRelayConfiguration ): number; - Future<void> startOrUpdateChannelMediaRelay( + Future<void> startOrUpdateChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

        +

    Details @@ -36,15 +36,15 @@
    v4.2.0

    The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

    -

    After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

      -
    • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
    • -
    • If the callback returns (3), an exception occurs during the media stream relay.
    • +

      After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

        +
      • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
      • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
      • -
      • The relaying media streams across channels function needs to be enabled by contacting .
      • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -54,12 +54,12 @@ 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.
        @@ -70,4 +70,4 @@
    - \ 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..d89b5168b81 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita @@ -49,7 +49,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index 49d2ca96f57..e8d5d137fb9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="startRhythmPlayer" /> + <ph keyref="startRhythmPlayer"/> Enables the virtual metronome. - + @@ -28,42 +28,42 @@ sound2: string, config: AgoraRhythmPlayerConfig ): number; - Future<void> startRhythmPlayer( + Future<void> startRhythmPlayer( {required String sound1, required String sound2, required AgoraRhythmPlayerConfig config}); -

      +

    Details

    In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.

    In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.

    -

    After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

    +

    After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

    • This method is for Android and iOS only.
    • -
    • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
    • -
    • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
    • +
    • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
    • +
    • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
    Parameters sound1 - The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. sound2 - The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. config - The metronome configuration. See . + The metronome configuration. 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.
        @@ -71,4 +71,4 @@
    - \ 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..669de4e8f5a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita @@ -57,7 +57,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index 5b78fd8562a..c0d48993e43 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startScreenCapture" /> + <ph keyref="startScreenCapture"/> Starts screen capture. - + @@ -22,32 +22,32 @@ abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; public abstract int StartScreenCapture(ScreenCaptureParameters2 captureParams); abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; - Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); -

        + Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); +

    Details

    There are two ways to start screen sharing, you can choose one according to your needs:

      -
    • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
    • -
    • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.
    • +
    • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
    • +
    • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.

    -

    When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

    +

    When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

    • This method applies to Android and iOS only.
    • On the iOS platform, screen sharing is only available on iOS 12.0 and later.
    • -
    • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. For billing details, see .
    • +
    • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. For billing details, see .
    • If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.
    • This feature requires high-performance device, and Agora recommends that you use it on iPhone X and later models.
    • This method relies on the iOS screen sharing dynamic library AgoraReplayKitExtension.xcframework. If the dynamic library is deleted, screen sharing cannot be enabled normally.
    • On the Android platform, make sure the user has granted the app screen capture permission.
    • -
    • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
    • -
    • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
    • +
    • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
    • +
    • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
    • On Android 9 and later, to avoid the application being killed by the system after going to the background, Agora recommends you add the foreground service android.permission.FOREGROUND_SERVICE to the /app/Manifests/AndroidManifest.xml file.
    • Due to performance limitations, screen sharing is not supported on Android TV.
    • Due to system limitations, if you are using Huawei phones, do not adjust the video encoding resolution of the screen sharing stream during the screen sharing, or you could experience crashes.
    • Due to system limitations, some Xiaomi devices do not support capturing system audio during screen sharing.
    • -
    • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
    • +
    • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
    Parameters @@ -56,12 +56,12 @@ parameters screenCaptureParameters captureParams - The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. 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.
        @@ -69,4 +69,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita index 4351ddd9106..dd2ff5143b9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita @@ -22,11 +22,11 @@ config: ScreenCaptureConfiguration ): number;
    public abstract int StartScreenCapture(VIDEO_SOURCE_TYPE sourceType, ScreenCaptureConfiguration config); - - Future<void> startScreenCaptureBySourceType( + + Future<void> startScreenCaptureBySourceType( {required VideoSourceType sourceType, required ScreenCaptureConfiguration config}); -

    +

    Details @@ -36,15 +36,15 @@
    v4.2.0
    -

    This method, as well as and , all have the capability to start screen capture, with the following differences: -This method, as well as , , and , all have the capability to start screen capture, with the following differences:

      -
    • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
    • -
    • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
    • +

      This method, as well as and , all have the capability to start screen capture, with the following differences: +This method, as well as , , and , all have the capability to start screen capture, with the following differences:

        +
      • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
      • +
      • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.

      • This method applies to the macOS and Windows only.
      • -
      • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
      +
    • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
    Parameters @@ -52,10 +52,10 @@ sourceType -

    The type of the video source. See .

    +

    The type of the video source. See .

    • Windows supports up to four screen capture video streams.
    • -
    • macOS supports only one screen capture video stream. You can only set this parameter to (2).
    +
  • macOS supports only one screen capture video stream. You can only set this parameter to (2).
  • @@ -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. See for details and resolution suggestions.
    • +
    • < 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_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index d3bdeac6302..fa74234ec9a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -36,7 +36,7 @@ {required int displayId, required Rectangle regionRect, required ScreenCaptureParameters captureParams});
    -

    +

    Details @@ -71,8 +71,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_startscreencapturebyscreenrect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita index 9b06c582e4b..5a9d8db1dbf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita @@ -34,7 +34,7 @@ {required Rectangle screenRect, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

        +

    Details @@ -65,8 +65,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_startscreencapturebywindowid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita index 6c74606aa3e..ad0c03c7b06 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita @@ -35,7 +35,7 @@ {required int windowId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

      +

    Details @@ -196,8 +196,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_stopalleffects.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita index 9aa82f3e690..c1932e0133f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita @@ -26,7 +26,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..35244df9e0c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita @@ -28,7 +28,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..3f58da3799c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita @@ -24,7 +24,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..0e00226fb4d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita @@ -45,7 +45,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..8c3b8577a72 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita @@ -28,7 +28,7 @@ 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.

    +

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

    • 0: Success.
    • < 0: Failure. See for details and resolution suggestions.
    • 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..a0c496fb204 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita @@ -21,7 +21,7 @@ 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.

    +

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

    • 0: Success.
    • < 0: Failure. See for details and resolution suggestions.
    • 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..08e1259e410 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita @@ -24,7 +24,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..245c36999b6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita @@ -34,7 +34,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..a3d67c5ec7e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita @@ -24,7 +24,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..91db1f70da0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita @@ -29,7 +29,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.

      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..b9185c99c99 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita @@ -45,7 +45,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..760c4a59c97 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita @@ -28,7 +28,7 @@ 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.

    +

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

    • 0: Success.
    • < 0: Failure. See for details and resolution suggestions.
    • 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..33504b682e7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita @@ -38,7 +38,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..b2199a23461 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita @@ -27,7 +27,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..0ea3cb94cb9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita @@ -46,7 +46,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..d390b53720c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita @@ -30,7 +30,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..ce1ca83d3bb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita @@ -54,7 +54,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..0784dcbb846 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita @@ -25,7 +25,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..5578b587c99 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita @@ -34,7 +34,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita index 74bc073bab3..f4b65943107 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita @@ -1,21 +1,21 @@ - <ph keyref="unregisterAudioEncodedFrameObserver" /> + <ph keyref="unregisterAudioEncodedFrameObserver"/> Unregisters the encoded audio frame observer. - +

      - - - + + + abstract unregisterAudioEncodedFrameObserver( observer: IAudioEncodedFrameObserver ): number; @@ -26,7 +26,7 @@ ): number; void unregisterAudioEncodedFrameObserver(AudioEncodedFrameObserver observer); -

      +

      Parameters @@ -38,12 +38,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_unregisteraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita index 2a657519463..99d5a110ef5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita @@ -13,10 +13,10 @@

      - - - - + + + + public abstract int UnRegisterAudioFrameObserver(); @@ -24,7 +24,7 @@

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

      When the method call succeeds, there is no return 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.
      • 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..e1959c54a4d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita @@ -41,7 +41,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..c3072c8eecd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita @@ -44,7 +44,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..5fda064d68a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita @@ -33,7 +33,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
          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..c04335d1739 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita @@ -51,7 +51,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..ee9c8db8719 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita @@ -43,7 +43,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..7caa54e7d17 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita @@ -45,7 +45,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..3334143fc21 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita @@ -37,7 +37,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita index 341e28b20fd..d25b5fab53c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita @@ -21,13 +21,13 @@ public abstract int UpdateScreenCapture(ScreenCaptureParameters2 captureParams); abstract updateScreenCapture(captureParams: ScreenCaptureParameters2): number; Future<void> updateScreenCapture(ScreenCaptureParameters2 captureParams); -

        +

      Details

      If the system audio is not captured when screen sharing is enabled, and then you want to update the parameter configuration and publish the system audio, you can refer to the following steps:

        -
      1. Call this method, and set captureAudio to .
      2. -
      3. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.
      4. +
      5. Call this method, and set captureAudio to .
      6. +
      7. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.

        @@ -46,13 +46,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.
          -
        • +
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index 9a817e0cbbb..3a520e6eda5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -27,7 +27,7 @@ ): number; Future<void> updateScreenCaptureParameters( ScreenCaptureParameters captureParams); -

      +

    Details @@ -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.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita index 896e8791aca..bef6563bd47 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita @@ -20,7 +20,7 @@ public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); abstract updateScreenCaptureRegion(regionRect: Rectangle): number; Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

        +

    Details @@ -47,8 +47,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_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita index 244f2c06b6b..fc6fefae487 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita @@ -1,26 +1,26 @@ - <ph keyref="updateScreenCaptureRegion2" /> + <ph keyref="updateScreenCaptureRegion2"/> Updates the screen capturing region. - +

      - + - (int)updateScreenCaptureRegion:(CGRect)rect; virtual int updateScreenCaptureRegion(const Rect* rect) = 0; abstract updateScreenCaptureRegion(regionRect: Rectangle): number; public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); - + Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

      +

      Parameters @@ -28,15 +28,15 @@ rect regionRect - The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
      - <ph keyref="return-section-title" /> -

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

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

      When the method call succeeds, there is no return value; when fails, the exception is thrown, and you need to catch the exception and handle it accordingly. 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..c1482ca2e5b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita @@ -43,7 +43,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
        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..205f9b46888 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita @@ -61,7 +61,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
        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..b2a7ac349c8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita @@ -72,7 +72,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..53f84b1e100 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita @@ -68,7 +68,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..c1e4336d146 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita @@ -32,7 +32,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..56b961970d6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita @@ -66,7 +66,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..6756aac446d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita @@ -36,7 +36,7 @@
      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.

      +

      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 uploads 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.
    @@ -57,7 +57,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..79e63b725ec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita @@ -66,7 +66,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..a77920e2d5f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita @@ -65,7 +65,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..130c15b6ac1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita @@ -70,7 +70,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..f39229ae899 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita @@ -59,7 +59,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..fadefcffe8f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita @@ -53,7 +53,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..ee2a89dcfd9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita @@ -53,7 +53,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..6cbff26b07a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita @@ -56,7 +56,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..b26bf7c4423 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita @@ -61,7 +61,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..e57a6796f8e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita @@ -65,7 +65,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..78661274895 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita @@ -36,7 +36,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..2909df7b0ff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita @@ -37,7 +37,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..f56a3ebc47a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita @@ -69,7 +69,7 @@ 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.

    +

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

    • 0: Success.
    • < 0: Failure. See for details and resolution suggestions.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 7b0fb1c0049..e6c1ff60995 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamModeEx" /> + <ph keyref="setDualStreamModeEx"/> Sets the dual-stream mode on the sender side. - + @@ -32,11 +32,11 @@ streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number; - Future<void> setDualStreamModeEx( + Future<void> setDualStreamModeEx( {required SimulcastStreamMode mode, required SimulcastStreamConfig streamConfig, required RtcConnection connection}); -

      +

    Details @@ -46,10 +46,10 @@
    v4.0.1
    -

    The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as ().
    • -
    • When calling this method and setting mode to , it has the same effect as ().
    • +

      The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as ().
      • +
      • When calling this method and setting mode to , it has the same effect as ().
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -57,23 +57,23 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. 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_setremoterendermodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita index cb89e26378a..0c426d02a0b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita @@ -81,7 +81,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..2a32e7a91b1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita @@ -65,7 +65,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..6a406aaa1fd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita @@ -75,7 +75,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..83050fea1b7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita @@ -52,7 +52,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..9f10316a8dc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita @@ -54,7 +54,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..7644e116d67 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita @@ -52,7 +52,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..68fade15516 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita @@ -52,7 +52,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index 5975b307f28..4a93bc66920 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita @@ -28,7 +28,7 @@ ): number; Future<void> setupRemoteVideoEx( {required VideoCanvas canvas, required RtcConnection connection}); -

      +

    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_irtcengineex_setvideoencoderconfigurationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita index 01d4f31d67b..4720ea20eac 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita @@ -30,7 +30,7 @@ Future<void> setVideoEncoderConfigurationEx( {required VideoEncoderConfiguration config, required RtcConnection connection}); -

    +

    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_irtcengineex_startchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita index 74af9bcb24a..970a3cb4174 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelayEx" /> + <ph keyref="startChannelMediaRelayEx"/> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;
    - Future<void> startChannelMediaRelayEx( + Future<void> startChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

    +

    Details @@ -39,16 +39,16 @@
    This method is deprecated. Use instead.
    -

    After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

      -
    • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
    • -
    • If the callback returns (3), an exception occurs during the media stream relay.
    • +

      After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

        +
      • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
      • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
      • -
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
      • -
      • The relaying media streams across channels function needs to be enabled by contacting .
      • +
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
      • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -58,16 +58,16 @@ 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.
        @@ -78,4 +78,4 @@
    - \ 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..27438ae184d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita @@ -45,7 +45,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index 20723ed2831..39f9bbb614a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelayEx" /> + <ph keyref="startOrUpdateChannelMediaRelayEx"/> Starts relaying media streams across channels or updates channels for media relay. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number; - Future<void> startOrUpdateChannelMediaRelayEx( + Future<void> startOrUpdateChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

      +

    Details @@ -39,15 +39,15 @@
    v4.2.0

    The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

    -

    After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

      -
    • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
    • -
    • If the callback returns (3), an exception occurs during the media stream relay.
    • +

      After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

        +
      • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
      • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
      • -
      • The relaying media streams across channels function needs to be enabled by contacting .
      • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -57,16 +57,16 @@ 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.
        @@ -77,4 +77,4 @@
    - \ 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..2819f0824c7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita @@ -71,7 +71,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
        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..e565a44d5c3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita @@ -41,7 +41,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..ab9f15ad0ad 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita @@ -40,7 +40,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..d41b0a8c2a8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita @@ -62,7 +62,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..f5dbd0df7da 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita @@ -58,7 +58,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..4f65566354e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita @@ -51,7 +51,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..75610109d7b 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita @@ -38,7 +38,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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.
    • 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..140f1da0c54 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita @@ -39,7 +39,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return 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. 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.
    • 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..7d92e797203 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita @@ -13,8 +13,8 @@

      - - + + virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract setDevice(deviceIdUTF8: string): number; public abstract int SetDevice(string deviceIdUTF8); @@ -40,7 +40,7 @@

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

      When the method call succeeds, there is no return 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.
      • 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..b32bebf6ebb 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita @@ -36,7 +36,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • 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..d4d64c18481 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita @@ -24,7 +24,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita index 9c09b13306b..c59e7504f6b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita @@ -41,7 +41,7 @@
      <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return 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.
      • diff --git a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita index dd5dd1d85b1..e525de38ce2 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita @@ -1,8 +1,8 @@ - <ph keyref="ContentInspectModule" /> - A structure used to configure the frequency of video screenshot and upload. + <ph keyref="ContentInspectModule"/> + A structure used to configure the frequency of video screenshot and upload.

        @@ -56,19 +56,19 @@ final ContentInspectType? type; @JsonKey(name: 'interval') final int? interval; - factory ContentInspectModule.fromJson(Map<String, dynamic> json) => + factory ContentInspectModule.fromJson(Map<String, dynamic> json) => _$ContentInspectModuleFromJson(json); - Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); + Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); } -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> type - Types of functional module. See . + Types of functional module. See .

        Types of functional modules:

        • (0): (Default) This module has no actual function. Do not set to this value.
        • @@ -84,4 +84,4 @@
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/enum_featuretype.dita b/en-US/dita/RTC-NG/API/enum_featuretype.dita index f9d371f9994..298c444fca2 100644 --- a/en-US/dita/RTC-NG/API/enum_featuretype.dita +++ b/en-US/dita/RTC-NG/API/enum_featuretype.dita @@ -2,7 +2,7 @@ <ph keyref="FeatureType"/> - The name of the advanced feature. + The type of the advanced feature.
        From 9f4a78231ccd87a85aebd4cf3785f60aa54b8951 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 26 Sep 2023 15:02:23 +0800 Subject: [PATCH 2/6] New translations --- en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita | 2 +- .../API/api_iaudiodevicemanager_followsystemloopbackdevice.dita | 2 +- .../API/api_iaudiodevicemanager_followsystemplaybackdevice.dita | 2 +- .../api_iaudiodevicemanager_followsystemrecordingdevice.dita | 2 +- .../RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita | 2 +- .../RTC-NG/API/api_iaudiodevicemanager_setplaybackdevice.dita | 2 +- .../API/api_iaudiodevicemanager_setplaybackdevicemute.dita | 2 +- .../API/api_iaudiodevicemanager_setplaybackdevicevolume.dita | 2 +- .../RTC-NG/API/api_iaudiodevicemanager_setrecordingdevice.dita | 2 +- .../API/api_iaudiodevicemanager_setrecordingdevicemute.dita | 2 +- .../API/api_iaudiodevicemanager_setrecordingdevicevolume.dita | 2 +- .../api_iaudiodevicemanager_startaudiodeviceloopbacktest.dita | 2 +- .../API/api_iaudiodevicemanager_startplaybackdevicetest.dita | 2 +- .../API/api_iaudiodevicemanager_startrecordingdevicetest.dita | 2 +- .../api_iaudiodevicemanager_stopaudiodeviceloopbacktest.dita | 2 +- .../API/api_iaudiodevicemanager_stopplaybackdevicetest.dita | 2 +- .../API/api_iaudiodevicemanager_stoprecordingdevicetest.dita | 2 +- .../api_ibasespatialaudioengine_muteallremoteaudiostreams.dita | 2 +- .../API/api_ibasespatialaudioengine_mutelocalaudiostream.dita | 2 +- .../API/api_ibasespatialaudioengine_muteremoteaudiostream.dita | 2 +- .../API/api_ibasespatialaudioengine_setaudiorecvrange.dita | 2 +- .../RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita | 2 +- .../API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita | 2 +- .../API/api_ibasespatialaudioengine_setplayerattenuation.dita | 2 +- en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita | 2 +- .../api_ibasespatialaudioengine_updateplayerpositioninfo.dita | 2 +- .../API/api_ibasespatialaudioengine_updateselfposition.dita | 2 +- .../API/api_ilocalspatialaudioengine_clearremotepositions.dita | 2 +- .../RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita | 2 +- .../API/api_ilocalspatialaudioengine_removeremoteposition.dita | 2 +- .../api_ilocalspatialaudioengine_setremoteaudioattenuation.dita | 2 +- .../API/api_ilocalspatialaudioengine_updateremoteposition.dita | 2 +- .../RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita | 2 +- .../dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita | 2 +- .../RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita | 2 +- .../API/api_imediaengine_registervideoencodedframeobserver.dita | 2 +- .../RTC-NG/API/api_imediaengine_registervideoframeobserver.dita | 2 +- .../dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita | 2 +- .../RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita | 2 +- .../RTC-NG/API/api_imediaengine_setexternalvideosource.dita | 2 +- .../API/api_imediaengine_unregisteraudioframeobserver.dita | 2 +- .../api_imediaengine_unregistervideoencodedframeobserver.dita | 2 +- .../API/api_imediaengine_unregistervideoframeobserver.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita | 2 +- .../RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita | 2 +- .../RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_open.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_play.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita | 2 +- .../API/api_imediaplayer_registeraudioframeobserver2.dita | 2 +- .../API/api_imediaplayer_registerplayersourceobserver.dita | 2 +- .../RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita | 2 +- .../dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita | 2 +- .../dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita | 2 +- .../dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita | 2 +- .../RTC-NG/API/api_imediaplayer_switchagoracdnlinebyindex.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnsrc.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita | 2 +- en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita | 2 +- .../API/api_imediaplayer_unregisteraudioframeobserver.dita | 2 +- .../API/api_imediaplayer_unregisterplayersourceobserver.dita | 2 +- .../API/api_imediaplayer_unregistervideoframeobserver.dita | 2 +- .../API/api_imediaplayercachemanager_removeallcaches.dita | 2 +- .../RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita | 2 +- en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita | 2 +- en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_addinjectstreamurl.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita | 2 +- .../API/api_irtcengine_adjustaudiomixingplayoutvolume.dita | 2 +- .../API/api_irtcengine_adjustaudiomixingpublishvolume.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita | 2 +- .../API/api_irtcengine_adjustcustomaudioplayoutvolume.dita | 2 +- .../API/api_irtcengine_adjustcustomaudiopublishvolume.dita | 2 +- .../RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita | 2 +- .../RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita | 2 +- .../RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita | 2 +- .../API/api_irtcengine_adjustuserplaybacksignalvolume.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_complain.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita | 2 +- .../RTC-NG/API/api_irtcengine_disableaudiospectrummonitor.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_disablevideo.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita | 2 +- .../RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita | 2 +- .../RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita | 2 +- .../API/api_irtcengine_enableechocancellationexternal.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita | 2 +- .../RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_enableloopbackrecording.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita | 2 +- .../RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita | 2 +- .../API/api_irtcengine_enablesoundpositionindication.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita | 2 +- .../RTC-NG/API/api_irtcengine_enablewebsdkinteroperability.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita | 2 +- .../RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita | 2 +- .../RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita | 2 +- .../RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita | 2 +- .../RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita | 2 +- .../RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_pausealleffects.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_pauseeffect.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_rate.dita | 2 +- .../API/api_irtcengine_registeraudioencodedframeobserver.dita | 2 +- .../API/api_irtcengine_registeraudiospectrumobserver.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita | 2 +- .../RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita | 2 +- .../API/api_irtcengine_registermediametadataobserver.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita | 2 +- .../RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita | 2 +- .../RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita | 2 +- .../RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita | 2 +- .../API/api_irtcengine_setaudiosessionoperationrestriction.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita | 2 +- .../api_irtcengine_setcameraautoexposurefacemodeenabled.dita | 2 +- .../API/api_irtcengine_setcameraautofocusfacemodeenabled.dita | 2 +- .../API/api_irtcengine_setcameracapturerconfiguration.dita | 2 +- .../RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita | 2 +- .../RTC-NG/API/api_irtcengine_setcameraexposureposition.dita | 2 +- .../API/api_irtcengine_setcamerafocuspositioninpreview.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita | 2 +- .../API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita | 2 +- .../API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita | 2 +- .../API/api_irtcengine_setdefaultmuteallremotevideostreams.dita | 2 +- .../api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita | 2 +- .../api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita | 2 +- .../api_irtcengine_setearmonitoringaudioframeparameters.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita | 2 +- .../RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita | 2 +- .../RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita | 2 +- .../RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita | 2 +- .../API/api_irtcengine_setlocalpublishfallbackoption.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita | 2 +- .../RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita | 2 +- .../RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita | 2 +- .../RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita | 2 +- ..._irtcengine_setplaybackaudioframebeforemixingparameters.dita | 2 +- .../API/api_irtcengine_setplaybackaudioframeparameters.dita | 2 +- .../API/api_irtcengine_setrecordingaudioframeparameters.dita | 2 +- .../API/api_irtcengine_setremotedefaultvideostreamtype.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita | 2 +- .../API/api_irtcengine_setremotesubscribefallbackoption.dita | 2 +- .../API/api_irtcengine_setremoteuserspatialaudioparams.dita | 2 +- .../RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita | 2 +- .../API/api_irtcengine_setremotevideosubscriptionoptions.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita | 2 +- .../RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita | 2 +- .../RTC-NG/API/api_irtcengine_setscreencapturescenario.dita | 2 +- .../RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita | 2 +- .../RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita | 2 +- .../RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita | 2 +- .../RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita | 2 +- .../RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita | 2 +- .../RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita | 2 +- .../RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita | 2 +- .../RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita | 2 +- .../RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita | 2 +- .../RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita | 2 +- .../API/api_irtcengine_startorupdatechannelmediarelay.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita | 2 +- .../API/api_irtcengine_startrtmpstreamwithtranscoding.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita | 2 +- .../API/api_irtcengine_startscreencapturebydisplayid.dita | 2 +- .../API/api_irtcengine_startscreencapturebyscreenrect.dita | 2 +- .../RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita | 2 +- .../RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita | 2 +- .../API/api_irtcengine_unregisteraudioencodedframeobserver.dita | 2 +- .../RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita | 2 +- .../API/api_irtcengine_unregisteraudiospectrumobserver.dita | 2 +- .../API/api_irtcengine_unregistermediametadataobserver.dita | 2 +- .../RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita | 2 +- .../dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita | 2 +- .../API/api_irtcengine_updatelocaltranscoderconfiguration.dita | 2 +- .../RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita | 2 +- .../API/api_irtcengine_updatescreencaptureparameters.dita | 2 +- .../RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita | 2 +- .../RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita | 2 +- .../dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita | 2 +- .../API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita | 2 +- .../dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita | 2 +- .../API/api_irtcengineex_enableaudiovolumeindicationex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita | 2 +- .../API/api_irtcengineex_muteallremoteaudiostreamsex.dita | 2 +- .../API/api_irtcengineex_muteallremotevideostreamsex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita | 2 +- .../API/api_irtcengineex_pauseallchannelmediarelayex.dita | 2 +- .../API/api_irtcengineex_resumeallchannelmediarelayex.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita | 2 +- .../dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita | 2 +- .../API/api_irtcengineex_setsubscribeaudioallowlistex.dita | 2 +- .../API/api_irtcengineex_setsubscribeaudioblocklistex.dita | 2 +- .../API/api_irtcengineex_setsubscribevideoallowlistex.dita | 2 +- .../API/api_irtcengineex_setsubscribevideoblocklistex.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita | 2 +- .../API/api_irtcengineex_setvideoencoderconfigurationex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita | 2 +- .../API/api_irtcengineex_startmediarenderingtracingex.dita | 2 +- .../API/api_irtcengineex_startorupdatechannelmediarelayex.dita | 2 +- .../API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita | 2 +- en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita | 2 +- .../RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita | 2 +- en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita | 2 +- .../API/api_ivideodevicemanager_numberofcapabilities.dita | 2 +- en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita | 2 +- .../RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita | 2 +- .../dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita | 2 +- ...ack_irtcengineeventhandler_onaudiomixingpositionchanged.dita | 2 +- 350 files changed, 350 insertions(+), 350 deletions(-) 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 771db37a497..d97eff7ab46 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 4939137b67c..6d1308014d7 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita @@ -45,7 +45,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 928774bac60..5c711b901e2 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemplaybackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemplaybackdevice.dita @@ -38,7 +38,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 00b3d7751d9..9f2364da82e 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemrecordingdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemrecordingdevice.dita @@ -37,7 +37,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 66cdb6b17dc..6ea343ed86e 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita @@ -54,7 +54,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 71519470e52..cfed86777a6 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevice.dita @@ -40,7 +40,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 b5fbfdefa8a..efdc041b265 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicemute.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicemute.dita @@ -37,7 +37,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 0ccba949562..518e163f9ed 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicevolume.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setplaybackdevicevolume.dita @@ -32,7 +32,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 080eba4334a..08d1cc1f5ea 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevice.dita @@ -40,7 +40,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 bb850a2db45..8663c82b95d 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicemute.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicemute.dita @@ -37,7 +37,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 269295214e3..3a5a6dd7223 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 b1f90f166d3..54f4b7ff9f8 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startaudiodeviceloopbacktest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startaudiodeviceloopbacktest.dita @@ -43,7 +43,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 0763a6a5018..e0cb329b2e1 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startplaybackdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startplaybackdevicetest.dita @@ -44,7 +44,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 dd0471eaa3e..cabfee00c66 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startrecordingdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_startrecordingdevicetest.dita @@ -41,7 +41,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 0db282a7a30..bf33aadccf6 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopaudiodeviceloopbacktest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopaudiodeviceloopbacktest.dita @@ -33,7 +33,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 bc34ff352f3..2d8fb181390 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopplaybackdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stopplaybackdevicetest.dita @@ -29,7 +29,7 @@
        • 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.

        +

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

        • 0: Success.
        • < 0: Failure. See for details and resolution suggestions.
        • 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 e2636a3c8cc..96cfc61f3c2 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stoprecordingdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_stoprecordingdevicetest.dita @@ -33,7 +33,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 32ceb814490..9a48e7034cc 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteallremoteaudiostreams.dita @@ -46,7 +46,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 dc4c5b23762..da571d6db49 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_mutelocalaudiostream.dita @@ -46,7 +46,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 d09fdc8df7c..a51dce106bb 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_muteremoteaudiostream.dita @@ -57,7 +57,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 a887e9d53a1..c63509414c6 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setaudiorecvrange.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setaudiorecvrange.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 1cdbcd9abd5..2dde4279277 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setdistanceunit.dita @@ -37,7 +37,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 6bc3e9e1158..5448151311f 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setmaxaudiorecvcount.dita @@ -39,7 +39,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 9234d6b74b4..15dc182e461 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setplayerattenuation.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setplayerattenuation.dita @@ -71,7 +71,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 45ca5a33077..74dd8c1e13f 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita @@ -52,7 +52,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita index d1d8ad2b3d8..d39782b61b8 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita @@ -47,7 +47,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 a62b020ae47..e14995bd92b 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita @@ -74,7 +74,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 7810bc036d0..95762b621df 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_clearremotepositions.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_clearremotepositions.dita @@ -29,7 +29,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita index c6ced75f3a6..c535e0b3930 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita @@ -41,7 +41,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 fac2ce1858c..0940d3f18ea 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita @@ -37,7 +37,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 27f3e0fe488..5d8a979ef52 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_setremoteaudioattenuation.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_setremoteaudioattenuation.dita @@ -66,7 +66,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita index 5605cd9c3d1..c88449f8031 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita @@ -47,7 +47,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 30fe31e7508..930529a15b9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita @@ -41,7 +41,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 fbaff3d47a3..ae043251c43 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pullaudioframe.dita @@ -55,7 +55,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita index 0b9eef05b58..67b8b41e30f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita index 98e00deb9ee..3089be0921a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita @@ -67,7 +67,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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: Pushes the external encoded video frame to the SDK successfully.
        • < 0: Fails to push external encoded video frames to the SDK.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index 78a0809cae5..817e0b960b9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -60,7 +60,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index 99b2028c298..6306b54e451 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita @@ -55,7 +55,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index dbd08f548af..a7dbcb2910f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -61,7 +61,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index 1436175f306..7336c0710fd 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -60,7 +60,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 a4404a0f9fc..162d02dce03 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita @@ -70,7 +70,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 9c595e19cb0..d9e67e44483 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosource2.dita @@ -97,7 +97,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 62d9f50c30d..2285a5f3e1b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita @@ -71,7 +71,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 4f264d5042a..d4272b90353 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita @@ -32,7 +32,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 68fcb1da0d9..3b6ec560f74 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 c965a628b0e..79d0537bf66 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita @@ -32,7 +32,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 c83e1aa29fe..f94c926c196 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita @@ -35,7 +35,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 8d64333e453..fd4c70570d1 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita @@ -40,7 +40,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 a675117dc3f..6c4f785fdc3 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_enableautoswitchagoracdn.dita @@ -41,7 +41,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 bcb0eade1ac..5784b65738f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 56705c2e71d..4c646236b48 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita @@ -47,7 +47,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 c3d4ae32ea3..b77f4a62e74 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithagoracdnsrc.dita @@ -55,7 +55,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 8f6f4b6359f..46ea80348fb 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 bb4f5052505..0d6fa5cff7d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita @@ -26,7 +26,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 e160ee3fa71..ed8a27fc819 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita @@ -28,7 +28,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 0639cd15856..32c36559728 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita @@ -42,7 +42,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 d6af7dd76d5..d162df568c4 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita @@ -47,7 +47,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 506694fc119..6dbe99edb9a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita @@ -57,7 +57,7 @@
        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.
        • 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 36f68da9fb4..5e53d71a153 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita @@ -38,7 +38,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita index 3bb2ce27f44..265f22f4008 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita @@ -42,7 +42,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 9bec30b6d73..cb96cc9e62b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_renewagoracdnsrctoken.dita @@ -46,7 +46,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 d9309656994..24c4f41fdc7 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita @@ -24,7 +24,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 71162bcb91c..b572c5a1cdd 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita @@ -43,7 +43,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 dd0bfe1a054..84caca8440f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita @@ -36,7 +36,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 8248c99359c..df234c1d1ee 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita @@ -45,7 +45,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 88861cce73d..279e86ea10e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita @@ -35,7 +35,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 86aa29a372a..bcff0820b19 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita @@ -39,7 +39,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 eb3bd380a3a..301cfeec22c 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita @@ -40,7 +40,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 e06c781ae41..8164b7ce901 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita @@ -45,7 +45,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index 9cdc02c029c..4f26670ac9b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita @@ -40,7 +40,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita index 33c42d6f5f6..d1d7c3bcf2b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita @@ -38,7 +38,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 70eb30f117b..2e6a1eb4f1e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita @@ -35,7 +35,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 9920a20170f..ead19837ebe 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita @@ -25,7 +25,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 45a68a85112..4696e50bb3d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnlinebyindex.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnlinebyindex.dita @@ -43,7 +43,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 8d71afe9089..3dda48e5aa6 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchagoracdnsrc.dita @@ -56,7 +56,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 ba9ffa45856..3cf1b00c7c7 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita @@ -61,7 +61,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 ab9b4bde5a3..ba648826e1c 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita @@ -42,7 +42,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 14beeaa0b04..50434487a54 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregisteraudioframeobserver.dita @@ -32,7 +32,7 @@
        <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return 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.
        • 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 0b827534755..d831a1ab374 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita @@ -29,7 +29,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 bcded9d6ec2..0546a76a2d4 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita @@ -36,7 +36,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 8a86c20dd5c..e441a33bc12 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita @@ -29,7 +29,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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 .
          • 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 05942dced56..9bde286d5f1 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita @@ -43,7 +43,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita index 5678d5a4a2c..71e7e039395 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 e7643b61ab9..21021cead23 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_stoprecording.dita @@ -27,7 +27,7 @@ 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.

          +

          When the method call succeeds, there is no return value; when fails, the 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_addhandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita index 6504b487b88..3bef3c98b9b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita @@ -41,7 +41,7 @@ Otherwise, the SDK may not work properly.

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

          When the method call succeeds, there is no return 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.
          • 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 ccdf4564155..bd234ea3536 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addinjectstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addinjectstreamurl.dita @@ -54,7 +54,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 cedf3e850ee..494ccead409 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 31c097246b4..0cd95ed4af7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark.dita @@ -51,7 +51,7 @@ 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.

          +

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

          • 0: Success.
          • < 0: Failure. See for details and resolution suggestions.
          • 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 410e60e1bda..4594dd5933e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addvideowatermark2.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c1291f4f744..7dca3b5eb68 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingplayoutvolume.dita @@ -35,7 +35,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 6f15e355524..d03a7cda650 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingpublishvolume.dita @@ -38,7 +38,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f21f8813432..b12e8216b51 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustaudiomixingvolume.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 a74f6f9b955..50e6b3347c9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudioplayoutvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudioplayoutvolume.dita @@ -48,7 +48,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 1eefbf053e3..89faf1a6700 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita @@ -48,7 +48,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 be7ab62aab5..55cf9d47653 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita @@ -37,7 +37,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 56161470a54..b3bea1cdb03 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustplaybacksignalvolume.dita @@ -39,7 +39,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 b1268b9b775..4d8aad6ef23 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita @@ -43,7 +43,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c084aaccbf9..ceffe8589c4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita @@ -45,7 +45,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 65d26da6333..d4f77afa504 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita @@ -24,7 +24,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f4b1d9a1751..fb8c4d00a00 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_complain.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_complain.dita @@ -41,7 +41,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 5039f14b2cd..1d99052821f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita @@ -37,7 +37,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 a5df029d63d..1513387a75c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita @@ -34,7 +34,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 3dc1f2fe099..48c2d6ab3dd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita @@ -37,7 +37,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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. Returns the ID of media player instance.
          • < 0: Failure. See for details and resolution suggestions.
          • 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 efddbb0912d..8fe5311153b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudio.dita @@ -36,7 +36,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 1da3315c6f8..413bddb90c8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disableaudiospectrummonitor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disableaudiospectrummonitor.dita @@ -30,7 +30,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 345388922df..da330d1f56a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disablevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disablevideo.dita @@ -38,7 +38,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 81f8990edeb..e445f10b35a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudio.dita @@ -38,7 +38,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 73afb6e2052..3f01de778da 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiospectrummonitor.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 077e8d60d2a..f112e96392d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableaudiovolumeindication.dita @@ -62,7 +62,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 6392d1a93c7..7c362505575 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita index 13146048862..5ff70d41a58 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 bb9f0bdf834..e56b20a3a65 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita @@ -54,7 +54,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index 92eb92473f8..9c5a105c18c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 c251a90c24a..cacb35348a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita @@ -78,7 +78,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 91f708acda3..44fb6fe65a8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 30acf9c35b2..8384b00a036 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
            • - 8: Make sure the current audio routing is Bluetooth or headset.
            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 0ac3ee36ecd..02d8dc461d9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita @@ -42,7 +42,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 41e486236df..9ac5fbac48a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita @@ -51,7 +51,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 54e3c98f975..2d32d242c45 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalvideo.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c28c6d3e593..8e876eeb8fa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableloopbackrecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableloopbackrecording.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita index 923eacd90d1..e165e6bc38a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita @@ -81,7 +81,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 6624d94290b..98f6c994a6a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita @@ -85,7 +85,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 cc0fd34e76f..256dfb4b5eb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablesoundpositionindication.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablesoundpositionindication.dita @@ -39,7 +39,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 a0653658c82..97051f4388e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablespatialaudio.dita @@ -44,7 +44,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 e1ee0a0e3c2..9a7607f1009 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideo.dita @@ -39,7 +39,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 7b5c63e150e..301d69f1840 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevideoimagesource.dita @@ -53,7 +53,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 66b7af24129..be2ad36ebed 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -97,7 +97,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 9d18c770917..2ce2c1c8e53 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablewebsdkinteroperability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablewebsdkinteroperability.dita @@ -46,7 +46,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita index 51d1f0f9c92..d962196b1d8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -51,7 +51,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.

          • The instance, if the method call succeeds.
          • 0: Success.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index 46ac7c36634..99abe864cf4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -92,7 +92,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 927cfda5c83..4b4b33b4b5d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita @@ -76,7 +76,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 3d6cca42856..d26dd74fb48 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita @@ -89,7 +89,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 6c294b6c458..462364d2bff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel.dita @@ -48,7 +48,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 5eea6456fe1..50abae34a60 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita @@ -46,7 +46,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 e5c2d47dc79..5f3871b5d95 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita @@ -54,7 +54,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 046b6b593cb..2d9730251c0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 407409602a2..925c9b5464c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremotevideostreams.dita @@ -46,7 +46,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 2760a380df7..27fcd992bc4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalaudiostream.dita @@ -42,7 +42,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 5aef6dbac02..799e380b36d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_mutelocalvideostream.dita @@ -46,7 +46,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f094da530aa..6416cd973b1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muterecordingsignal.dita @@ -39,7 +39,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f466a644992..9295baa383f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita @@ -50,7 +50,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 b1e4fcbe564..a6d104b861f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita @@ -51,7 +51,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 50d0190c730..4913b295ab6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita @@ -28,7 +28,7 @@ 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.

          +

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

          • 0: Success.
          • < 0: Failure. See for details and resolution suggestions.
          • 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 2cc99c78583..80ab9053797 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pausealleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pausealleffects.dita @@ -26,7 +26,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 cb08c74ae2b..3b77ee921e3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pauseaudiomixing.dita @@ -28,7 +28,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 7cec9ff396f..4babf87f36b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pauseeffect.dita @@ -32,7 +32,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f835247c06e..74734a51abb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita @@ -86,7 +86,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 695f8cb98b2..fd88ecfec1e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita @@ -129,7 +129,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index 322dd21d1b0..a140c6d0daf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -75,7 +75,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 e9ec3bb2f02..8a6ad5ed362 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita @@ -69,7 +69,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 6184390dd50..99bb1ce243a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita @@ -66,7 +66,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c51ee383c86..d7247994b65 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita @@ -44,7 +44,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita index 7ea527829ad..3aff9269f23 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita @@ -45,7 +45,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 85da53860e4..ea9fbe47661 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita @@ -50,7 +50,7 @@ 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.

          +

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

          • 0: Success.
          • < 0: Failure. See for details and resolution suggestions.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita index e4a65e775e4..1d02bd7d0e5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita @@ -58,7 +58,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita index d0a5b0bf066..2fd9148d87d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita @@ -45,7 +45,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 36ca390af74..40e3cb8ce38 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita @@ -63,7 +63,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 fc2edf8c9b3..5e5a822f589 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index af9c5b16819..ae14605bec9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita index d7f21a93df8..377d7e71c80 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita @@ -41,7 +41,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.

          • : Success.
          • : Failure. See for details and resolution suggestions.
          • 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 68b150673e9..4629c00bf3e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita @@ -37,7 +37,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 caa1e695764..853fd56de34 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita @@ -48,7 +48,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 ed09f99aa85..cd5a9e70514 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita @@ -37,7 +37,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 d63d59eafbe..e00e323b43d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita @@ -28,7 +28,7 @@ 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.

          +

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

          • 0: Success.
          • < 0: Failure. See for details and resolution suggestions.
          • 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 0ec6af5ad86..613c8306cb0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita @@ -26,7 +26,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 dbb4d533ae2..626b834bc08 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita @@ -28,7 +28,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 cdddeebe685..603de49a1ca 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita @@ -34,7 +34,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 7b02e7a25ad..b844a6e7536 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita @@ -41,7 +41,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita index e0312cb2de3..db84b53b771 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita @@ -43,7 +43,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 0f2d3292a9e..b374d1fec24 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita @@ -63,7 +63,7 @@ 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.

          +

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

          • 0: Success.
          • < 0: Failure. See for details and resolution suggestions.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita index 9718eed03f2..3f63744d977 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita @@ -36,7 +36,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 88320634bd9..14e288ca914 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita @@ -65,7 +65,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 63aec2b70f4..5731fcd40a3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita @@ -102,7 +102,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 91ddbd9f53f..d989e44a1c0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita @@ -78,7 +78,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index e2c710dacd0..87cbe321767 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 b259bc606f4..3aa7e89242e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita @@ -36,7 +36,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 1b6e4dc2ddd..6c44d9eb3dc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita @@ -36,7 +36,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 fb4fe7d4d57..19988de4dc5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita @@ -74,7 +74,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 9e2cf68808e..ebe21a4d5a0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita @@ -44,7 +44,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 aaef8c5acd1..4e409403b01 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita @@ -44,7 +44,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f23540bf95c..2f05040f8ff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 3cbfac78745..5b1504f900d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita @@ -65,7 +65,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 66bc4f8c765..353dc3e95a8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 7f8d3aa13e3..45378234378 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita @@ -49,7 +49,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c819f44e51e..0d00826dfb3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita @@ -44,7 +44,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 0d46c1456a0..2d67eff7558 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita @@ -54,7 +54,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 b30d846f626..25a8c3ab4b3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita @@ -56,7 +56,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 d14c0b94c48..0adac17a02e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita @@ -56,7 +56,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 7f2ac3edc84..d5b4176ac22 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita @@ -56,7 +56,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 18ca6834c17..a7067350b90 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita @@ -45,7 +45,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 42295356e4b..efed0ab66a7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita @@ -41,7 +41,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.

          • The camera zoom factor value, if successful.
          • < 0: if the method if failed.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita index ea6d1bd086f..1179f56b951 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita @@ -60,7 +60,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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(ERR_OK): Success.
          • < 0: Failure.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita index 7120571cdc3..dbe107f97b5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -62,7 +62,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 fbc7ebb48fd..5c784f186fc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita index 7d118bb16cc..f2d5491b62f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita @@ -72,7 +72,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 33677524ea5..33c5966ea52 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 61e048bf7ea..dbd11ce3a89 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita @@ -53,7 +53,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 11f65358af1..54e36d90f22 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 ec518aab071..c349e0a32b9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita @@ -42,7 +42,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 05707efd3f1..4cd0fcca6f6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita @@ -44,7 +44,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita index 46e016bcc11..62e3821a2cd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita @@ -65,7 +65,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f7f6e1fd11f..b598cac0e33 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita @@ -80,7 +80,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 dd3eda2cde8..dad6c9c533f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c4565e9dc52..c293caa1519 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita @@ -37,7 +37,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 3e765442e98..4ce86a03d7a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 23361acbc4e..41ec8961cd9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c6693608297..863a749f1ec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita @@ -46,7 +46,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 254d29a3126..02bb5db1745 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita @@ -75,7 +75,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 73f86a83fdd..eb1573f1e78 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 07050d149e0..841d090d1db 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita index 5d00f0a7af1..1d7816d5df6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita @@ -42,7 +42,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 c97df2493d0..8a28db48b24 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita index 0d778d7c653..bea0c1062b7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita @@ -50,7 +50,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita index 101bb5567b6..e42bbe4b26d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita index 7648e5ecc03..43c5e906b59 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita @@ -44,7 +44,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita index 06715206d69..382f44434f0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita @@ -59,7 +59,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index 27b2ee7cde7..0359b740d7e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -70,7 +70,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita index f124d7af263..436c98bb8a0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita @@ -50,7 +50,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 d4950dccfa0..4c0206a7fe5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita @@ -50,7 +50,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 e5fbb184f1f..507e51d325d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita @@ -43,7 +43,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 8b7bd43d311..cdbabedbe81 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita @@ -35,7 +35,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 ea8e650f119..bf14c41e91b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita @@ -48,7 +48,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 cba0c3b46a7..80965a3119d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita @@ -44,7 +44,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 df9782ba795..929b0904df9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita @@ -58,7 +58,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 8a07157f44b..99dae0f6f92 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 507264f3a09..026c78cdcda 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita @@ -43,7 +43,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita index 6c9ceba53d4..eb5b49f5ce6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita @@ -72,7 +72,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 3b3172a8b09..5ed3f2d3c95 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita @@ -36,7 +36,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 9e5851947c3..9e32349fd66 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita @@ -66,7 +66,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 d755134e3ce..b0c8fb9b316 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita @@ -49,7 +49,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 814b8ba885b..30149030c35 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita @@ -50,7 +50,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c31a29cb219..e4fd1db0458 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita @@ -82,7 +82,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 3afb8eed64b..c97791f7da0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita @@ -90,7 +90,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 4f35f360563..e290f6bd188 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita @@ -48,7 +48,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c8b935ec1aa..9da366f6bca 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita @@ -74,7 +74,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 5e80b66998b..05c086ebab2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita @@ -45,7 +45,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita index b0fff7039b7..8f447d3fe1a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita @@ -49,7 +49,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 44f9ec68f69..68b50bcb620 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita @@ -56,7 +56,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 11c5ed07671..ab0089b9a66 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita @@ -59,7 +59,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 7a0f7922288..d9e5b3f6ea4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita @@ -63,7 +63,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita index 40a0f0055aa..d79ce4737f5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita @@ -38,7 +38,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
            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 c33b1fc297b..2a3eb28533d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita @@ -41,7 +41,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 d3b874bc394..7b4a7018632 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita @@ -57,7 +57,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 2a7242f3aa8..638cfdcff70 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita @@ -57,7 +57,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 b8b5295149c..1019d21db4c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita @@ -56,7 +56,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c9e91609af9..8533ca93c0e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita @@ -57,7 +57,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index d9b7699390c..7f976c8b44e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -43,7 +43,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index 739f94e9775..34b3ebe145b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita index 22d69893533..e2bd1d4e345 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita @@ -72,7 +72,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita index 42fd654b465..c44e8ee5653 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita @@ -46,7 +46,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f889e2401ba..11316726123 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita @@ -75,7 +75,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 30e485d7573..46c4ddd360c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita @@ -75,7 +75,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 ef9976a5083..30fdf732ab4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita @@ -76,7 +76,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 1ec08bc0643..3b951e59d1f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita @@ -62,7 +62,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 3765353d271..f35babf3df4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita @@ -39,7 +39,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 a8e3f4ce85c..035867c10a1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita @@ -86,7 +86,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 0e11947a63d..d5c4b3064c8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita @@ -84,7 +84,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita index 95648b898d0..3fe55ac3479 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index 05004052ff4..a12efd298c8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -63,7 +63,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.

            diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita index a6f6282405c..7e0f909d14e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita @@ -60,7 +60,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita index ffa8e88fa71..ac0eff4bd5b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita @@ -66,7 +66,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 4d2e7d6dcd6..ac170c1e9cc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita @@ -54,7 +54,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 6891701edfb..faa510de4f5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita @@ -48,7 +48,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 779a7d6c63f..65ffe08dc58 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita @@ -64,7 +64,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c420d9fa397..bf7d0f91397 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita @@ -41,7 +41,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita index c55c28f1f6a..ec1ae30871c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita @@ -59,7 +59,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 d89b5168b81..2713bd15961 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita @@ -49,7 +49,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index e8d5d137fb9..df2d1a9093f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -63,7 +63,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 669de4e8f5a..639a2d42539 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita @@ -57,7 +57,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index c0d48993e43..acace31050f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita index dd2ff5143b9..b3acaac3c5f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita @@ -65,7 +65,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.

            diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index fa74234ec9a..0908210de2b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -72,7 +72,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita index 5a9d8db1dbf..d846756b42d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita @@ -66,7 +66,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
            diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita index ad0c03c7b06..58f2d07be9e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita @@ -197,7 +197,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c1932e0133f..9aa82f3e690 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita @@ -26,7 +26,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 35244df9e0c..46b9a4dd316 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita @@ -28,7 +28,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 3f58da3799c..e2c3c95a115 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita @@ -24,7 +24,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 0e00226fb4d..aa1ec791dec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita @@ -45,7 +45,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 8c3b8577a72..d2d5dd51a43 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita @@ -28,7 +28,7 @@ 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.

          +

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

          • 0: Success.
          • < 0: Failure. See for details and resolution suggestions.
          • 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 a0c496fb204..fe5a406f207 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita @@ -21,7 +21,7 @@ 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.

          +

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

          • 0: Success.
          • < 0: Failure. See for details and resolution suggestions.
          • 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 08e1259e410..93c336e3747 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita @@ -24,7 +24,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 245c36999b6..8d98d895bba 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita @@ -34,7 +34,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 a3d67c5ec7e..ada431cbbcc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita @@ -24,7 +24,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 91db1f70da0..e74c4b3c62c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita @@ -29,7 +29,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.

            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 b9185c99c99..9cbd9a90019 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita @@ -45,7 +45,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 760c4a59c97..343521bef2c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita @@ -28,7 +28,7 @@ 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.

          +

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

          • 0: Success.
          • < 0: Failure. See for details and resolution suggestions.
          • 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 33504b682e7..e50375b9f72 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita @@ -38,7 +38,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 b2199a23461..7a3a64e25ca 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita @@ -27,7 +27,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 0ea3cb94cb9..3da20e3e41c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita @@ -46,7 +46,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 d390b53720c..78520cfebc4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita @@ -30,7 +30,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 ce1ca83d3bb..a3477003cf4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita @@ -54,7 +54,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 0784dcbb846..b61c9fbdfac 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita @@ -25,7 +25,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 5578b587c99..97cfec890fa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita @@ -34,7 +34,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita index f4b65943107..25c56c42613 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita @@ -39,7 +39,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 99d5a110ef5..fb890125d46 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita @@ -24,7 +24,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 e1959c54a4d..becf9376921 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita @@ -41,7 +41,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c3072c8eecd..1e6c7b502f6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita @@ -44,7 +44,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 5fda064d68a..38448fe15ed 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita @@ -33,7 +33,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 c04335d1739..afc3c9300cc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita @@ -51,7 +51,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 ee9c8db8719..fe6eb011ae3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita @@ -43,7 +43,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 7caa54e7d17..949adef08c3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita @@ -45,7 +45,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 3334143fc21..5877062bf98 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita @@ -37,7 +37,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita index d25b5fab53c..9079b6d47d2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index 3a520e6eda5..b43a79f1ce3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -47,7 +47,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita index bef6563bd47..af8ccc10121 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita @@ -48,7 +48,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
            diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita index fc6fefae487..f7aaf5269f4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita @@ -33,7 +33,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          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 c1482ca2e5b..08891bd4a70 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita @@ -43,7 +43,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 205f9b46888..68bcc6826f9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 b2a7ac349c8..0faa8586acb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita @@ -72,7 +72,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 53f84b1e100..95b4df55fa7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita @@ -68,7 +68,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 c1e4336d146..d93dea5a48c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita @@ -32,7 +32,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 56b961970d6..1b37b8657bf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita @@ -66,7 +66,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 6756aac446d..5c537620a81 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita @@ -57,7 +57,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 79e63b725ec..11facbb391e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita @@ -66,7 +66,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 a77920e2d5f..9a3e683a788 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita @@ -65,7 +65,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 130c15b6ac1..118d138d1fb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita @@ -70,7 +70,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f39229ae899..3d53a8f7731 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita @@ -59,7 +59,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 fadefcffe8f..098e3cc1eec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita @@ -53,7 +53,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 ee2a89dcfd9..47d306ccea9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita @@ -53,7 +53,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 6cbff26b07a..623b9b66e20 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita @@ -56,7 +56,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 b26bf7c4423..b864b145e41 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita @@ -61,7 +61,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 e57a6796f8e..21bebda58c4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita @@ -65,7 +65,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 78661274895..76a657b6210 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita @@ -36,7 +36,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 2909df7b0ff..260533168c2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita @@ -37,7 +37,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f56a3ebc47a..b584e4bd970 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita @@ -69,7 +69,7 @@ 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.

          +

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

          • 0: Success.
          • < 0: Failure. See for details and resolution suggestions.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index e6c1ff60995..f9a531c43a6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -70,7 +70,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 0c426d02a0b..cb89e26378a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita @@ -81,7 +81,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 2a32e7a91b1..34e47132702 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita @@ -65,7 +65,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 6a406aaa1fd..de12657f295 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita @@ -75,7 +75,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 83050fea1b7..a3aaa878266 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 9f10316a8dc..94d8639762c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita @@ -54,7 +54,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 7644e116d67..91bedf9f5ff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 68fade15516..3ab433c8d92 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita @@ -52,7 +52,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index 4a93bc66920..2dc8b8161d6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita @@ -57,7 +57,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita index 4720ea20eac..1ddbbe434ba 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita @@ -51,7 +51,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita index 970a3cb4174..b9d4e5e12c1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita @@ -67,7 +67,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 27438ae184d..272e710a56f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita @@ -45,7 +45,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index 39f9bbb614a..c48db5d76e8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita @@ -66,7 +66,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 2819f0824c7..a74eb018f7a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita @@ -71,7 +71,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
              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 e565a44d5c3..827d30e7206 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita @@ -41,7 +41,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 ab9f15ad0ad..273acd04a31 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 d41b0a8c2a8..d1e09f82614 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita @@ -62,7 +62,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 f5dbd0df7da..8572bfbad4a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita @@ -58,7 +58,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 4f65566354e..f3a255941da 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita @@ -51,7 +51,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 75610109d7b..b7dad69719a 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita @@ -38,7 +38,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 140f1da0c54..47324e5094b 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita @@ -39,7 +39,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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. 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.
          • 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 7d92e797203..690f5f777ec 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita @@ -40,7 +40,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 b32bebf6ebb..84102533e12 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita @@ -36,7 +36,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • 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 d4d64c18481..295cae2b8b3 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita @@ -24,7 +24,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita index c59e7504f6b..9c09b13306b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita @@ -41,7 +41,7 @@
          <ph keyref="return-section-title"/> -

          When the method call succeeds, there is no return 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.
          • From f3c4d1fc56a0bfe585732d58624a0a86027831ec Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 26 Sep 2023 15:10:27 +0800 Subject: [PATCH 3/6] New translations --- ...onfiguration_getdestchannelmediainfos.dita | 24 +- ...evicemanager_getplaybackdefaultdevice.dita | 22 +- ...vicemanager_getrecordingdefaultdevice.dita | 22 +- .../API/api_imediaengine_addlistener.dita | 30 +-- ...i_imediaengine_createcustomaudiotrack.dita | 18 +- .../API/api_imediaengine_pushaudioframe.dita | 26 +-- .../API/api_imediaplayer_addlistener.dita | 28 +-- ...api_imediaplayer_openwithcustomsource.dita | 2 +- .../API/api_imediarecorder_addlistener.dita | 28 +-- .../API/api_irtcengine_addlistener.dita | 28 +-- .../API/api_irtcengine_createdatastream2.dita | 6 +- .../api_irtcengine_enabledualstreammode2.dita | 8 +- .../api_irtcengine_getextensionproperty2.dita | 16 +- ...pi_irtcengine_getscreencapturesources.dita | 8 +- .../API/api_irtcengine_pushvideoframe2.dita | 30 +-- .../api_irtcengine_querycodeccapability.dita | 34 +-- ...tcengine_queryscreencapturecapability.dita | 22 +- ...cengine_registermediametadataobserver.dita | 2 +- .../API/api_irtcengine_setclientrole.dita | 4 +- .../API/api_irtcengine_setdualstreammode.dita | 30 +-- ...tcengine_setexternalaudiosourcevolume.dita | 24 +- .../API/api_irtcengine_setvideoprofile.dita | 26 +-- .../API/api_irtcengine_startechotest3.dita | 16 +- ...cengine_startscreencapturebydisplayid.dita | 2 +- .../API/api_irtcengine_switchchannel2.dita | 30 +-- ...irtcengine_updatescreencaptureregion2.dita | 2 +- .../api_irtcengineex_createdatastreamex2.dita | 4 +- .../API/api_irtcengineex_joinchannelex.dita | 30 +-- ...api_ivideodevicemanager_getcapability.dita | 6 +- .../callback_iaudiopcmframesink_onframe.dita | 2 +- ...eventhandler_onconnectionstatechanged.dita | 2 +- ...nthandler_onlocalvideotranscodererror.dita | 2 +- .../class_Localaccesspointconfiguration.dita | 31 +-- .../dita/RTC-NG/API/class_advanceoptions.dita | 18 +- en-US/dita/RTC-NG/API/class_audioparams.dita | 38 +-- .../class_audiorecordingconfiguration.dita | 6 +- .../class_cameracapturerconfiguration.dita | 24 +- .../RTC-NG/API/class_channelmediaoptions.dita | 216 +++++++++--------- .../class_channelmediarelayconfiguration.dita | 40 ++-- en-US/dita/RTC-NG/API/class_codeccapinfo.dita | 18 +- .../dita/RTC-NG/API/class_codeccaplevels.dita | 16 +- .../API/class_contentinspectconfig.dita | 22 +- .../API/class_encodedvideoframeinfo.dita | 16 +- .../RTC-NG/API/class_externalvideoframe.dita | 40 ++-- .../RTC-NG/API/class_injectstreamconfig.dita | 2 +- .../RTC-NG/API/class_livetranscoding.dita | 96 ++++---- .../class_localtranscoderconfiguration.dita | 22 +- .../RTC-NG/API/class_localvideostats.dita | 40 ++-- .../API/class_mediarecorderconfiguration.dita | 14 +- en-US/dita/RTC-NG/API/class_mediasource.dita | 18 +- .../RTC-NG/API/class_remoteaudiostats.dita | 6 +- .../RTC-NG/API/class_rtcengineconfig.dita | 46 ++-- .../API/class_screencaptureconfiguration.dita | 2 +- .../API/class_screencaptureparameters.dita | 42 ++-- .../API/class_screencaptureparameters2.dita | 36 +-- .../API/class_screencapturesourceinfo.dita | 34 +-- .../API/class_simulcaststreamconfig.dita | 2 +- .../API/class_transcodingvideostream.dita | 14 +- .../API/class_useraudiospectruminfo.dita | 4 +- en-US/dita/RTC-NG/API/class_videocanvas.dita | 46 ++-- .../API/class_videoencoderconfiguration.dita | 78 ++++--- en-US/dita/RTC-NG/API/class_videoframe.dita | 22 +- .../API/class_videosubscriptionoptions.dita | 30 +-- .../RTC-NG/API/class_watermarkoptions.dita | 22 +- en-US/dita/RTC-NG/API/enum_bitrate.dita | 2 +- 65 files changed, 800 insertions(+), 797 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita index 321808ad597..cc6bb339b4d 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita @@ -1,32 +1,32 @@ - <ph keyref="getDestChannelMediaInfos" /> + <ph keyref="getDestChannelMediaInfos"/> Gets the information of the target channel. - +

            - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } - - - - - - -

            + + + + + + +

            Returns -

            The information of the target channel. See .

            +

            The information of the target channel. See .

            -
            \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita index d292c20dc70..f6e16bd18d9 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getPlaybackDefaultDevice" /> + <ph keyref="getPlaybackDefaultDevice"/> Gets the default audio playback device. - +

            - - - + + + abstract getPlaybackDefaultDevice(): AudioDeviceInfo; public abstract int GetPlaybackDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getPlaybackDefaultDevice(); -

            + + Future<AudioDeviceInfo> getPlaybackDefaultDevice(); +

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

            The details about the default audio playback device. See .

            +

            The details about the default audio playback device. See .

            • 0: Success.
            • -
            • < 0: Failure. See for details and resolution suggestions.
            • +
            • < 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_getrecordingdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita index 5dda26e2174..bba32a04a95 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getRecordingDefaultDevice" /> + <ph keyref="getRecordingDefaultDevice"/> Gets the default audio capture device. - +

            - - - + + + abstract getRecordingDefaultDevice(): AudioDeviceInfo; public abstract int GetRecordingDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getRecordingDefaultDevice(); -

            + + Future<AudioDeviceInfo> getRecordingDefaultDevice(); +

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

            The details about the default audio capture device. See .

            +

            The details about the default audio capture device. See .

            • 0: Success.
            • -
            • < 0: Failure. See for details and resolution suggestions.
            • +
            • < 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_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita index 0e006691d30..f97153f4d5e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita @@ -1,49 +1,49 @@ - <ph keyref="addListener_IMediaEngine" /> - Adds one listener. + <ph keyref="addListener_IMediaEngine"/> + Adds one listener. - +

            - - - - addListener?<EventType extends keyof IMediaEngineEvent>( + + + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaEngineEvent>( + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - -

            + +

            Details -

            After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

            +

            After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

            Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
            -
            \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita index 4b3d1d972c6..6c268bd0b21 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="createCustomAudioTrack" /> + <ph keyref="createCustomAudioTrack"/> Creates a custom audio track. - + @@ -27,9 +27,9 @@ trackType: AudioTrackType, config: AudioTrackConfig ): number; - Future<int> createCustomAudioTrack( + Future<int> createCustomAudioTrack( {required AudioTrackType trackType, required AudioTrackConfig config}); -

            +

          Details @@ -41,8 +41,8 @@

          To publish a custom audio source to multiple channels, see the following steps:

          1. Call this method to create a custom audio track and get the audio track ID.
          2. -
          3. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
          4. -
          5. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
          6. +
          7. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
          8. +
          9. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.

          @@ -50,11 +50,11 @@ trackType - The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. + The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. config - The configuration of the custom audio track. See . + The configuration of the custom audio track. See .
          @@ -64,4 +64,4 @@
        • If the method call fails, a negative value is returned.
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita index 2ea5558608d..6dc1f62db49 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita @@ -1,12 +1,12 @@ - <ph keyref="pushAudioFrame1" /> + <ph keyref="pushAudioFrame1"/> Pushes the external audio frame. - + @@ -18,19 +18,19 @@ samples:(NSInteger)samples sourceId:(NSInteger)sourceId timestamp:(NSTimeInterval)timestamp; - - - - - -

        + + + + + +

      Parameters frame - The external audio frame. See . + The external audio frame. See . @@ -49,8 +49,8 @@ - - + +
      @@ -58,8 +58,8 @@

      • 0: Success.
      • -
      • < 0: Failure. See for details and resolution suggestions.
      • +
      • < 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_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita index 9ce3923ca0f..0c96f2ee242 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaPlayer" /> - Adds one listener. + <ph keyref="addListener_IMediaPlayer"/> + Adds one listener. - +

      - - - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; -

      +

      Details -

      After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

      +

      After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

      Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
      -
      \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita index 382bad72cf6..52b72c3ea03 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita @@ -62,7 +62,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_imediarecorder_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita index 344aa0cebdb..dc6238f2f49 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaRecorder" /> - Adds one listener. + <ph keyref="addListener_IMediaRecorder"/> + Adds one listener. - +

    - - - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; -

    +

    Details -

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    +

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; + The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
    -
    \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita index a21fcc70f63..028041b353b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener" /> - Adds one listener. + <ph keyref="addListener"/> + Adds one listener. - +

    - - - - addListener?<EventType extends keyof IRtcEngineEvent>( + + + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IRtcEngineEvent>( + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; -

    +

    Details -

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    +

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
    -
    \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index a3ca1a6757b..d0e0c7ad951 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -21,7 +21,7 @@ public abstract int CreateDataStream(ref int streamId, DataStreamConfig config); abstract createDataStream(config: DataStreamConfig): number; Future<int> createDataStream(DataStreamConfig config); -

    +

    Details @@ -45,7 +45,7 @@
    • 0: The data stream is successfully created.
    • ID of the created data stream, if the 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_enabledualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita index 79876008572..f79c8b4f19b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita @@ -28,14 +28,14 @@ streamConfig?: SimulcastStreamConfig ): number;
    Future<void> enableDualStreamMode(bool enabled); -

    +

    Details
    Deprecated:
    -
    This method is deprecated as of v4.2.0. Use instead.
    +
    This method is deprecated as of v4.2.0. Use instead.

    You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream:

      @@ -46,7 +46,7 @@
      • 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.
      • -
      • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
      • +
      • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
      • You can call this method either before or after joining a channel.
    @@ -72,7 +72,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_getextensionproperty2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita index 3803ae2b685..7af9752c219 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita @@ -1,12 +1,12 @@ - <ph keyref="getExtensionProperty2" /> + <ph keyref="getExtensionProperty2"/> Gets detailed information on the extensions. - + @@ -40,17 +40,17 @@ bufLen: number, type?: MediaSourceType ): string;
    - Future<String> getExtensionProperty( + Future<String> getExtensionProperty( {required String provider, required String extension, required String key, required int bufLen, MediaSourceType type = MediaSourceType.unknownMediaSource}); -

    +

    Details -

    +

    Parameters @@ -77,7 +77,7 @@ sourceType type - Source type of the extension. See . + Source type of the extension. See . buf_len @@ -89,11 +89,11 @@ 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.
    • 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_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita index 1657ff3ff0c..3fa7322ff1b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita @@ -32,7 +32,7 @@ {required Size thumbSize, required Size iconSize, required bool includeScreen});
    -

    +

    Details @@ -44,11 +44,11 @@ thumbSize - The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. + The target size of the screen or window thumbnail (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it. iconSize - The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. + The target size of the icon corresponding to the application program (the width and height are in pixels). See . The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it. includeScreen @@ -64,4 +64,4 @@

    The array.

    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita index 532e8c7ddcc..8b9d50bb20c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita @@ -1,12 +1,12 @@ - <ph keyref="pushVideoFrame2" /> + <ph keyref="pushVideoFrame2"/> Pushes the external video frame. - + @@ -14,32 +14,32 @@

    public abstract boolean pushExternalVideoFrame(VideoFrame frame); - - - - - - -

    + + + + + + +

    Details -

    This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

    -

    You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

    +

    This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

    +

    You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

    Parameters frame - Video frame to be pushed. See . + Video frame to be pushed. See .
    Returns
      -
    • : Pushes the external raw video frame to the SDK successfully.
    • -
    • : Fails to push external raw video frame to the SDK.
    • +
    • : Pushes the external raw video frame to the SDK successfully.
    • +
    • : Fails to push external raw video frame to the SDK.
    -
    \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita index bd4f010f2dd..5855456247d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryCodecCapability" /> + <ph keyref="queryCodecCapability"/> Queries the current device's supported video codec capabilities. - + @@ -14,13 +14,13 @@

    public abstract CodecCapInfo[] queryCodecCapability(); - - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; + - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0; abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; public abstract int QueryCodecCapability(ref CodecCapInfo[] codecInfo, ref int size); abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; - Future<List<CodecCapInfo>> queryCodecCapability(int size);

    + Future<List<CodecCapInfo>> queryCodecCapability(int size);

    Details @@ -30,7 +30,7 @@
    v4.2.0
    -

    +

    Parameters @@ -38,37 +38,37 @@ codecInfo -

    Input and output parameter. An array representing the video codec capabilities of the device. See .

    +

    Input and output parameter. An array representing the video codec capabilities of the device. See .

      -
    • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
    • -
    • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
    • +
    • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
    • +
    • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
    size - Input and output parameter, represent the size of the array.
      -
    • Input value: Size of the defined by the user when executing the method.
    • -
    • Output value: Size of the output after this method is executed.
    • + Input and output parameter, represent the size of the array.
        +
      • Input value: Size of the defined by the user when executing the method.
      • +
      • Output value: Size of the output after this method is executed.
      - The size of . + The size of .
    Returns
    • If the call is successful, an object containing the following attributes is returned:
        -
      • codecInfo: The array, indicating the video codec capabillity of the device.
      • -
      • size: The size of the array.
    • +
    • codecInfo: The array, indicating the video codec capabillity of the device.
    • +
    • size: The size of the array.
  • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
    • 0: Success.
    • -
    • < 0: Failure. See for details and resolution suggestions.
    • +
    • < 0: Failure. See for details and resolution suggestions.
      -
    • One array indicating the video encoding capability of the device, if the method call succeeds.
    • +
    • One array indicating the video encoding capability of the device, if the method call succeeds.
    • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
    -
    \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita index 7afadbb1bfd..a5c5c9bdd05 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryScreenCaptureCapability" /> + <ph keyref="queryScreenCaptureCapability"/> Queries the highest frame rate supported by the device during screen sharing. - + @@ -18,10 +18,10 @@ #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) virtual int queryScreenCaptureCapability() = 0; #endif - + public abstract int QueryScreenCaptureCapability(); abstract queryScreenCaptureCapability(): number; - Future<int> queryScreenCaptureCapability();

    + Future<int> queryScreenCaptureCapability();

    Details @@ -31,7 +31,7 @@
    v4.2.0
    -

    +

    Applicable scenarios @@ -39,15 +39,15 @@

    To ensure optimal screen sharing performance, particularly in enabling high frame rates like 60 fps, Agora recommends you to query the device's maximum supported frame rate using this method beforehand. This way, if the device cannot support such a high frame rate, you can adjust the screen sharing stream accordingly to avoid any negative impact on the sharing quality. If the device does not support high frame rate, you can reduce the frame rate of the screen sharing stream appropriately when sharing the screen to ensure that the sharing effect meets your expectation.

    - <ph keyref="return-section-title" /> -
    • The highest frame rate supported by the device, if the method is called successfully. See .
    • -
    • If the call fails, returns .
    + <ph keyref="return-section-title"/> +
    • The highest frame rate supported by the device, if the method is called successfully. See .
    • +
    • If the call fails, returns .
      -
    • The highest frame rate supported by the device, if the method is called successfully. See .
        +
      • The highest frame rate supported by the device, if the method is called successfully. See .
        • 0: The device supports the frame rate of up to 15 fps.
        • 1: The device supports the frame rate of up to 30 fps.
        • 2: The device supports the frame rate of up to 60 fps.
      • -
      • < 0: Failure. See for details and resolution suggestions.
      +
    • < 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_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index ae14605bec9..88a5a7f38cd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita @@ -46,7 +46,7 @@ type -

    The metadata type. The SDK currently only supports . See .

    +

    The metadata type. The SDK currently only supports . See .

    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index d10f2b5fc1a..46af17733e2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -30,7 +30,7 @@
    Details

    You can call this method either before or after joining the channel to set the user role as audience or host.

    -

    +

    If you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks:

    • The local client: .
    • The remote client: or ().
    • @@ -62,4 +62,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita index 4084e253a7f..cf4a2f77dce 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode" /> + <ph keyref="setDualStreamMode"/> Sets the dual-stream mode on the sender side. - + @@ -16,11 +16,11 @@ public abstract int setDualStreamMode(Constants.SimulcastStreamMode mode); - (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode; virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0; - + public abstract int SetDualStreamMode(SIMULCAST_STREAM_MODE mode); - - -

    + + +

    Details
    @@ -29,12 +29,12 @@
    v4.0.1
    -

    The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

      -
    • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
    • -
    • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as ().
    • -
    • When calling this method and setting mode to , it has the same effect as ().
    • +

      The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

        +
      • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
      • +
      • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as ().
      • +
      • When calling this method and setting mode to , it has the same effect as ().
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -43,15 +43,15 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. 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_setexternalaudiosourcevolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita index 835be9dd6a2..a420b8b61c8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita @@ -1,26 +1,26 @@ - <ph keyref="setExternalAudioSourceVolume" /> + <ph keyref="setExternalAudioSourceVolume"/> Sets the volume of the external audio frame in the specified position. - +

    - - - - + + + + public abstract int SetExternalAudioSourceVolume(int sourcePos, int volume); - - -

    + + +

    Details @@ -31,7 +31,7 @@ sourcePos - The push position of the external audio frame. See . + The push position of the external audio frame. See . The push position of the external audio frame.
    • 0: The position before local playback. If you need to play the external audio frame on the local client, set this position.
    • 1: The position after audio capture and before audio pre-processing. If you need the audio module of the SDK to process the external audio frame, set this position.
    • @@ -47,7 +47,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_setvideoprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita index 76e8d6f33d0..bd6091ec096 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoProfile" /> + <ph keyref="setVideoProfile"/> Sets the video encoder configuration. - + @@ -17,21 +17,21 @@ - (int)setVideoProfile:(AgoraVideoProfile)profile swapWidthAndHeight:(BOOL)swapWidthAndHeight virtual int setVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) = 0; - + public abstract int SetVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight = false); - - -

    + + +

    Details
    Deprecated:
    -
    This method is deprecated. Use instead.
    +
    This method is deprecated. Use instead.
    -

    This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

    +

    This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

    Parameters @@ -39,7 +39,7 @@ profile -

    Video profile. See .

    +

    Video profile. See .

    @@ -47,8 +47,8 @@

    The SDK outputs video with a fixed width and height according to the video profile (profile) you selected. This parameter sets whether to swap width and height of the video:

      -
    • : Swap the width and height.
    • -
    • : (Default) Do not swap the width and height.
    • +
    • : Swap the width and height.
    • +
    • : (Default) Do not swap the width and height.
    @@ -56,7 +56,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_startechotest3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita index 610717b10b2..c2a8a6417fb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita @@ -1,12 +1,12 @@ - <ph keyref="startEchoTest3" /> + <ph keyref="startEchoTest3"/> Starts an audio device loopback test. - + @@ -19,8 +19,8 @@ abstract startEchoTest(config: EchoTestConfiguration): number; public abstract int StartEchoTest(EchoTestConfiguration config); abstract startEchoTest(config: EchoTestConfiguration): number; - Future<void> startEchoTest(EchoTestConfiguration config); -

    + Future<void> startEchoTest(EchoTestConfiguration config); +

    Details @@ -28,7 +28,7 @@

    After starting the test, the user needs to make a sound or face the camera. The audio or video is output after about two seconds. If the audio playback is normal, the audio device and the user's upstream and downstream networks are working properly; if the video playback is normal, the video device and the user's upstream and downstream networks are working properly.

    • You can call this method either before or after joining a channel. When calling in a channel, make sure that no audio or video stream is being published.
    • -
    • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
    • +
    • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
    • In live streaming scenarios, this method only applies to hosts.

    @@ -37,14 +37,14 @@ config - The configuration of the audio and video call loop test. See . + The configuration of the audio and video call loop test. 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_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index 0908210de2b..ac1b202e9b8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -57,7 +57,7 @@ regionRect - (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
      + (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen. See . It consists of the following parameters:
      • x: The horizontal offset from the top-left corner.
      • y: The vertical offset from the top-left corner.
      • width: The width of the region.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita index 968cf91cf25..4f419c0f36a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita @@ -1,33 +1,33 @@ - <ph keyref="switchChannel2" /> + <ph keyref="switchChannel2"/> Switches to a different channel, and configures whether to automatically subscribe to audio or video streams in the target channel. - +

        - - + + virtual int switchChannel(const char* token, const char* channelId, const ChannelMediaOptions& options) = 0; - + public abstract int SwitchChannel(string token, string channelId, ChannelMediaOptions options); - - -

        + + +

        Details

        This method allows the audience of an interactive live streaming channel to switch to a different channel.

        -

        After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

        +

        After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

        Once the user switches to another channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

        @@ -37,10 +37,10 @@ token

        The token generated at your server.

          -
        • In scenarios with low security requirements, token is optional and can be set as .
        • +
        • In scenarios with low security requirements, token is optional and can be set as .
        • In scenarios with high security requirements, set the value to the token generated from your server. If you enable the App Certificate, you must use a token to join the channel.
        - Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

        + Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

        @@ -52,20 +52,20 @@
      • All uppercase English letters: A to Z.
      • All numeric characters: 0 to 9.
      • Space
      • -
      • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
      • +
      • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

      options - The channel media options. See . + The channel media options. See .
      Returns
      • 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.
          • -5: The request is rejected. This is probably because the user is not an audience member.
          • @@ -75,4 +75,4 @@
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita index f7aaf5269f4..4d357579b6f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita @@ -28,7 +28,7 @@ rect regionRect - The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index 2cf86168db9..1926b7219ae 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -30,7 +30,7 @@ ): number; Future<int> createDataStreamEx( {required DataStreamConfig config, required RtcConnection connection}); -

      +

      Details @@ -58,7 +58,7 @@
      • 0: The data stream is successfully created.
      • ID of the created data stream, if the 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_irtcengineex_joinchannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index b033808fc8a..18f12794ebf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita @@ -1,12 +1,12 @@ - <ph keyref="joinChannelEx" /> + <ph keyref="joinChannelEx"/> Joins a channel with the connection ID. - + @@ -38,7 +38,7 @@ {required String token, required RtcConnection connection, required ChannelMediaOptions options}); -

      +

      Details @@ -47,34 +47,34 @@
      • If you are already in a channel, you cannot rejoin it with the same user ID.
      • If you want to join the same channel from different devices, ensure that the user IDs are different for all devices.
      • -
      • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
      • -
      • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
      • +
      • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
      • +
      • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
      Parameters - - + + connection - The connection information. See . + The connection information. See . - - + + eventHandler delegate - The callback class of .See . + The callback class of .See . - - + +
      -
      +
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita index 3f0d78bcbd5..276bd773c9d 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita @@ -26,9 +26,9 @@ deviceIdUTF8: string, deviceCapabilityNumber: number ): VideoFormat; - Future<VideoFormat> getCapability( + Future<VideoFormat> getCapability( {required String deviceIdUTF8, required int deviceCapabilityNumber}); -

      +

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

    The specific information of the specified video format, including width (px), height (px), and frame rate (fps). See .

    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita index fd2d9ace775..d0e024a7847 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita @@ -35,7 +35,7 @@ frame audioFrame - The audio frame information. See . See . + The audio frame information. See . See . playerKit diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita index 9f56dfe9b32..b3548c3bd32 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita @@ -53,7 +53,7 @@ state -

    The current connection state. See .

    +

    The current connection state. See .

    • (1): The SDK is disconnected from Agora's edge server.
    • (2): The SDK is connecting to Agora's edge server.
    • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita index e6d0e009900..be64dd5b4ee 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita @@ -54,7 +54,7 @@ error errorCode - The reason for local video mixing error. See . + The reason for local video mixing error. See . The reason for local video mixing error:
      • 1: The selected video source has not started video capture. You need to create a video track for it and start video capture.
      • 2: The video source type is invalid. You need to re-specify the supported video source type.
      • diff --git a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita index 48f3597553f..5e938362dc7 100644 --- a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita @@ -1,8 +1,9 @@ - <ph keyref="LocalAccessPointConfiguration" /> - The configurations of the Local Access Point. + <ph keyref="LocalAccessPointConfiguration"/> + The configurations of the Local Access Point.

        @@ -59,8 +60,8 @@ return logUploadServer; } }; - public ArrayList<String> ipList = null; - public ArrayList<String> domainList = null; + public ArrayList<String> ipList = null; + public ArrayList<String> domainList = null; public String verifyDomainName = null; public int mode = Constants.LOCAL_RPOXY_CONNECTIVITY_FIRST; public AdvancedConfigInfo advancedConfig = null; @@ -146,13 +147,13 @@ this.advancedConfig}); @JsonKey(name: 'ipList') - final List<String>? ipList; + final List<String>? ipList; @JsonKey(name: 'ipListSize') final int? ipListSize; @JsonKey(name: 'domainList') - final List<String>? domainList; + final List<String>? domainList; @JsonKey(name: 'domainListSize') final int? domainListSize; @@ -166,15 +167,15 @@ @JsonKey(name: 'advancedConfig') final AdvancedConfigInfo? advancedConfig; - factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => _$LocalAccessPointConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); } -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> ipList @@ -199,17 +200,17 @@ mode -

        The connection mode. See .

        +

        The connection mode. See .

        Select one of the following connection modes:

          -
        • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
        • -
        • (1) The SDK only tries to connect to the specified Agora private media server.
        • +
        • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
        • +
        • (1) The SDK only tries to connect to the specified Agora private media server.

        advancedConfig - The advanced options for the Local Access Point. See . + The advanced options for the Local Access Point. See .
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_advanceoptions.dita b/en-US/dita/RTC-NG/API/class_advanceoptions.dita index 0dc3b8188c3..9bdc1a2e617 100644 --- a/en-US/dita/RTC-NG/API/class_advanceoptions.dita +++ b/en-US/dita/RTC-NG/API/class_advanceoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="AdvanceOptions" /> + <ph keyref="AdvanceOptions"/> Advanced options for video encoding.
        @@ -75,12 +75,12 @@ @JsonKey(name: 'compressionPreference') final CompressionPreference? compressionPreference; - factory AdvanceOptions.fromJson(Map<String, dynamic> json) => + factory AdvanceOptions.fromJson(Map<String, dynamic> json) => _$AdvanceOptionsFromJson(json); - Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); + Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); } -

        +

        @@ -89,19 +89,19 @@
        v4.1.0
        -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> encodingPreference - Video encoder preference. See . + Video encoder preference. See . compressionPreference - Compression preference for video encoding. See . + Compression preference for video encoding. See .
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita index 8e884f6f6d3..9293da4048f 100644 --- a/en-US/dita/RTC-NG/API/class_audioparams.dita +++ b/en-US/dita/RTC-NG/API/class_audioparams.dita @@ -1,7 +1,7 @@ - <ph keyref="AudioParams" /> + <ph keyref="AudioParams"/> Audio data format.
        @@ -98,33 +98,33 @@ @JsonKey(name: 'samples_per_call') final int? samplesPerCall; - factory AudioParams.fromJson(Map<String, dynamic> json) => + factory AudioParams.fromJson(Map<String, dynamic> json) => _$AudioParamsFromJson(json); - Map<String, dynamic> toJson() => _$AudioParamsToJson(this); + Map<String, dynamic> toJson() => _$AudioParamsToJson(this); } -

        +

        -

        You can pass the object in the following APIs to set the audio data format for the corresponding callback:

          -
        • : Sets the audio data format for the callback.
        • -
        • : Sets the audio data format for the callback.
        • -
        • : Sets the audio data format for the callback.
        • -
        • : Sets the audio data format for the callback.
        • +

          You can pass the object in the following APIs to set the audio data format for the corresponding callback:

            +
          • : Sets the audio data format for the callback.
          • +
          • : Sets the audio data format for the callback.
          • +
          • : Sets the audio data format for the callback.
          • +
          • : Sets the audio data format for the callback.

          -

          The SDK sets the audio data format in the following callbacks according to .

            -
          • -
          • -
          • +

            The SDK sets the audio data format in the following callbacks according to .

              +
            • +
            • +

              -
            • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
            • +
            • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
            • Sample interval (sec) = samplePerCall/(sampleRate × channel).
            • Ensure that the sample interval ≥ 0.01 (s).
        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> sampleRate @@ -147,10 +147,10 @@ mode - The use mode of the audio data. See . + The use mode of the audio data. See . The use mode of the audio data, which can be set as either of the following values:
          -
        • (0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
        • -
        • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, 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): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
        • +
        • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, 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.
        @@ -160,4 +160,4 @@
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita index b694d999d95..039b4d298c6 100644 --- a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita @@ -164,12 +164,12 @@ @JsonKey(name: 'recordingChannel') final int? recordingChannel; - factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => + factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => _$AudioRecordingConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); + Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); } -

        +

        <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index e6bf23088b4..12b2e5c04f2 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -1,7 +1,7 @@ - <ph keyref="CameraCapturerConfiguration" /> + <ph keyref="CameraCapturerConfiguration"/> The camera capturer preference.
        @@ -199,40 +199,40 @@ @JsonKey(name: 'followEncodeDimensionRatio') final bool? followEncodeDimensionRatio; - factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => + factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => _$CameraCapturerConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); + Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); } -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <title> <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> cameraDirection - This parameter applies to Android and iOS only.The camera direction. See . + This parameter applies to Android and iOS only.The camera direction. See . format captureFormat - The format of the video frame. See . + The format of the video frame. See . deviceId This method applies to Windows only. - This method applies to macOS only.The ID of the camera. The maximum length is . + This method applies to macOS only.The ID of the camera. The maximum length is . followEncodeDimensionRatio - Whether to follow the video aspect ratio set in :
          -
        • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
        • -
        • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
        • + Whether to follow the video aspect ratio set in :
            +
          • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
          • +
          • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita index 95fe49b0845..fa0acf721d0 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="ChannelMediaOptions" /> + <ph keyref="ChannelMediaOptions"/> The channel media options.
        @@ -80,8 +80,8 @@ struct ChannelMediaOptions { Optional<bool> publishCameraTrack; Optional<bool> publishSecondaryCameraTrack; - Optional<bool> publishThirdCameraTrack; - Optional<bool> publishFourthCameraTrack; + Optional<bool> publishThirdCameraTrack; + Optional<bool> publishFourthCameraTrack; Optional<bool> publishMicrophoneTrack; #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) @@ -90,8 +90,8 @@ #else Optional<bool> publishScreenTrack; Optional<bool> publishSecondaryScreenTrack; - Optional<bool> publishThirdScreenTrack; - Optional<bool> publishFourthScreenTrack; + Optional<bool> publishThirdScreenTrack; + Optional<bool> publishFourthScreenTrack; #endif Optional<bool> publishCustomAudioTrack; @@ -223,37 +223,37 @@ } public class ChannelMediaOptions : OptionalJsonParse { - public Optional<bool> publishCameraTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); - public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); - public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); - public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); - public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); - public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); - public Optional<bool> publishScreenTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); - public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); - public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); - public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); - public Optional<int> publishCustomAudioTrackId = new Optional<int>(); - public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); - public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); - public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); - public Optional<bool> autoSubscribeAudio = new Optional<bool>(); - public Optional<bool> autoSubscribeVideo = new Optional<bool>(); - public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); - public Optional<int> publishMediaPlayerId = new Optional<int>(); - public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); - public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); - public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); - public Optional<string> token = new Optional<string>(); - public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); - public Optional<bool> isInteractiveAudience = new Optional<bool>(); - public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); - public Optional<bool> isAudioFilterable = new Optional<bool>(); + public Optional<bool> publishCameraTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); + public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); + public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); + public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); + public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); + public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); + public Optional<bool> publishScreenTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); + public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); + public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); + public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); + public Optional<int> publishCustomAudioTrackId = new Optional<int>(); + public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); + public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); + public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); + public Optional<bool> autoSubscribeAudio = new Optional<bool>(); + public Optional<bool> autoSubscribeVideo = new Optional<bool>(); + public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); + public Optional<int> publishMediaPlayerId = new Optional<int>(); + public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); + public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); + public Optional<string> token = new Optional<string>(); + public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); + public Optional<bool> isInteractiveAudience = new Optional<bool>(); + public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); + public Optional<bool> isAudioFilterable = new Optional<bool>(); } export class ChannelMediaOptions { @@ -462,68 +462,68 @@ class ChannelMediaOptions { @JsonKey(name: 'isAudioFilterable') final bool? isAudioFilterable; - factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => + factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => _$ChannelMediaOptionsFromJson(json); - Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); + Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); } -

        +

        -
        Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters. +
        Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> publishCameraTrack Whether to publish the video captured by the camera:
          -
        • : Publish the video captured by the camera.
        • -
        • : Do not publish the video captured by the camera.
        • +
        • : Publish the video captured by the camera.
        • +
        • : Do not publish the video captured by the camera.
        publishSecondaryCameraTrack Whether to publish the video captured by the second camera:
          -
        • : Publish the video captured by the second camera.
        • -
        • : Do not publish the video captured by the second camera.
        • +
        • : Publish the video captured by the second camera.
        • +
        • : Do not publish the video captured by the second camera.
        publishMicrophoneTrack Whether to publish the audio captured by the microphone:
          -
        • : Publish the audio captured by the microphone.
        • -
        • : Do not publish the audio captured by the microphone.
        • +
        • : Publish the audio captured by the microphone.
        • +
        • : Do not publish the audio captured by the microphone.
        • As of v4.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
        • As of v6.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
        • -
        • If you set this parameter as , SDK turns off microphone capturing.
        • -
        • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
        • +
        • If you set this parameter as , SDK turns off microphone capturing.
        • +
        • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
        publishThirdCameraTrack Whether to publish the video captured by the third camera:
          -
        • : Publish the video captured by the third camera.
        • -
        • : Do not publish the video captured by the third camera.
        • +
        • : Publish the video captured by the third camera.
        • +
        • : Do not publish the video captured by the third camera.

        This method is for Windows and macOS only.

        publishFourthCameraTrack Whether to publish the video captured by the fourth camera:
          -
        • : Publish the video captured by the fourth camera.
        • -
        • : Do not publish the video captured by the fourth camera.
        • +
        • : Publish the video captured by the fourth camera.
        • +
        • : Do not publish the video captured by the fourth camera.

        This method is for Windows and macOS only.

        publishScreenTrack

        Whether to publish the video captured from the screen:

          -
        • : Publish the video captured from the screen.
        • -
        • : Do not publish the video captured from the screen.
        • +
        • : Publish the video captured from the screen.
        • +
        • : Do not publish the video captured from the screen.

        This method is for Windows and macOS only.
        @@ -532,8 +532,8 @@ class ChannelMediaOptions { publishScreenCaptureVideo

        Whether to publish the video captured from the screen:

          -
        • : Publish the video captured from the screen.
        • -
        • : Do not publish the video captured from the screen.
        • +
        • : Publish the video captured from the screen.
        • +
        • : Do not publish the video captured from the screen.

        This parameter applies to Android and iOS only. As of v4.0.0, the parameter name is changed from publishScreenTrack to publishScreenCaptureVideo.
        @@ -542,8 +542,8 @@ class ChannelMediaOptions { publishScreenCaptureAudio

        Whether to publish the audio captured from the screen:

          -
        • : Publish the audio captured from the screen.
        • -
        • : Publish the audio captured from the screen.
        • +
        • : Publish the audio captured from the screen.
        • +
        • : Publish the audio captured from the screen.

        This parameter applies to Android and iOS only.
        @@ -551,16 +551,16 @@ class ChannelMediaOptions { publishSecondaryScreenTrack Whether to publish the video captured from the second screen:
          -
        • : Publish the video captured from the second screen.
        • -
        • : Do not publish the video captured from the second screen.
        • +
        • : Publish the video captured from the second screen.
        • +
        • : Do not publish the video captured from the second screen.
        publishThirdScreenTrack Whether to publish the video captured from the third screen:
          -
        • : Publish the captured video from the third screen.
        • -
        • : Do not publish the video captured from the third screen.
        • +
        • : Publish the captured video from the third screen.
        • +
        • : Do not publish the video captured from the third screen.

        This method is for Windows and macOS only.

        @@ -569,8 +569,8 @@ class ChannelMediaOptions { publishFourthScreenTrack Whether to publish the video captured from the fourth screen:
          -
        • : Publish the captured video from the fourth screen.
        • -
        • : Do not publish the video captured from the fourth screen.
        • +
        • : Publish the captured video from the fourth screen.
        • +
        • : Do not publish the video captured from the fourth screen.

        This method is for Windows and macOS only.

        @@ -579,8 +579,8 @@ class ChannelMediaOptions { publishTranscodedVideoTrack Whether to publish the local transcoded video:
          -
        • : Publish the local transcoded video.
        • -
        • : Do not publish the local transcoded video.
        • +
        • : Publish the local transcoded video.
        • +
        • : Do not publish the local transcoded video.

        As of v4.2.0, the parameter name is corrected from publishTrancodedVideoTrack to publishTranscodedVideoTrack.

        @@ -588,64 +588,64 @@ class ChannelMediaOptions { publishCustomAudioTrack Whether to publish the audio captured from a custom source:
          -
        • : Publish the audio captured from the custom source.
        • -
        • : Do not publish the captured audio from a custom source.
        • +
        • : Publish the audio captured from the custom source.
        • +
        • : Do not publish the captured audio from a custom source.
        publishCustomAudioTrackId - The ID of the custom audio source to publish. The default value is 0.

        If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

        + The ID of the custom audio source to publish. The default value is 0.

        If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

        publishCustomVideoTrack Whether to publish the video captured from a custom source:
          -
        • : Publish the video captured from the custom source.
        • -
        • : Do not publish the captured video from a custom source.
        • +
        • : Publish the video captured from the custom source.
        • +
        • : Do not publish the captured video from a custom source.
        publishEncodedVideoTrack Whether to publish the encoded video:
          -
        • : Publish the encoded video.
        • -
        • : Do not publish the encoded video.
        • +
        • : Publish the encoded video.
        • +
        • : Do not publish the encoded video.
        publishMediaPlayerAudioTrack Whether to publish the audio from the media player:
          -
        • : Publish the audio from the media player.
        • -
        • : Do not publish the audio from the media player.
        • +
        • : Publish the audio from the media player.
        • +
        • : Do not publish the audio from the media player.
        publishMediaPlayerVideoTrack Whether to publish the video from the media player:
          -
        • : Publish the video from the media player.
        • -
        • : Do not publish the video from the media player.
        • +
        • : Publish the video from the media player.
        • +
        • : Do not publish the video from the media player.
        autoSubscribeAudio Whether to automatically subscribe to all remote audio streams when the user joins a channel:
          -
        • : Subscribe to all remote audio streams.
        • -
        • : Do not automatically subscribe to any remote audio streams.
        • +
        • : Subscribe to all remote audio streams.
        • +
        • : Do not automatically subscribe to any remote audio streams.
        autoSubscribeVideo Whether to automatically subscribe to all remote video streams when the user joins the channel:
          -
        • : Subscribe to all remote video streams.
        • -
        • : Do not automatically subscribe to any remote video streams.
        • +
        • : Subscribe to all remote video streams.
        • +
        • : Do not automatically subscribe to any remote video streams.
        enableAudioRecordingOrPlayout Whether to enable audio capturing or playback:
          -
        • : Enable audio capturing or playback.
        • -
        • : Do not enable audio capturing or playback.
        • +
        • : Enable audio capturing or playback.
        • +
        • : Do not enable audio capturing or playback.
        - If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .
        + If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .
        publishMediaPlayerId @@ -653,23 +653,23 @@ class ChannelMediaOptions { clientRoleType - + clientRoleType - The user role. See . + The user role. See . - - + + defaultVideoStreamType - + channelProfile - + audioDelayMs @@ -681,8 +681,8 @@ class ChannelMediaOptions { publishCustomAudioTrackAec Whether to publish audio frames processed by an external echo cancellation module.
          -
        • : Publish audio frames processed by the external echo cancellation module.
        • -
        • : Do not publish to publish audio frames processed by the external echo cancellation module.
        • +
        • : Publish audio frames processed by the external echo cancellation module.
        • +
        • : Do not publish to publish audio frames processed by the external echo cancellation module.
        @@ -691,48 +691,48 @@ class ChannelMediaOptions {

        (Optional) The token generated on your server for authentication. See Authenticate Your Users with Token.

          -
        • This parameter takes effect only when calling or .
        • -
        • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
        • +
        • This parameter takes effect only when calling or .
        • +
        • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
        startPreview Whether to automatically start the preview when joining a channel:
          -
        • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
        • -
        • : Do not automatically start the preview.
        • +
        • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
        • +
        • : Do not automatically start the preview.
        publishRhythmPlayerTrack Whether to publish the sound of a metronome to remote users:
          -
        • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
        • -
        • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
        • +
        • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
        • +
        • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
        isInteractiveAudience Whether to enable interactive mode:
          -
        • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
        • -
        • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
        • +
        • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
        • +
        • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
          -
        • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
        • -
        • This parameter takes effect only when the user role is .
        • +
        • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
        • +
        • This parameter takes effect only when the user role is .
        customVideoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value is 0. isAudioFilterable Whether the audio stream being published is filtered according to the volume algorithm:
          -
        • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
        • -
        • : The audio stream is not filtered.
        • +
        • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
        • +
        • : The audio stream is not filtered.
        - If you need to enable this function, contact .
        + If you need to enable this function, contact .
        - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita index 0cec8673f65..32d206bfbf4 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita @@ -1,17 +1,17 @@ - <ph keyref="ChannelMediaRelayConfiguration" /> + <ph keyref="ChannelMediaRelayConfiguration"/> Configuration of cross channel media relay.

        public class ChannelMediaRelayConfiguration { private ChannelMediaInfo srcInfo = null; - private Map<String, ChannelMediaInfo> destInfos = null; + private Map<String, ChannelMediaInfo> destInfos = null; public ChannelMediaRelayConfiguration() { - destInfos = new HashMap<String, ChannelMediaInfo>(); + destInfos = new HashMap<String, ChannelMediaInfo>(); srcInfo = new ChannelMediaInfo(null, null, 0); } @@ -31,7 +31,7 @@ return srcInfo; } - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } } @@ -104,44 +104,44 @@ _$ChannelMediaRelayConfigurationFromJson(json); Map<String, dynamic> toJson() => _$ChannelMediaRelayConfigurationToJson(this); } -

        +

        Method setSrcChannelInfo - Sets the information of the source channel. See . + Sets the information of the source channel. See . setDestChannelInfo - Sets the information of the target channel. See . + Sets the information of the target channel. See . removeDestChannelInfo - Deletes the information of target channel. See . + Deletes the information of target channel. See . getSrcChannelMediaInfo - Gets the information of the source channel. See . + Gets the information of the source channel. See . getDestChannelMediaInfos - Gets the information of the target channel. See . + Gets the information of the target channel. See .
        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> srcInfo sourceInfo -

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

          -
        • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
        • +

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

            +
          • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
          • token: The token for joining the source channel. This token is generated with the channelName and uid you set in srcInfo.
              -
            • 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, and the uid must be set as 0.
          • uid: The unique user ID to identify the relay stream in the source channel. Agora recommends leaving the default value of 0 unchanged.
          • @@ -152,10 +152,10 @@ destInfos destinationInfos -

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

              +

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

              • channelName: The name of the target channel.
              • token: The token for joining the target channel. It 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.
              • @@ -164,16 +164,16 @@ destCount - The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. + The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. setDestinationInfo - Sets the information of the target channel. See . + Sets the information of the target channel. See . removeDestinationInfoForChannelName - Deletes the information of target channel. See . + Deletes the information of target channel. See .
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita index e23d6c97366..0db7da8ee6a 100644 --- a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita +++ b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapInfo" /> + <ph keyref="CodecCapInfo"/> The codec capability of the device.
        @@ -70,10 +70,10 @@ class CodecCapInfo { @JsonKey(name: 'codecLevels') final CodecCapLevels? codecLevels; - factory CodecCapInfo.fromJson(Map<String, dynamic> json) => + factory CodecCapInfo.fromJson(Map<String, dynamic> json) => _$CodecCapInfoFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); + Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); }

        @@ -83,14 +83,14 @@ class CodecCapInfo {
        v4.2.0
        -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> codecType - The video codec types. See . + The video codec types. See .

        The video codec types:

        • 1: VP8.
        • @@ -100,7 +100,7 @@ class CodecCapInfo { codecCapMask - The bit mask of the codec type. See . + The bit mask of the codec type. See .

          The bit mask of the codec type:

          • (0): The device does not support encoding or decoding.
          • @@ -113,8 +113,8 @@ class CodecCapInfo { codecLevels - The level of the codec capability. See . + The level of the codec capability. See .
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita index b120ee0a9bf..02291a389e8 100644 --- a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita +++ b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapLevels" /> + <ph keyref="CodecCapLevels"/> The level of the codec capability.
        @@ -60,10 +60,10 @@ class CodecCapLevels { @JsonKey(name: 'swDecodingLevel') final VideoCodecCapabilityLevel? swDecodingLevel; - factory CodecCapLevels.fromJson(Map<String, dynamic> json) => + factory CodecCapLevels.fromJson(Map<String, dynamic> json) => _$CodecCapLevelsFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); + Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); }

        @@ -73,19 +73,19 @@ class CodecCapLevels {
        v4.2.2
        -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> hwDecodingLevel - Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . + Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . swDecodingLevel - Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See . + Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See .
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita index 970de4ab592..a5b8be949a4 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita @@ -1,7 +1,7 @@ - <ph keyref="ContentInspectConfig" /> + <ph keyref="ContentInspectConfig"/> Configuration of video screenshot and upload.
        @@ -95,16 +95,16 @@ class ContentInspectConfig { const ContentInspectConfig( {this.extraInfo, this.serverConfig, this.modules, this.moduleCount}); - @JsonKey(name: 'extraInfo') + @JsonKey(name: 'extraInfo') final String? extraInfo; - @JsonKey(name: 'serverConfig') + @JsonKey(name: 'serverConfig') final String? serverConfig; - @JsonKey(name: 'modules') + @JsonKey(name: 'modules') final List<ContentInspectModule>? modules; - @JsonKey(name: 'moduleCount') + @JsonKey(name: 'moduleCount') final int? moduleCount; factory ContentInspectConfig.fromJson(Map<String, dynamic> json) => @@ -112,7 +112,7 @@ class ContentInspectConfig { Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this); } -

        +

        Parameters @@ -143,20 +143,20 @@ class ContentInspectConfig { serverConfig - (Optional) Server configuration related to uploading video screenshots via extensions from Agora Extensions Marketplace. This parameter only takes effect when type in is set to . If you want to use it, contact . + (Optional) Server configuration related to uploading video screenshots via extensions from Agora Extensions Marketplace. This parameter only takes effect when type in is set to . If you want to use it, contact . modules -

        Functional module. See .

        -

        A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

        +

        Functional module. See .

        +

        A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

        A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.
        moduleCount - The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32. + The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32.
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita index 5604f09a505..78da718d6ad 100644 --- a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita +++ b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita @@ -299,12 +299,12 @@ @JsonKey(name: 'streamType') final VideoStreamType? streamType; - factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => + factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => _$EncodedVideoFrameInfoFromJson(json); - Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); + Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); } -

        +

        <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -313,9 +313,9 @@ codecType The codec type of the local video stream. See . The default value is (2).

        The codec type of the video:

          -
        • (1): VP8.
        • -
        • (2): (Default) H.264.
        • -
        • (3): H.265.
        • +
        • (1): VP8.
        • +
        • (2): (Default) H.264.
        • +
        • (3): H.265.

        @@ -373,7 +373,7 @@ streamType - The type of video streams. See . + The type of video streams. See .
        • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
        • @@ -382,4 +382,4 @@
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita index 811b3e69def..0a05a41985f 100644 --- a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita +++ b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita @@ -177,58 +177,58 @@ class ExternalVideoFrame { this.alphaBuffer, this.textureSliceIndex}); - @JsonKey(name: 'type') + @JsonKey(name: 'type') final VideoBufferType? type; - @JsonKey(name: 'format') + @JsonKey(name: 'format') final VideoPixelFormat? format; - @JsonKey(name: 'buffer', ignore: true) + @JsonKey(name: 'buffer', ignore: true) final Uint8List? buffer; - @JsonKey(name: 'stride') + @JsonKey(name: 'stride') final int? stride; - @JsonKey(name: 'height') + @JsonKey(name: 'height') final int? height; - @JsonKey(name: 'cropLeft') + @JsonKey(name: 'cropLeft') final int? cropLeft; - @JsonKey(name: 'cropTop') + @JsonKey(name: 'cropTop') final int? cropTop; - @JsonKey(name: 'cropRight') + @JsonKey(name: 'cropRight') final int? cropRight; - @JsonKey(name: 'cropBottom') + @JsonKey(name: 'cropBottom') final int? cropBottom; - @JsonKey(name: 'rotation') + @JsonKey(name: 'rotation') final int? rotation; - @JsonKey(name: 'timestamp') + @JsonKey(name: 'timestamp') final int? timestamp; - @JsonKey(name: 'eglType') + @JsonKey(name: 'eglType') final EglContextType? eglType; - @JsonKey(name: 'textureId') + @JsonKey(name: 'textureId') final int? textureId; - @JsonKey(name: 'matrix') + @JsonKey(name: 'matrix') final List<double>? matrix; - @JsonKey(name: 'metadata_buffer', ignore: true) + @JsonKey(name: 'metadata_buffer', ignore: true) final Uint8List? metadataBuffer; - @JsonKey(name: 'metadata_size') + @JsonKey(name: 'metadata_size') final int? metadataSize; - @JsonKey(name: 'alphaBuffer', ignore: true) + @JsonKey(name: 'alphaBuffer', ignore: true) final Uint8List? alphaBuffer; - @JsonKey(name: 'texture_slice_index') + @JsonKey(name: 'texture_slice_index') final int? textureSliceIndex; factory ExternalVideoFrame.fromJson(Map<String, dynamic> json) => @@ -236,7 +236,7 @@ class ExternalVideoFrame { Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this); } -

        +

        @@ -414,4 +414,4 @@ class ExternalVideoFrame {
        - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita index 452d88bb0fc..31ad3643074 100644 --- a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita @@ -143,7 +143,7 @@ _$InjectStreamConfigFromJson(json); Map<String, dynamic> toJson() => _$InjectStreamConfigToJson(this); }
        -

        +

        diff --git a/en-US/dita/RTC-NG/API/class_livetranscoding.dita b/en-US/dita/RTC-NG/API/class_livetranscoding.dita index 003438e6b86..0a6ae1719d9 100644 --- a/en-US/dita/RTC-NG/API/class_livetranscoding.dita +++ b/en-US/dita/RTC-NG/API/class_livetranscoding.dita @@ -1,7 +1,7 @@ - <ph keyref="LiveTranscoding" /> + <ph keyref="LiveTranscoding"/> Transcoding configurations for Media Push.
        @@ -513,7 +513,7 @@ final int? userCount; @JsonKey(name: 'transcodingUsers') - final List<TranscodingUser>? transcodingUsers; + final List<TranscodingUser>? transcodingUsers; @JsonKey(name: 'transcodingExtraInfo') final String? transcodingExtraInfo; @@ -522,13 +522,13 @@ final String? metadata; @JsonKey(name: 'watermark') - final List<RtcImage>? watermark; + final List<RtcImage>? watermark; @JsonKey(name: 'watermarkCount') final int? watermarkCount; @JsonKey(name: 'backgroundImage') - final List<RtcImage>? backgroundImage; + final List<RtcImage>? backgroundImage; @JsonKey(name: 'backgroundImageCount') final int? backgroundImageCount; @@ -546,20 +546,20 @@ final AudioCodecProfileType? audioCodecProfile; @JsonKey(name: 'advancedFeatures') - final List<LiveStreamAdvancedFeature>? advancedFeatures; + final List<LiveStreamAdvancedFeature>? advancedFeatures; @JsonKey(name: 'advancedFeatureCount') final int? advancedFeatureCount; - factory LiveTranscoding.fromJson(Map<String, dynamic> json) => + factory LiveTranscoding.fromJson(Map<String, dynamic> json) => _$LiveTranscodingFromJson(json); - Map<String, dynamic> toJson() => _$LiveTranscodingToJson(this); + Map<String, dynamic> toJson() => _$LiveTranscodingToJson(this); } -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> width @@ -615,8 +615,8 @@

        Latency mode:

          -
        • : Low latency with unassured quality.
        • -
        • : (Default) High latency with assured quality.
        • +
        • : Low latency with unassured quality.
        • +
        • : (Default) High latency with assured quality.
        @@ -626,17 +626,17 @@ videoCodecProfile -

        Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See for details.

        +

        Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See for details.

        If you set this parameter to any other value, Agora adjusts it to the default value.
        videoCodecType - Video codec profile types for Media Push. See . + Video codec profile types for Media Push. See . transcodingUsers -

        Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See .

        +

        Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See .

        @@ -663,7 +663,7 @@
        Deprecated
        -
        Obsolete and not recommended for use. Use instead.
        +
        Obsolete and not recommended for use. Use instead.
        @@ -677,7 +677,7 @@
        Deprecated
        -
        Obsolete and not recommended for use. Use instead.
        +
        Obsolete and not recommended for use. Use instead.

        The number of users in the Media Push. The value range is [0,17].

        @@ -698,25 +698,25 @@ watermark -

        The watermark on the live video. The image format needs to be PNG. See .

        +

        The watermark on the live video. The image format needs to be PNG. See .

        You can add one watermark, or add multiple watermarks using an array. This parameter is used with watermarkCount.

        backgroundImage -

        The number of background images on the live video. The image format needs to be PNG. See .

        +

        The number of background images on the live video. The image format needs to be PNG. See .

        You can add a background image or use an array to add multiple background images. This parameter is used with backgroundImageCount.

        backgroundImageArray - An array of background images on the live video. See . You can use backgroundImageArray to add one or more background images. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. + An array of background images on the live video. See . You can use backgroundImageArray to add one or more background images. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. audioSampleRate -

        The audio sampling rate (Hz) of the output media stream. See .

        +

        The audio sampling rate (Hz) of the output media stream. See .

        @@ -739,11 +739,11 @@ audioCodecProfile - Audio codec profile type for Media Push. See . + Audio codec profile type for Media Push. See . watermarkArray - The array of watermarks on the live video. See . You can add one or more watermarks using watermarkArray. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. + The array of watermarks on the live video. See . You can add one or more watermarks using watermarkArray. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. watermarkCount @@ -755,7 +755,7 @@ advancedFeatures - Advanced features of the Media Push with transcoding. See . + Advanced features of the Media Push with transcoding. See . advancedFeatureCount @@ -767,27 +767,27 @@ addBackgroundImage - Adds a background image. See . + Adds a background image. See . addUser - Adds a user for video mixing during the CDN live streaming. See . + Adds a user for video mixing during the CDN live streaming. See . addWatermark - Adds a watermark. See . + Adds a watermark. See . getAdvancedFeatures - Gets the status of the advanced features of streaming with transcoding. See . + Gets the status of the advanced features of streaming with transcoding. See . getBackgroundColor - Gets the background color in hex. See . + Gets the background color in hex. See . getBackgroundImageList - Gets the list of background images. See . + Gets the list of background images. See . getBlue @@ -798,7 +798,7 @@
        Obsolete and not recommended for use.
        -

        Gets the background color's blue component. See .

        +

        Gets the background color's blue component. See .

        @@ -810,7 +810,7 @@
        Obsolete and not recommended for use.
        -

        Gets the background color's green component. See .

        +

        Gets the background color's green component. See .

        @@ -822,44 +822,44 @@
        Obsolete and not recommended for use.
        -

        Gets the background color's red component. See .

        +

        Gets the background color's red component. See .

        getUserCount - Gets the number of users transcoded in the CDN live streaming. See . + Gets the number of users transcoded in the CDN live streaming. See . getUsers - Gets the user list in the CDN live streaming. See . + Gets the user list in the CDN live streaming. See . getWatermarkList - Gets the watermark list. See . + Gets the watermark list. See . removeBackgroundImage - Removes a background image from the background image list. See . + Removes a background image from the background image list. See . removeUser - Removes a user from video mixing during the CDN live streaming. See . + Removes a user from video mixing during the CDN live streaming. See . removeWatermark - Removes a watermark from the watermark list. See . + Removes a watermark from the watermark list. See . setAdvancedFeatures - Sets whether to enable the advanced features of streaming with transcoding. See . + Sets whether to enable the advanced features of streaming with transcoding. See . setBackgroundColor [1/2] - Sets the background color of the CDN live stream in the format of RGB hex. See . + Sets the background color of the CDN live stream in the format of RGB hex. See . setBackgroundColor [2/2] - Sets the background color in RGB format. See . + Sets the background color in RGB format. See . setBlue @@ -870,7 +870,7 @@
        Obsolete and not recommended for use.
        -

        Sets the background color's blue component. See .

        +

        Sets the background color's blue component. See .

        @@ -882,7 +882,7 @@
        Obsolete and not recommended for use.
        -

        Sets the background color's green component. See .

        +

        Sets the background color's green component. See .

        @@ -894,22 +894,22 @@
        Obsolete and not recommended for use.
        -

        Sets the background color's red component. See .

        +

        Sets the background color's red component. See .

        setUsers [1/2] - Sets the users in batches in the CDN live streaming. See . + Sets the users in batches in the CDN live streaming. See . setUsers [2/2] - Sets the users in batches in the CDN live streaming. See . + Sets the users in batches in the CDN live streaming. See . defaultTranscoding - Applies the default transcoding settings, see . + Applies the default transcoding settings, see .
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita index 1c28c605b5c..d94f8db1be2 100644 --- a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita @@ -1,24 +1,24 @@ - <ph keyref="LocalTranscoderConfiguration" /> + <ph keyref="LocalTranscoderConfiguration"/> The configuration of the video mixing on the local client.

        public class LocalTranscoderConfiguration { - public ArrayList<TranscodingVideoStream> transcodingVideoStreams; + public ArrayList<TranscodingVideoStream> transcodingVideoStreams; public VideoEncoderConfiguration videoOutputConfiguration; public LocalTranscoderConfiguration() { - transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); + transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); videoOutputConfiguration = new VideoEncoderConfiguration(); } } __attribute__((visibility("default"))) @interface AgoraLocalTranscoderConfiguration: NSObject -@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; +@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; @property (strong, nonatomic) AgoraVideoEncoderConfiguration *_Nonnull videoOutputConfiguration; @@ -68,19 +68,19 @@ class LocalTranscoderConfiguration { final int? streamCount; @JsonKey(name: 'videoInputStreams') - final List<TranscodingVideoStream>? videoInputStreams; + final List<TranscodingVideoStream>? videoInputStreams; @JsonKey(name: 'videoOutputConfiguration') final VideoEncoderConfiguration? videoOutputConfiguration; - factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => _$LocalTranscoderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); }

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> streamCount @@ -89,12 +89,12 @@ class LocalTranscoderConfiguration { videoInputStreams transcodingVideoStreams - The video streams for local video mixing. See . + The video streams for local video mixing. See . videoOutputConfiguration - The encoding configuration of the mixed video stream after the local video mixing. See . + The encoding configuration of the mixed video stream after the local video mixing. See .
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_localvideostats.dita b/en-US/dita/RTC-NG/API/class_localvideostats.dita index 8aa1b1f5ae7..109b362474a 100644 --- a/en-US/dita/RTC-NG/API/class_localvideostats.dita +++ b/en-US/dita/RTC-NG/API/class_localvideostats.dita @@ -1,7 +1,7 @@ - <ph keyref="LocalVideoStats" /> + <ph keyref="LocalVideoStats"/> The statistics of the local video stream.
        @@ -296,15 +296,15 @@ @JsonKey(name: 'hwEncoderAccelerating') final int? hwEncoderAccelerating; - factory LocalVideoStats.fromJson(Map<String, dynamic> json) => + factory LocalVideoStats.fromJson(Map<String, dynamic> json) => _$LocalVideoStatsFromJson(json); - Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); + Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); } -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> uid @@ -362,11 +362,11 @@ qualityAdaptIndication - The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

        + The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

          -
        • (0): The local video quality stays the same.
        • -
        • (1): The local video quality improves because the network bandwidth increases.
        • -
        • (2): The local video quality deteriorates because the network bandwidth decreases.
        • +
        • (0): The local video quality stays the same.
        • +
        • (1): The local video quality improves because the network bandwidth increases.
        • +
        • (2): The local video quality deteriorates because the network bandwidth decreases.

        @@ -390,11 +390,11 @@ codecType - The codec type of the local video. See .

        + The codec type of the local video. See .

          -
        • (1): VP8.
        • -
        • (2): (Default) H.264.
        • -
        • (3): H.265.
        • +
        • (1): VP8.
        • +
        • (2): (Default) H.264.
        • +
        • (3): H.265.

        @@ -408,24 +408,24 @@ captureBrightnessLevel - The brightness level of the video image captured by the local camera. See . + The brightness level of the video image captured by the local camera. See . captureBrightnessLevel The brightness level of the video image captured by the local camera.
          -
        • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
        • -
        • (0): The brightness level of the video image is normal.
        • -
        • (1): The brightness level of the video image is too bright.
        • -
        • (2): The brightness level of the video image is too dark.
        • +
        • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
        • +
        • (0): The brightness level of the video image is normal.
        • +
        • (1): The brightness level of the video image is too bright.
        • +
        • (2): The brightness level of the video image is too dark.
        hwEncoderAccelerating - The local video encoding acceleration type. See .
          + The local video encoding acceleration type. See .
          • 0: Software encoding is applied without acceleration.
          • 1: Hardware encoding is applied for acceleration.
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita index 0fce85b477d..e76727e38a1 100644 --- a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita @@ -93,12 +93,12 @@ @JsonKey(name: 'recorderInfoUpdateInterval') final int? recorderInfoUpdateInterval; - factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => + factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => _$MediaRecorderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); }
        -

        +

        @@ -109,10 +109,10 @@ storagePath The absolute path (including the filename extensions) of the recording file. For example:

          -
        • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
        • +
        • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
        • iOS: /App Sandbox/Library/Caches/example.mp4
        • macOS: ~/Library/Logs/example.mp4
        • -
        • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
        • +
        • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
        Ensure that the directory for the log files exists and is writable. @@ -123,7 +123,7 @@ streamType - The recording content. See . + The recording content. See . The recording content:
        • : Only audio.
        • : Only video.
        • @@ -140,4 +140,4 @@
        - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita index 3d76952e6e7..5f87bc7a086 100644 --- a/en-US/dita/RTC-NG/API/class_mediasource.dita +++ b/en-US/dita/RTC-NG/API/class_mediasource.dita @@ -1,7 +1,7 @@ - <ph keyref="MediaSource" /> + <ph keyref="MediaSource"/> Information related to the media file to be played and the playback scenario configurations.
        @@ -134,12 +134,12 @@ @JsonKey(name: 'isLiveSource') final bool? isLiveSource; - factory MediaSource.fromJson(Map<String, dynamic> json) => + factory MediaSource.fromJson(Map<String, dynamic> json) => _$MediaSourceFromJson(json); - Map<String, dynamic> toJson() => _$MediaSourceToJson(this); + Map<String, dynamic> toJson() => _$MediaSourceToJson(this); } -

        +

        <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -207,7 +207,7 @@ provider -

        The callback for custom media resource files. See .

        +

        The callback for custom media resource files. See .

        If you open a custom media resource, pass in the value to provider. If you open a common media resource, pass in the value to url. Agora recommends that you do not pass in values to both url and provider in one call; otherwise, this call may fail.

        @@ -216,19 +216,19 @@ playerOnReadCallback -

        Occurs when the SDK reads the media resource data. See .

        +

        Occurs when the SDK reads the media resource data. See .

        -

        +

        playerOnSeekCallback -

        Occurs when the SDK seeks the media resource data. See .

        +

        Occurs when the SDK seeks the media resource data. See .

        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita index 3ca7938fabc..c6dede7d234 100644 --- a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita @@ -260,10 +260,10 @@ @JsonKey(name: 'qualityChangedReason') final int? qualityChangedReason; - factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => + factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => _$RemoteAudioStatsFromJson(json); - Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); + Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); }

        @@ -278,7 +278,7 @@ quality -

        The quality of the audio stream sent by the user. See .

        +

        The quality of the audio stream sent by the user. See .

        • (0): The quality is unknown.
        • diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita index d8d2ccef7f4..a7d2f86a57d 100644 --- a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita +++ b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita @@ -1,8 +1,8 @@ - <ph keyref="RtcEngineConfig" /> - Configurations for the instance. + <ph keyref="RtcEngineConfig"/> + Configurations for the instance.

          @@ -214,25 +214,25 @@ class RtcEngineContext { @JsonKey(name: 'autoRegisterAgoraExtensions') final bool? autoRegisterAgoraExtensions; - factory RtcEngineContext.fromJson(Map<String, dynamic> json) => + factory RtcEngineContext.fromJson(Map<String, dynamic> json) => _$RtcEngineContextFromJson(json); - Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); + Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); } -

          +

          - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> eventHandler mEventHandler - The event handler for . See . + The event handler for . See . appId mAppId - The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. + The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. context @@ -256,33 +256,33 @@ class RtcEngineContext {
          • This method is applicable when you integrate the SDK manually but not when you integrate the SDK with Maven Central or JitPack.
          • -
          • Ensure the specified directory exists; otherwise, the initialization fails.
          • +
          • Ensure the specified directory exists; otherwise, the initialization fails.
          channelProfile mChannelProfile - + audioScenario mAudioScenario - + areaCode mAreaCode - The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. + The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. After specifying the region, the app integrated with the Agora SDK connects to the Agora servers within that region. logConfig mLogConfig -

          Sets the log file size. See .

          +

          Sets the log file size. See .

          By default, the SDK generates five SDK log files and five API call log files with the following rules:

            -
          • +
          @@ -292,19 +292,19 @@ class RtcEngineContext { mExtensionObserver eventDelegate - The instance. + The instance. mediaFilterExtensions - The instance. + The instance. mDomainLimit domainLimit

          Whether to enable domain name restriction:

            -
          • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
          • -
          • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
          • +
          • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
          • +
          • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.

          @@ -312,9 +312,9 @@ class RtcEngineContext { mAutoRegisterAgoraExtensions autoRegisterAgoraExtensions -

          Whether to automatically register the Agora extensions when initializing :

            -
          • : (Default) Automatically register the Agora extensions when initializing .
          • -
          • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.
          • +

            Whether to automatically register the Agora extensions when initializing :

              +
            • : (Default) Automatically register the Agora extensions when initializing .
            • +
            • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.

            @@ -324,9 +324,9 @@ class RtcEngineContext { addExtension - Adds the extension. See . + Adds the extension. See .
          -
          \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita index 0d43f31acc0..8d5a72b3fa8 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita @@ -101,7 +101,7 @@ __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguratio _$ScreenCaptureConfigurationFromJson(json); Map<String, dynamic> toJson() => _$ScreenCaptureConfigurationToJson(this); } -

          +

          <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita index 303f196dce1..8d41f2b02c2 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureParameters" /> + <ph keyref="ScreenCaptureParameters"/> Screen sharing configurations.

          - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureParameters: NSObject @property (assign, nonatomic) CGSize dimensions; @property (assign, nonatomic) NSInteger frameRate; @@ -206,7 +206,7 @@ final bool? windowFocus; @JsonKey(name: 'excludeWindowList') - final List<int>? excludeWindowList; + final List<int>? excludeWindowList; @JsonKey(name: 'excludeWindowCount') final int? excludeWindowCount; @@ -220,21 +220,21 @@ @JsonKey(name: 'enableHighLight') final bool? enableHighLight; - factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParametersFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); } -

          +

          - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> - The video profiles of the shared screen stream are only set by , independent of . + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + The video profiles of the shared screen stream are only set by , independent of . dimensions -

          The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

          +

          The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

          If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose dimensions is set to 1920 × 1080:

          • If the value of the screen dimensions is lower than that of dimensions, for example, 1000 × 1000 pixels, the SDK uses the screen dimensions, that is, 1000 × 1000 pixels, for encoding.
          • If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under dimensions with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 × 1080.
          • @@ -253,33 +253,33 @@ captureMouseCursor

            Whether to capture the mouse in screen sharing:

              -
            • : (Default) Capture the mouse.
            • -
            • : Do not capture the mouse.
            • +
            • : (Default) Capture the mouse.
            • +
            • : Do not capture the mouse.

            - Due to macOS system restrictions, setting this parameter to is ineffective during screen sharing (it has no impact when sharing a window). + Due to macOS system restrictions, setting this parameter to is ineffective during screen sharing (it has no impact when sharing a window).
            windowFocus -

            Whether to bring the window to the front when calling the method to share it:

              -
            • : Bring the window to the front.
            • -
            • : (Default) Do not bring the window to the front.
            • +

              Whether to bring the window to the front when calling the method to share it:

                +
              • : Bring the window to the front.
              • +
              • : (Default) Do not bring the window to the front.

              excludeWindowList - The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. + The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. highLighted enableHighLight (For macOS and Windows only) Whether to place a border around the shared window or screen:
                -
              • : Place a border.
              • -
              • : (Default) Do not place a border.
              • +
              • : Place a border.
              • +
              • : (Default) Do not place a border.
              - When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .
              + When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .
              highLightColor @@ -289,7 +289,7 @@ highLightWidth - (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . + (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . excludeWindowCount @@ -298,4 +298,4 @@
          -
          \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita index 0527a680bb0..c13c18f9924 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita @@ -1,7 +1,7 @@ - <ph keyref="ScreenCaptureParameters2" /> + <ph keyref="ScreenCaptureParameters2"/> Screen sharing configurations.
          @@ -169,58 +169,58 @@ @JsonKey(name: 'videoParams') final ScreenVideoParameters? videoParams; - factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParameters2FromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); } -

          +

          -

          +

          - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> captureAudio Determines whether to capture system audio during screen sharing:
            -
          • : Capture system audio.
          • -
          • : (Default) Do not capture system audio.
          • +
          • : Capture system audio.
          • +
          • : (Default) Do not capture system audio.
          • Due to system limitations, capturing system audio is only applicable to Android API level 29 and later (that is, Android 10 and later).
          • -
          • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
          +
        • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
        audioParams - The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . + The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . captureVideo Whether to capture the screen when screen sharing:
          -
        • : (Default) Capture the screen.
        • -
        • : Do not capture the screen.
        • +
        • : (Default) Capture the screen.
        • +
        • : Do not capture the screen.
        Due to system limitations, the capture screen is only applicable to Android API level 21 and above, that is, Android 5 and above.
        videoParams - The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is . + The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is .
        Subclass - - The video configuration for the shared screen stream. See . + + The video configuration for the shared screen stream. See . - - The audio configuration for the shared screen stream. See . + + The audio configuration for the shared screen stream. See .
        - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita index 034c9fbbfad..7e34c34419f 100644 --- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureSourceInfo" /> - The information about the specified shareable window or screen. The information is returned in . + <ph keyref="ScreenCaptureSourceInfo"/> + The information about the specified shareable window or screen. The information is returned in .

        - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureSourceInfo : NSObject @property(assign, nonatomic) AgoraScreenCaptureSourceType type; @property(assign, nonatomic) CGWindowID sourceId; @@ -76,7 +76,7 @@ public Rectangle position; public view_t sourceDisplayId; }; - + class ScreenCaptureSourceInfo { const ScreenCaptureSourceInfo( {this.type, @@ -124,19 +124,19 @@ @JsonKey(name: 'sourceDisplayId') final int? sourceDisplayId; - factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => _$ScreenCaptureSourceInfoFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); } -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> type - The type of the shared target. See . + The type of the shared target. See . sourceId @@ -148,11 +148,11 @@ thumbImage - The image content of the thumbnail. See . + The image content of the thumbnail. See . iconImage - The image content of the icon. See . + The image content of the icon. See . processPath @@ -165,19 +165,19 @@ primaryMonitor Determines whether the screen is the primary display:
          -
        • : The screen is the primary display.
        • -
        • : The screen is not the primary display.
        • +
        • : The screen is the primary display.
        • +
        • : The screen is not the primary display.
        position - The position of a window relative to the entire screen space (including all shareable screens). See . See . + The position of a window relative to the entire screen space (including all shareable screens). See . See . minimizeWindow (For Windows only) Whether the window is minimized:
          -
        • : The window is minimized.
        • -
        • : The window is not minimized.
        • +
        • : The window is minimized.
        • +
        • : The window is not minimized.
        @@ -186,4 +186,4 @@
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita index c523c274220..ac9c1655878 100644 --- a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita @@ -77,7 +77,7 @@ dimensions - The video dimension. See . The default value is 160 × 120. + The video dimension. See . The default value is 160 × 120. bitrate diff --git a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita index d6b9c671871..3d0308e16a3 100644 --- a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita +++ b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita @@ -1,7 +1,7 @@ - <ph keyref="TranscodingVideoStream" /> + <ph keyref="TranscodingVideoStream"/> The video streams for local video mixing.
        @@ -176,18 +176,18 @@ class TranscodingVideoStream { @JsonKey(name: 'mirror') final bool? mirror; - factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => + factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => _$TranscodingVideoStreamFromJson(json); - Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); + Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); }

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> sourceType - The video source type for local video mixing. See . + The video source type for local video mixing. See . remoteUserUid @@ -203,7 +203,7 @@ class TranscodingVideoStream { mediaPlayerId - (Optional) Media player ID. Use the parameter only when you set sourceType to . + (Optional) Media player ID. Use the parameter only when you set sourceType to . x @@ -246,4 +246,4 @@ class TranscodingVideoStream {
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita index c8ab6719214..e596c79a50d 100644 --- a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita +++ b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita @@ -53,7 +53,7 @@ _$UserAudioSpectrumInfoFromJson(json); Map<String, dynamic> toJson() => _$UserAudioSpectrumInfoToJson(this); } -

        +

        <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -67,7 +67,7 @@ audioSpectrumData spectrumData -

        Audio spectrum information of the remote user. See .

        +

        Audio spectrum information of the remote user. See .

        diff --git a/en-US/dita/RTC-NG/API/class_videocanvas.dita b/en-US/dita/RTC-NG/API/class_videocanvas.dita index 239a10a4f4c..802aaae693d 100644 --- a/en-US/dita/RTC-NG/API/class_videocanvas.dita +++ b/en-US/dita/RTC-NG/API/class_videocanvas.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoCanvas" /> + <ph keyref="VideoCanvas"/> Attributes of the video canvas object.
        @@ -173,16 +173,16 @@ class VideoCanvas { @JsonKey(name: 'enableAlphaMask') final bool? enableAlphaMask; - factory VideoCanvas.fromJson(Map<String, dynamic> json) => + factory VideoCanvas.fromJson(Map<String, dynamic> json) => _$VideoCanvasFromJson(json); - Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); + Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); } -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> view @@ -193,16 +193,16 @@ class VideoCanvas { renderMode - The rendering mode of the video. See . -
        + The rendering mode of the video. See . +
        mirrorMode -

        The mirror mode of the view. See .

        +

        The mirror mode of the view. See .

          -
        • +

          @@ -216,7 +216,7 @@ class VideoCanvas { sourceType - The type of the video source. See . + The type of the video source. See . sourceId @@ -224,29 +224,29 @@ class VideoCanvas { setupMode - Setting mode of the view. See . + Setting mode of the view. See . Setting mode of the view.
            -
          • (0): (Default) Replaces a view.
          • -
          • (1): Adds a view.
          • -
          • (2): Deletes a view.
          • +
          • (0): (Default) Replaces a view.
          • +
          • (1): Adds a view.
          • +
          • (2): Deletes a view.
          mediaPlayerId - The ID of the media player. You can get the Device ID by calling . - This parameter is required when sourceType is . + The ID of the media player. You can get the Device ID by calling . + This parameter is required when sourceType is . rect - (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. backgroundColor @@ -256,15 +256,15 @@ class VideoCanvas { enableAlphaMask

          (Optional) Whether the receiver enables alpha mask rendering:

            -
          • : The receiver enables alpha mask rendering.
          • -
          • : (default) The receiver disables alpha mask rendering.
          • +
          • : The receiver enables alpha mask rendering.
          • +
          • : (default) The receiver disables alpha mask rendering.

          Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as picture-in-picture and watermarking.

          -
          • This property applies to macOS only.
          • The receiver can render alpha channel information only when the sender enables alpha transmission.
          • To enable alpha transmission, .
          +
          • This property applies to macOS only.
          • The receiver can render alpha channel information only when the sender enables alpha transmission.
          • To enable alpha transmission, .
          Reserved.
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 1c603fff584..15fbcf7c09d 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoEncoderConfiguration" /> + <ph keyref="VideoEncoderConfiguration"/> Video encoder configurations.
        @@ -420,41 +420,43 @@ @JsonKey(name: 'advanceOptions') final AdvanceOptions? advanceOptions; - factory VideoEncoderConfiguration.fromJson(Map<String, dynamic> json) => + factory VideoEncoderConfiguration.fromJson(Map<String, dynamic> json) => _$VideoEncoderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); } -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text + conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" + /> dimensions -

        The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.

        +

        The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.

        Users can set the resolution by themselves, or directly select the desired resolution from the following list:

          -
        • : The video resolution is 120 × 120.
        • -
        • : The video resolution is 160 × 120.
        • -
        • : The video resolution is 180 × 180.
        • -
        • : The video resolution is 240 × 180.
        • -
        • : The video resolution is 320 × 180.
        • -
        • : The video resolution is 240 × 240.
        • -
        • : The video resolution is 320 × 240.
        • -
        • : The video resolution is 424 × 240.
        • -
        • : The video resolution is 360 × 360.
        • -
        • : The video resolution is 480 × 360.
        • -
        • : The video resolution is 640 × 360.
        • -
        • : The video resolution is 480 × 480.
        • -
        • : The video resolution is 640 × 480.
        • -
        • : The video resolution is 840 × 480.
        • -
        • : The video resolution is 960 × 540.
        • -
        • : The video resolution is 960 × 720.
        • -
        • : The video resolution is 1280 × 720.
        • -
        • : The video resolution is 1920 × 1080.
        • -
        • : The video resolution is 2540 × 1440.
        • -
        • : The video resolution is 3840 × 2160.
        • +
        • : The video resolution is 120 × 120.
        • +
        • : The video resolution is 160 × 120.
        • +
        • : The video resolution is 180 × 180.
        • +
        • : The video resolution is 240 × 180.
        • +
        • : The video resolution is 320 × 180.
        • +
        • : The video resolution is 240 × 240.
        • +
        • : The video resolution is 320 × 240.
        • +
        • : The video resolution is 424 × 240.
        • +
        • : The video resolution is 360 × 360.
        • +
        • : The video resolution is 480 × 360.
        • +
        • : The video resolution is 640 × 360.
        • +
        • : The video resolution is 480 × 480.
        • +
        • : The video resolution is 640 × 480.
        • +
        • : The video resolution is 840 × 480.
        • +
        • : The video resolution is 960 × 540.
        • +
        • : The video resolution is 960 × 720.
        • +
        • : The video resolution is 1280 × 720.
        • +
        • : The video resolution is 1920 × 1080.
        • +
        • : The video resolution is 2540 × 1440.
        • +
        • : The video resolution is 3840 × 2160.
          @@ -465,19 +467,19 @@ codecType - The codec type of the local video stream. See . + The codec type of the local video stream. See . frameRate - The frame rate (fps) of the encoding video frame. The default value is 15. See . + The frame rate (fps) of the encoding video frame. The default value is 15. See . bitrate -

          The encoding bitrate (Kbps) of the video. See .

          +

          The encoding bitrate (Kbps) of the video. See .

            -
          • -
          • +
          • +
          @@ -489,16 +491,16 @@ orientationMode - The orientation mode of the encoded video. See . + The orientation mode of the encoded video. See . degradationPreference - Video degradation preference under limited bandwidth. See . + Video degradation preference under limited bandwidth. See . mirrorMode -

          Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See .

          +

          Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See .

          The mirror mode specified in video encoder configurations only affect the view of remote users.

          • (0): The SDK determines whether to enable the mirror mode. The SDK disables mirror mode by default.
          • (1): Enables the mirror mode for remote users.
          • @@ -508,7 +510,7 @@ advanceOptions - Advanced options for video encoding. See . + Advanced options for video encoding. See .
        @@ -516,13 +518,13 @@ initWithSize - Specifies the video resolution and initializes the object. See . + Specifies the video resolution and initializes the object. See . initWithWidth - Specifies the video width and height, and initializes the object. See . + Specifies the video width and height, and initializes the object. See .
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita index 820f0dc0beb..6c92820296a 100644 --- a/en-US/dita/RTC-NG/API/class_videoframe.dita +++ b/en-US/dita/RTC-NG/API/class_videoframe.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoFrame" /> + <ph keyref="VideoFrame"/> Configurations of the video frame.
        @@ -476,28 +476,28 @@ class VideoFrame { final int? textureId; @JsonKey(name: 'matrix') - final List<double>? matrix; + final List<double>? matrix; @JsonKey(name: 'pixelBuffer', ignore: true) final Uint8List? pixelBuffer; - factory VideoFrame.fromJson(Map<String, dynamic> json) => + factory VideoFrame.fromJson(Map<String, dynamic> json) => _$VideoFrameFromJson(json); - Map<String, dynamic> toJson() => _$VideoFrameToJson(this); + Map<String, dynamic> toJson() => _$VideoFrameToJson(this); } -

        +

        Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> type - The pixel format. See . - + The pixel format. See . + width @@ -602,7 +602,7 @@ class VideoFrame { colorSpace - The color space of a video frame. See . + The color space of a video frame. See . sourceType @@ -620,9 +620,9 @@ class VideoFrame { alphaBuffer

        Indicates the alpha channel data output by the portrait segmentation algorithm, which is consistent with the size of the video frame. The value range of each pixel is [0,255], where 0 represents the background; 255 represents the foreground (portrait).

        -

        In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .

        +

        In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .

        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita index 3eb62b97334..ed72701605a 100644 --- a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoSubscriptionOptions" /> + <ph keyref="VideoSubscriptionOptions"/> Video subscription options.
        @@ -48,8 +48,8 @@ @end struct VideoSubscriptionOptions { - Optional<VIDEO_STREAM_TYPE> type; - Optional<bool> encodedFrameOnly; + Optional<VIDEO_STREAM_TYPE> type; + Optional<bool> encodedFrameOnly; VideoSubscriptionOptions() {} }; @@ -61,9 +61,9 @@ } public class VideoSubscriptionOptions:OptionalJsonParse { - public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<bool> encodedFrameOnly = new Optional<bool>(); + public Optional<bool> encodedFrameOnly = new Optional<bool>(); } export class VideoSubscriptionOptions { @@ -80,33 +80,33 @@ @JsonKey(name: 'encodedFrameOnly') final bool? encodedFrameOnly; - factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => + factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => _$VideoSubscriptionOptionsFromJson(json); - Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); + Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); } -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> streamType type - The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . + The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . The video stream type that you want to subscribe to:
          -
        • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
        • -
        • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
        • +
        • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
        • +
        • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
        encodedFrameOnly Whether to subscribe to encoded video frames only:
          -
        • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
        • -
        • : (Default) Subscribe to both raw video data and encoded video data.
        • +
        • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
        • +
        • : (Default) Subscribe to both raw video data and encoded video data.
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita index 51b194856e3..14f964b573c 100644 --- a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita +++ b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="WatermarkOptions" /> + <ph keyref="WatermarkOptions"/> Configurations of the watermark image.
        @@ -121,13 +121,13 @@ _$WatermarkOptionsFromJson(json); Map<String, dynamic> toJson() => _$WatermarkOptionsToJson(this); } -

        +

        -

        +

        - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> visibleInPreview @@ -135,8 +135,8 @@ positionInLandscapeMode - The area to display the watermark image in landscape mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . + The area to display the watermark image in landscape mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . The area to display the watermark image in landscape mode. This parameter contains the following members:
        • x: The horizontal position of the watermark relative to the upper left corner.
        • y: The vertical position of the watermark relative to the upper left corner.
        • @@ -146,8 +146,8 @@ positionInPortraitMode - The area to display the watermark image in portrait mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . + The area to display the watermark image in portrait mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . The area to display the watermark image in portrait mode. This parameter contains the following members:
          • x: The horizontal position of the watermark relative to the upper left corner.
          • y: The vertical position of the watermark relative to the upper left corner.
          • @@ -157,12 +157,12 @@ watermarkRatio - When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . + When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . mode - The adaptation mode of the watermark. See . + The adaptation mode of the watermark. See .
        -
        \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/enum_bitrate.dita b/en-US/dita/RTC-NG/API/enum_bitrate.dita index dd052073c18..5ca1d506826 100644 --- a/en-US/dita/RTC-NG/API/enum_bitrate.dita +++ b/en-US/dita/RTC-NG/API/enum_bitrate.dita @@ -9,7 +9,7 @@ - 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See . + 0: (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See . From 5d67bbd152be9dc3c7d5c3ef68ab9fc3228b1d3b Mon Sep 17 00:00:00 2001 From: jinyuagora Date: Tue, 26 Sep 2023 07:15:44 +0000 Subject: [PATCH 4/6] Sync cn prototype to en prototype --- ...onfiguration_getdestchannelmediainfos.dita | 24 +- ...icemanager_followsystemloopbackdevice.dita | 4 +- ...evicemanager_getplaybackdefaultdevice.dita | 22 +- ...vicemanager_getrecordingdefaultdevice.dita | 22 +- ...iaudiodevicemanager_setloopbackdevice.dita | 4 +- ...evicemanager_setrecordingdevicevolume.dita | 4 +- .../api_ibasespatialaudioengine_setzones.dita | 2 +- ...laudioengine_updateplayerpositioninfo.dita | 14 +- ...i_ilocalspatialaudioengine_initialize.dita | 28 +-- ...atialaudioengine_updateremoteposition.dita | 12 +- .../API/api_imediaengine_addlistener.dita | 30 +-- ...i_imediaengine_createcustomaudiotrack.dita | 18 +- .../API/api_imediaengine_pushaudioframe.dita | 26 +-- .../API/api_imediaengine_pushaudioframe0.dita | 10 +- ...pi_imediaengine_pushencodedvideoimage.dita | 24 +- .../API/api_imediaengine_pushvideoframe.dita | 24 +- ...ediaengine_registeraudioframeobserver.dita | 34 +-- ...ine_registervideoencodedframeobserver.dita | 38 +-- ...ediaengine_registervideoframeobserver.dita | 34 +-- ...iaengine_unregisteraudioframeobserver.dita | 6 +- ...e_unregistervideoencodedframeobserver.dita | 6 +- ...iaengine_unregistervideoframeobserver.dita | 6 +- .../API/api_imediaplayer_addlistener.dita | 28 +-- ...api_imediaplayer_openwithcustomsource.dita | 2 +- ...ediaplayer_registervideoframeobserver.dita | 22 +- .../API/api_imediaplayer_setrendermode.dita | 8 +- ...pi_imediaplayer_setspatialaudioparams.dita | 8 +- ...iaplayer_unregistervideoframeobserver.dita | 4 +- .../API/api_imediarecorder_addlistener.dita | 28 +-- ...ediarecorder_setmediarecorderobserver.dita | 2 +- .../api_imediarecorder_startrecording.dita | 28 +-- .../RTC-NG/API/api_irtcengine_addhandler.dita | 4 +- .../API/api_irtcengine_addlistener.dita | 28 +-- .../api_irtcengine_configrhythmplayer.dita | 24 +- .../API/api_irtcengine_createdatastream2.dita | 6 +- .../api_irtcengine_enablecontentinspect.dita | 4 +- .../api_irtcengine_enabledualstreammode2.dita | 8 +- .../api_irtcengine_enabledualstreammode3.dita | 24 +- .../API/api_irtcengine_enableencryption.dita | 6 +- ...api_irtcengine_enableinearmonitoring2.dita | 28 +-- .../API/api_irtcengine_enablemulticamera.dita | 40 ++-- ...pi_irtcengine_enablevirtualbackground.dita | 36 +-- .../api_irtcengine_getextensionproperty2.dita | 16 +- ...pi_irtcengine_getscreencapturesources.dita | 4 +- .../RTC-NG/API/api_irtcengine_initialize.dita | 34 +-- ...irtcengine_isfeatureavailableondevice.dita | 8 +- .../API/api_irtcengine_joinchannel2.dita | 14 +- .../api_irtcengine_loadextensionprovider.dita | 4 +- .../API/api_irtcengine_preloadchannel.dita | 26 +-- .../api_irtcengine_pushreverseaudioframe.dita | 8 +- .../API/api_irtcengine_pushvideoframe2.dita | 30 +-- .../api_irtcengine_querycodeccapability.dita | 34 +-- ...tcengine_queryscreencapturecapability.dita | 22 +- ...ine_registeraudioencodedframeobserver.dita | 12 +- ...cengine_registeraudiospectrumobserver.dita | 12 +- .../API/api_irtcengine_registerextension.dita | 4 +- ...cengine_registermediametadataobserver.dita | 10 +- .../API/api_irtcengine_removehandler.dita | 8 +- .../API/api_irtcengine_sendmetadata.dita | 14 +- ...pi_irtcengine_setadvancedaudiooptions.dita | 10 +- ...irtcengine_setaudiomixingdualmonomode.dita | 10 +- ...pi_irtcengine_setcameraexposurefactor.dita | 2 +- .../API/api_irtcengine_setchannelprofile.dita | 10 +- .../API/api_irtcengine_setclientrole.dita | 4 +- .../API/api_irtcengine_setclientrole2.dita | 12 +- ...api_irtcengine_setcolorenhanceoptions.dita | 18 +- .../API/api_irtcengine_setdualstreammode.dita | 30 +-- .../api_irtcengine_setdualstreammode2.dita | 32 +-- ...tcengine_setexternalaudiosourcevolume.dita | 24 +- .../api_irtcengine_setheadphoneeqpreset.dita | 16 +- .../api_irtcengine_setlivetranscoding.dita | 8 +- .../api_irtcengine_setlocalaccesspoint.dita | 10 +- ...cengine_setlocalpublishfallbackoption.dita | 8 +- .../api_irtcengine_setlocalrendermode.dita | 8 +- .../api_irtcengine_setlocalrendermode2.dita | 10 +- ...pi_irtcengine_setlocalvideomirrormode.dita | 8 +- ..._irtcengine_setlowlightenhanceoptions.dita | 16 +- ...ngine_setremoteuserspatialaudioparams.dita | 8 +- ...rtcengine_setscreencapturecontenthint.dita | 6 +- .../API/api_irtcengine_setuplocalvideo.dita | 14 +- .../API/api_irtcengine_setupremotevideo.dita | 24 +- ...pi_irtcengine_setvideodenoiseroptions.dita | 34 +-- ...tcengine_setvideoencoderconfiguration.dita | 24 +- .../API/api_irtcengine_setvideoprofile.dita | 26 +-- .../api_irtcengine_startaudiorecording3.dita | 8 +- .../api_irtcengine_startcameracapture.dita | 24 +- ...api_irtcengine_startchannelmediarelay.dita | 24 +- ...pi_irtcengine_startdirectcdnstreaming.dita | 14 +- .../API/api_irtcengine_startechotest3.dita | 16 +- ...engine_startorupdatechannelmediarelay.dita | 24 +- .../API/api_irtcengine_startrhythmplayer.dita | 26 +-- .../api_irtcengine_startscreencapture.dita | 30 +-- .../api_irtcengine_startscreencapture2.dita | 28 +-- ...cengine_startscreencapturebydisplayid.dita | 6 +- ...engine_startscreencapturebyscreenrect.dita | 6 +- ...tcengine_startscreencapturebywindowid.dita | 6 +- .../API/api_irtcengine_switchchannel2.dita | 30 +-- ...e_unregisteraudioencodedframeobserver.dita | 20 +- ...tcengine_unregisteraudioframeobserver.dita | 8 +- .../api_irtcengine_updatescreencapture.dita | 14 +- ...cengine_updatescreencaptureparameters.dita | 6 +- ..._irtcengine_updatescreencaptureregion.dita | 6 +- ...irtcengine_updatescreencaptureregion2.dita | 20 +- .../api_irtcengineex_createdatastreamex2.dita | 4 +- ...i_irtcengineex_enablecontentinspectex.dita | 4 +- .../API/api_irtcengineex_joinchannelex.dita | 30 +-- .../api_irtcengineex_setdualstreammodeex.dita | 34 +-- .../api_irtcengineex_setupremotevideoex.dita | 8 +- ...gineex_setvideoencoderconfigurationex.dita | 8 +- ...irtcengineex_startchannelmediarelayex.dita | 30 +-- ...neex_startorupdatechannelmediarelayex.dita | 28 +-- ...api_ivideodevicemanager_getcapability.dita | 6 +- .../api_ivideodevicemanager_setdevice.dita | 4 +- .../class_Localaccesspointconfiguration.dita | 31 ++- .../dita/RTC-NG/API/class_advanceoptions.dita | 18 +- en-US/dita/RTC-NG/API/class_audioparams.dita | 38 +-- .../class_audiorecordingconfiguration.dita | 6 +- .../class_cameracapturerconfiguration.dita | 24 +- .../RTC-NG/API/class_channelmediaoptions.dita | 216 +++++++++--------- .../class_channelmediarelayconfiguration.dita | 40 ++-- en-US/dita/RTC-NG/API/class_codeccapinfo.dita | 18 +- .../dita/RTC-NG/API/class_codeccaplevels.dita | 16 +- .../API/class_contentinspectconfig.dita | 22 +- .../API/class_contentinspectmodule.dita | 16 +- .../API/class_encodedvideoframeinfo.dita | 14 +- .../RTC-NG/API/class_externalvideoframe.dita | 40 ++-- .../RTC-NG/API/class_injectstreamconfig.dita | 2 +- .../RTC-NG/API/class_livetranscoding.dita | 96 ++++---- .../class_localtranscoderconfiguration.dita | 22 +- .../RTC-NG/API/class_localvideostats.dita | 40 ++-- .../API/class_mediarecorderconfiguration.dita | 14 +- en-US/dita/RTC-NG/API/class_mediasource.dita | 18 +- .../RTC-NG/API/class_remoteaudiostats.dita | 4 +- .../RTC-NG/API/class_rtcengineconfig.dita | 46 ++-- .../API/class_screencaptureconfiguration.dita | 2 +- .../API/class_screencaptureparameters.dita | 42 ++-- .../API/class_screencaptureparameters2.dita | 36 +-- .../API/class_screencapturesourceinfo.dita | 34 +-- .../API/class_transcodingvideostream.dita | 14 +- .../API/class_useraudiospectruminfo.dita | 2 +- en-US/dita/RTC-NG/API/class_videocanvas.dita | 46 ++-- .../API/class_videoencoderconfiguration.dita | 78 +++---- en-US/dita/RTC-NG/API/class_videoframe.dita | 22 +- .../API/class_videosubscriptionoptions.dita | 30 +-- .../RTC-NG/API/class_watermarkoptions.dita | 22 +- 145 files changed, 1450 insertions(+), 1453 deletions(-) diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita index cc6bb339b4d..321808ad597 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita @@ -1,32 +1,32 @@ - <ph keyref="getDestChannelMediaInfos"/> + <ph keyref="getDestChannelMediaInfos" /> Gets the information of the target channel. - +

        - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } - - - - - - -

        + + + + + + +

        Returns -

        The information of the target channel. See .

        +

        The information of the target channel. See .

        -
        + \ 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 859d04cd660..dfb04765049 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita @@ -13,8 +13,8 @@

        - - + + virtual int followSystemLoopbackDevice(bool enable) = 0; abstract followSystemLoopbackDevice(enable: boolean): number; public abstract int FollowSystemLoopbackDevice(bool enable); diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita index f6e16bd18d9..d292c20dc70 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getPlaybackDefaultDevice"/> + <ph keyref="getPlaybackDefaultDevice" /> Gets the default audio playback device. - +

        - - - + + + abstract getPlaybackDefaultDevice(): AudioDeviceInfo; public abstract int GetPlaybackDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getPlaybackDefaultDevice(); -

        + + Future<AudioDeviceInfo> getPlaybackDefaultDevice(); +

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

        The details about the default audio playback device. See .

        +

        The details about the default audio playback device. See .

        • 0: Success.
        • -
        • < 0: Failure. See for details and resolution suggestions.
        • +
        • < 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_getrecordingdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita index bba32a04a95..5dda26e2174 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getRecordingDefaultDevice"/> + <ph keyref="getRecordingDefaultDevice" /> Gets the default audio capture device. - +

        - - - + + + abstract getRecordingDefaultDevice(): AudioDeviceInfo; public abstract int GetRecordingDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getRecordingDefaultDevice(); -

        + + Future<AudioDeviceInfo> getRecordingDefaultDevice(); +

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

        The details about the default audio capture device. See .

        +

        The details about the default audio capture device. See .

        • 0: Success.
        • -
        • < 0: Failure. See for details and resolution suggestions.
        • +
        • < 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_setloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita index 4b5cb13a1f5..92ec968f351 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita @@ -13,8 +13,8 @@

        - - + + virtual int setLoopbackDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract setLoopbackDevice(deviceId: string): number; public abstract int SetLoopbackDevice(string deviceId); 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 637a78656bb..a96c9d528d9 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita @@ -13,8 +13,8 @@

        - - + + virtual int setRecordingDeviceVolume(int volume) = 0; abstract setRecordingDeviceVolume(volume: number): number; public abstract int SetRecordingDeviceVolume(int volume); 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 9829d4581e8..322f0a1e688 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita @@ -14,7 +14,7 @@

        public abstract int setZones(SpatialAudioZone[] zones); - - (int)setZones:(NSArray<AgoraSpatialAudioZone*> * _Nonnull)zones; + - (int)setZones:(NSArray<AgoraSpatialAudioZone*> * _Nonnull)zones; virtual int setZones(const SpatialAudioZone *zones, unsigned int zoneCount) = 0; abstract setZones(zones: SpatialAudioZone, zoneCount: number): number; public abstract int SetZones(SpatialAudioZone[] zones, uint zoneCount); diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita index d39782b61b8..41be2d7b2b0 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita @@ -25,9 +25,9 @@ playerId: number, positionInfo: RemoteVoicePositionInfo ): number; - Future<void> updatePlayerPositionInfo( + Future<void> updatePlayerPositionInfo( {required int playerId, required RemoteVoicePositionInfo positionInfo}); -

        +

        Details @@ -42,15 +42,15 @@ positionInfo - The spatial position of the media player. See . + The spatial position of the media player. 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_ilocalspatialaudioengine_initialize.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita index c535e0b3930..8b80ee04d57 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita @@ -1,12 +1,12 @@ - <ph keyref="initialize_ILocalSpatialAudioEngine"/> - Initializes . + <ph keyref="initialize_ILocalSpatialAudioEngine" /> + Initializes . - + @@ -19,32 +19,32 @@ abstract initialize(): number; public abstract int Initialize(); abstract initialize(): number; - Future<void> initialize(); -

        + Future<void> initialize(); +

        Details
          -
        • Call this method after calling ().
        • -
        • Call this method after calling .
        • -
        • Before calling other methods of the class, you need to call this method to initialize .
        • -
        • The SDK supports creating only one instance for an app.
        • +
        • Call this method after calling ().
        • +
        • Call this method after calling .
        • +
        • Before calling other methods of the class, you need to call this method to initialize .
        • +
        • The SDK supports creating only one instance for an app.
        Parameters config - The configuration of . See . + The configuration of . 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_ilocalspatialaudioengine_updateremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita index c88449f8031..ab6fb4932a0 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita @@ -25,9 +25,9 @@ uid: number, posInfo: RemoteVoicePositionInfo ): number; - Future<void> updateRemotePosition( + Future<void> updateRemotePosition( {required int uid, required RemoteVoicePositionInfo posInfo}); -

        +

        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_imediaengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita index f97153f4d5e..0e006691d30 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita @@ -1,49 +1,49 @@ - <ph keyref="addListener_IMediaEngine"/> - Adds one listener. + <ph keyref="addListener_IMediaEngine" /> + Adds one listener. - +

        - - - - addListener?<EventType extends keyof IMediaEngineEvent>( + + + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaEngineEvent>( + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - -

        + +

        Details -

        After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

        +

        After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

        Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
        -
        + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita index 6c268bd0b21..4b3d1d972c6 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="createCustomAudioTrack"/> + <ph keyref="createCustomAudioTrack" /> Creates a custom audio track. - + @@ -27,9 +27,9 @@ trackType: AudioTrackType, config: AudioTrackConfig ): number; - Future<int> createCustomAudioTrack( + Future<int> createCustomAudioTrack( {required AudioTrackType trackType, required AudioTrackConfig config}); -

        +

        Details @@ -41,8 +41,8 @@

        To publish a custom audio source to multiple channels, see the following steps:

        1. Call this method to create a custom audio track and get the audio track ID.
        2. -
        3. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
        4. -
        5. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
        6. +
        7. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
        8. +
        9. If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.

        @@ -50,11 +50,11 @@ trackType - The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. + The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2. config - The configuration of the custom audio track. See . + The configuration of the custom audio track. See .
        @@ -64,4 +64,4 @@
      • If the method call fails, a negative value is returned.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita index 6dc1f62db49..2ea5558608d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita @@ -1,12 +1,12 @@ - <ph keyref="pushAudioFrame1"/> + <ph keyref="pushAudioFrame1" /> Pushes the external audio frame. - + @@ -18,19 +18,19 @@ samples:(NSInteger)samples sourceId:(NSInteger)sourceId timestamp:(NSTimeInterval)timestamp; - - - - - -

      + + + + + +

      Parameters frame - The external audio frame. See . + The external audio frame. See . @@ -49,8 +49,8 @@ - - + +
      @@ -58,8 +58,8 @@

      • 0: Success.
      • -
      • < 0: Failure. See for details and resolution suggestions.
      • +
      • < 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_pushaudioframe0.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita index 67b8b41e30f..b654872595a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita @@ -19,8 +19,8 @@ abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number; public abstract int PushAudioFrame(AudioFrame frame, uint trackId = 0); abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number; - Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0}); -

      + Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0}); +

      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_imediaengine_pushencodedvideoimage.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita index 3089be0921a..956b45fb433 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita @@ -1,12 +1,12 @@ - <ph keyref="pushEncodedVideoImage"/> + <ph keyref="pushEncodedVideoImage" /> Pushes the external encoded video frame to the SDK. - + @@ -16,7 +16,7 @@ public abstract int pushExternalEncodedVideoFrame( ByteBuffer data, EncodedVideoFrameInfo frameInfo); videoTrackId:(NSUInteger)videoTrackId; - + virtual int pushEncodedVideoImage(const uint8_t* imageBuffer, size_t length, const agora::rtc::EncodedVideoFrameInfo& videoEncodedFrameInfo) = 0; abstract pushEncodedVideoImage( @@ -32,16 +32,16 @@ videoEncodedFrameInfo: EncodedVideoFrameInfo, videoTrackId?: number ): number; - Future<void> pushEncodedVideoImage( + Future<void> pushEncodedVideoImage( {required Uint8List imageBuffer, required int length, required EncodedVideoFrameInfo videoEncodedFrameInfo, int videoTrackId = 0}); -

      +

      Details -

      After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

      +

      After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.

      Parameters @@ -58,19 +58,19 @@ frameInfo videoEncodedFrameInfo - Information about externally encoded video frames. See . + Information about externally encoded video frames. 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: Pushes the external encoded video frame to the SDK successfully.
      • < 0: Fails to push external encoded video frames to the SDK.
      -
      + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index 817e0b960b9..012364cc717 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -25,20 +25,20 @@ frame: ExternalVideoFrame, videoTrackId?: number ): number;
      - Future<void> pushVideoFrame( + Future<void> pushVideoFrame( {required ExternalVideoFrame frame, int videoTrackId = 0}); -

      +

      Details
      Deprecated:
      -
      If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
      +
      If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
      -

      If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

      -

      You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

      +

      If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.

      +

      You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.

      Applicable scenarios @@ -55,19 +55,19 @@ videoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value 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.
        -
      • : Pushes the external raw video frame to the SDK successfully.
      • -
      • : Fails to push external raw video frame to the SDK.
      • +
      • : Pushes the external raw video frame to the SDK successfully.
      • +
      • : Fails to push external raw video frame to the SDK.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index 6306b54e451..f975af88eb9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerAudioFrameObserver"/> + <ph keyref="registerAudioFrameObserver" /> Registers an audio frame observer object. - + @@ -20,11 +20,11 @@ public abstract int RegisterAudioFrameObserver(IAudioFrameObserver audioFrameObserver, AUDIO_FRAME_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR); abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number; void registerAudioFrameObserver(AudioFrameObserver observer); -

      +

      Details -

      Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.

      +

      Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.

      Ensure that you call this method before joining a channel.
      Parameters @@ -34,35 +34,35 @@ delegate audioFrameObserver -

      The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

      +

      The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

      mode - The audio data callback mode. See . + The audio data callback mode. See . position The frame position of the audio observer.
        -
      • (0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
      • -
      • (0x0002): This position can observe the collected local user's audio, corresponding to the callback.
      • -
      • (0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
      • -
      • (0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
      • -
      • (0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to the callback.
      • +
      • (0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
      • +
      • (0x0002): This position can observe the collected local user's audio, corresponding to the callback.
      • +
      • (0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
      • +
      • (0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
      • +
      • (0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to 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.
        -
      • : 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_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index a7dbcb2910f..ada50c18b18 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoEncodedFrameObserver"/> + <ph keyref="registerVideoEncodedFrameObserver" /> Registers a receiver object for the encoded video image. - + @@ -25,18 +25,18 @@ observer: IVideoEncodedFrameObserver ): number;
      void registerVideoEncodedFrameObserver(VideoEncodedFrameObserver observer); -

      +

      Details -

      If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

      +

      If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.

      If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:

        -
      1. Call to register the raw video frame observer before joining the channel.
      2. -
      3. Call to register the encoded video frame observer before joining the channel.
      4. -
      5. After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
      6. -
      7. Call ()to start receiving the video streams of all remote users. Then:
          -
        • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
        • -
        • The encoded video data of group B users can be obtained through the callback in .
        • +
        • Call to register the raw video frame observer before joining the channel.
        • +
        • Call to register the encoded video frame observer before joining the channel.
        • +
        • After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
        • +
        • Call ()to start receiving the video streams of all remote users. Then:
            +
          • The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
          • +
          • The encoded video data of group B users can be obtained through the callback in .

      @@ -51,24 +51,24 @@ receiver observer videoEncodedImageReceiver - The video frame observer object. See . - The observer instance. See . Set the value as to release the instance. + The video frame observer object. See . + The observer instance. See . Set the value as to release the instance. mode - The video data callback mode. See . + The video data callback mode. 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_imediaengine_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index 7336c0710fd..554513bc41a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoFrameObserver"/> + <ph keyref="registerVideoFrameObserver" /> Registers a raw video frame observer object. - + @@ -20,13 +20,13 @@ public abstract int RegisterVideoFrameObserver(IVideoFrameObserver videoFrameObserver, VIDEO_OBSERVER_FRAME_TYPE formatPreference, VIDEO_OBSERVER_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR); abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number; void registerVideoFrameObserver(VideoFrameObserver observer); -

      +

      Details -

      If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one class with this method.

      -

      When calling this method to register a video observer, you can register callbacks in the class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

      -

      +

      If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one class with this method.

      +

      When calling this method to register a video observer, you can register callbacks in the class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

      +

      • Ensure that you call this method before joining a channel.
      • @@ -35,7 +35,7 @@
      • If the user adjusts the video profile, the resolution of the video returned in the callbacks also changes.
    - After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as implementing virtual backgrounds and image enhacement scenarios by yourself, Agora provides an open source sample project on GitHub for your reference. + After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as implementing virtual backgrounds and image enhacement scenarios by yourself, Agora provides an open source sample project on GitHub for your reference.
    Parameters @@ -43,31 +43,31 @@ observer delegate videoFrameObserver - The observer instance. See . To release the instance, set the value as . + The observer instance. See . To release the instance, set the value as . mode - The video data callback mode. See . + The video data callback mode. See . formatPreference - The video frame type. See . + The video frame type. See . position - A bit mask that controls the frame position of the video observer. See . + A bit mask that controls the frame position of the video 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.
      -
    • : 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_imediaengine_unregisteraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita index bb1a4be2904..211d08fa6e0 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita @@ -13,9 +13,9 @@

    - - - + + + abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; 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 eec2c041884..28d65a834bc 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita @@ -13,9 +13,9 @@

    - - - + + + abstract unregisterVideoEncodedFrameObserver( observer: IVideoEncodedFrameObserver ): number; 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 bcc3f3b6471..4b8bc590185 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita @@ -13,9 +13,9 @@

    - - - + + + abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number; public abstract int UnRegisterVideoFrameObserver(); abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number; diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita index 0c96f2ee242..9ce3923ca0f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaPlayer"/> - Adds one listener. + <ph keyref="addListener_IMediaPlayer" /> + Adds one listener. - +

    - - - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; -

    +

    Details -

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    +

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita index 52b72c3ea03..382bad72cf6 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita @@ -62,7 +62,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_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita index 265f22f4008..75da81cd9c3 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="registerVideoFrameObserver_IMediaPlayer"/> + <ph keyref="registerVideoFrameObserver_IMediaPlayer" /> Registers a video frame observer object. - + @@ -14,7 +14,7 @@

    int registerVideoFrameObserver(IMediaPlayerVideoFrameObserver videoFrameObserver); - + virtual int registerVideoFrameObserver(media::base::IVideoFrameObserver* observer) = 0; abstract registerVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver @@ -24,11 +24,11 @@ observer: IMediaPlayerVideoFrameObserver ): number; void registerVideoFrameObserver(MediaPlayerVideoFrameObserver 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 @@ -36,16 +36,16 @@ videoFrameObserver observer - The video observer, reporting the reception of each video frame. See . - The video observer, reporting the reception of each video frame. See . + 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_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index 4f26670ac9b..ccfebbc3a14 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita @@ -22,7 +22,7 @@ public abstract int SetRenderMode(RENDER_MODE_TYPE renderMode); abstract setRenderMode(renderMode: RenderModeType): number; Future<void> setRenderMode(RenderModeType renderMode); -

    +

    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_imediaplayer_setspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita index d1d7c3bcf2b..10edd81c0d5 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita @@ -20,7 +20,7 @@ public abstract int SetSpatialAudioParams(SpatialAudioParams spatial_audio_params); abstract setSpatialAudioParams(params: SpatialAudioParams): number; Future<void> setSpatialAudioParams(SpatialAudioParams params); -

    +

    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_imediaplayer_unregistervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita index c66d27ef186..bd3fbb0a092 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita @@ -13,8 +13,8 @@

    - - + + virtual int unregisterVideoFrameObserver(agora::media::base::IVideoFrameObserver* observer) = 0; abstract unregisterVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita index dc6238f2f49..344aa0cebdb 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener_IMediaRecorder"/> - Adds one listener. + <ph keyref="addListener_IMediaRecorder" /> + Adds one listener. - +

    - - - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; -

    +

    Details -

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    +

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; + The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {}; engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
    - + \ 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 675d4b37e2a..4f64c5d5753 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita @@ -14,7 +14,7 @@

    public int setMediaRecorderObserver(IMediaRecorderCallback callback) - - (int)setMediaRecorderDelegate:(id<AgoraMediaRecorderDelegate> _Nullable)delegate; + - (int)setMediaRecorderDelegate:(id<AgoraMediaRecorderDelegate> _Nullable)delegate; virtual int setMediaRecorderObserver(media::IMediaRecorderObserver* callback) = 0; abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number; public abstract int SetMediaRecorderObserver(IMediaRecorderObserver callback); diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita index 71e7e039395..e17f2cd5ec8 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita @@ -1,12 +1,12 @@ - <ph keyref="startRecording"/> + <ph keyref="startRecording" /> Starts recording audio and video streams. - + @@ -19,15 +19,15 @@ abstract startRecording(config: MediaRecorderConfiguration): number; public abstract int StartRecording(MediaRecorderConfiguration config); abstract startRecording(config: MediaRecorderConfiguration): number; - Future<void> startRecording(MediaRecorderConfiguration config); -

    + Future<void> startRecording(MediaRecorderConfiguration config); +

    Details

    You can call this method to enable the recording function. Agora supports recording the media streams of local and remote users at the same time.

    Before you call this method, ensure the following:

      -
    • The recording object is created through .
    • -
    • The recording observer is registered through .
    • +
    • The recording object is created through .
    • +
    • The recording observer is registered through .
    • You have joined the channel which the remote user that you want to record is in.

    Supported formats of recording are listed as below:

      @@ -35,7 +35,7 @@
    • Video captured by a camera and encoded in H.264 or H.265.

    Once the recording is started, if the video resolution is changed, the SDK stops the recording; if the sampling rate and audio channel changes, the SDK continues recording and generates audio files respectively.

    -

    The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the (, ) callback.

    +

    The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the (, ) callback.

      @@ -47,23 +47,23 @@ config - The recording configuration. See . + The recording configuration. 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.
        • -2: The parameter is invalid. Ensure the following:
          • The specified path of the recording file exists and is writable.
          • The specified format of the recording file is supported.
          • The maximum recording duration is correctly set.
        • -
        • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
        • -
        • -7: The method is called before is initialized. Ensure the object is created before calling this method.
        • +
        • -4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
        • +
        • -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 878a0fe6b29..1f012b33859 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita @@ -16,8 +16,8 @@ public void addHandler(IRtcEngineEventHandler handler) { mInstance.addHandler(handler); } - - + + abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean; public abstract int InitEventHandler(IRtcEngineEventHandler engineEventHandler); abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean; diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita index 028041b353b..a21fcc70f63 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita @@ -1,48 +1,48 @@ - <ph keyref="addListener"/> - Adds one listener. + <ph keyref="addListener" /> + Adds one listener. - +

    - - - - addListener?<EventType extends keyof IRtcEngineEvent>( + + + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IRtcEngineEvent>( + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; -

    +

    Details -

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    +

    After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.

    Parameters eventType - The name of the target event to listen for. See . + The name of the target event to listen for. See . listener - The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; + The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 1d99052821f..3dcfc29a661 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="configRhythmPlayer"/> + <ph keyref="configRhythmPlayer" /> Configures the virtual metronome. - + @@ -19,28 +19,28 @@ abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; public abstract int ConfigRhythmPlayer(AgoraRhythmPlayerConfig config); abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number; - Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); -

    + Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config); +

    Details -

    After calling , you can call this method to reconfigure the virtual metronome.

    -

    After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

    -
    +

    After calling , you can call this method to reconfigure the virtual metronome.

    +

    After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

    +
    Parameters config - The metronome configuration. See . + The metronome configuration. 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_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index d0e0c7ad951..a3ca1a6757b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -21,7 +21,7 @@ public abstract int CreateDataStream(ref int streamId, DataStreamConfig config); abstract createDataStream(config: DataStreamConfig): number; Future<int> createDataStream(DataStreamConfig config); -

    +

    Details @@ -45,7 +45,7 @@
    • 0: The data stream is successfully created.
    • ID of the created data stream, if the 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_enablecontentinspect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index 3bf277a812e..b93e97a3a61 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -31,8 +31,8 @@
    Details -

    When video screenshot and upload function is enabled, the SDK takes screenshots and uploads 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 uploads 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 diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita index f79c8b4f19b..79876008572 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita @@ -28,14 +28,14 @@ streamConfig?: SimulcastStreamConfig ): number; Future<void> enableDualStreamMode(bool enabled); -

    +

    Details
    Deprecated:
    -
    This method is deprecated as of v4.2.0. Use instead.
    +
    This method is deprecated as of v4.2.0. Use instead.

    You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream:

      @@ -46,7 +46,7 @@
      • 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.
      • -
      • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
      • +
      • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
      • You can call this method either before or after joining a channel.
    @@ -72,7 +72,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_enabledualstreammode3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita index 5ff70d41a58..57fd1fc4aba 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita @@ -1,12 +1,12 @@ - <ph keyref="enableDualStreamMode3"/> + <ph keyref="enableDualStreamMode3" /> Enables or disables the dual-stream mode on the sender and sets the low-quality video stream. - + @@ -26,11 +26,11 @@ enabled: boolean, streamConfig?: SimulcastStreamConfig ): number;
    - Future<void> enableDualStreamMode( + Future<void> enableDualStreamMode( {required bool enabled, SimulcastStreamConfig? streamConfig}); -

    +

    -
    +
    Parameters @@ -38,24 +38,24 @@ enabled

    Whether to enable dual-stream mode:

      -
    • : Enable dual-stream mode.
    • -
    • : (Default) Disable dual-stream mode.
    • +
    • : Enable dual-stream mode.
    • +
    • : (Default) Disable dual-stream mode.

    streamConfig -

    The configuration of the low-quality video stream. See .

    +

    The configuration of the low-quality video stream. 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_enableencryption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index 9c5a105c18c..5057d9504c5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita @@ -21,7 +21,7 @@ abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number; Future<void> enableEncryption( {required bool enabled, required EncryptionConfig config}); -

    +

    Details @@ -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.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 8384b00a036..c1ff454ccae 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -1,12 +1,12 @@ - <ph keyref="enableInEarMonitoring2"/> + <ph keyref="enableInEarMonitoring2" /> Enables in-ear monitoring. - + @@ -25,10 +25,10 @@ enabled: boolean, includeAudioFilters: EarMonitoringFilterType ): number; - Future<void> enableInEarMonitoring( + Future<void> enableInEarMonitoring( {required bool enabled, required EarMonitoringFilterType includeAudioFilters}); -

        +

    Details @@ -44,28 +44,28 @@ enabled Enables or disables in-ear monitoring.
      -
    • : Enables in-ear monitoring.
    • -
    • : (Default) Disables in-ear monitoring.
    • +
    • : Enables in-ear monitoring.
    • +
    • : (Default) Disables in-ear monitoring.
    includeAudioFilters - The audio filter of in-ear monitoring: See . + The audio filter of in-ear monitoring: See . The audio filter of in-ear monitoring:
      -
    • (1 << 0): Do not add an audio filter to the in-ear monitor.
    • -
    • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
    • -
    • (1 << 2): Enable noise suppression to the in-ear monitor.

      You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.

      +
    • (1 << 0): Do not add an audio filter to the in-ear monitor.
    • +
    • (1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
    • +
    • (1 << 2): Enable noise suppression to the in-ear monitor.

      You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.

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

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

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

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

    • 0: Success.
    • -
    • < 0: Failure. See for details and resolution suggestions.
      • - 8: Make sure the current audio routing is Bluetooth or headset.
      +
    • < 0: Failure. See for details and resolution suggestions.
      • - 8: Make sure the current audio routing is Bluetooth or headset.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita index e165e6bc38a..ceca8316592 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita @@ -1,19 +1,19 @@ - <ph keyref="enableMultiCamera"/> + <ph keyref="enableMultiCamera" /> Enables or disables multi-camera capture. - +

    - + - (int)enableMultiCamera:(BOOL)enabled config:(AgoraCameraCapturerConfiguration* _Nullable)config NS_SWIFT_NAME(enableMultiCamera(_:config:)); #if defined(__APPLE__) && TARGET_OS_IOS virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0; @@ -27,9 +27,9 @@ enabled: boolean, config: CameraCapturerConfiguration ): number; - Future<void> enableMultiCamera( + Future<void> enableMultiCamera( {required bool enabled, required CameraCapturerConfiguration config}); -

    +

    Details @@ -41,18 +41,18 @@

    In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:

    1. Call this method to enable multi-channel camera capture.
    2. -
    3. Call to start the local video preview.
    4. -
    5. Call , and set sourceType to start video capture with the second camera.
    6. -
    7. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.
    8. +
    9. Call to start the local video preview.
    10. +
    11. Call , and set sourceType to start video capture with the second camera.
    12. +
    13. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.

    If you want to disable multi-channel camera capture, use the following steps:

      -
    1. Call .
    2. -
    3. Call this method with enabled set to .
    4. +
    5. Call .
    6. +
    7. Call this method with enabled set to .

    -

    You can call this method before and after to enable multi-camera capture:

      -
    • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
    • -
    • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.
    • +

      You can call this method before and after to enable multi-camera capture:

        +
      • If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
      • +
      • If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.

      This method applies to iOS only.

      @@ -70,22 +70,22 @@ enabled Whether to enable multi-camera video capture mode:
        -
      • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
      • -
      • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
      • +
      • : Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
      • +
      • : Disable multi-camera capture mode; the SDK uses a single camera to capture video.
      config - Capture configuration for the second camera. See . + Capture configuration for the second camera. 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_enablevirtualbackground.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index be2ad36ebed..88f96236625 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -1,12 +1,12 @@ - <ph keyref="enableVirtualBackground"/> + <ph keyref="enableVirtualBackground" /> Enables/Disables the virtual background. - + @@ -32,17 +32,17 @@ segproperty: SegmentationProperty, type?: MediaSourceType ): number; - Future<void> enableVirtualBackground( + Future<void> enableVirtualBackground( {required bool enabled, required VirtualBackgroundSource backgroundSource, required SegmentationProperty segproperty, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

    +

    Details

    The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background.

    -

    Call this method before calling or .

    +

    Call this method before calling or .

    • This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
        @@ -64,7 +64,7 @@
      • A high-definition camera device is used, and the environment is uniformly lit.
      • There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.
    • -
    • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
    • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    Parameters @@ -73,38 +73,38 @@ enabled enable Whether to enable virtual background:
      -
    • : Enable virtual background.
    • -
    • : Disable virtual background.
    • +
    • : Enable virtual background.
    • +
    • : Disable virtual background.
    backgroundSource backData - The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. + The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. segproperty segData - Processing properties for background images. See . + Processing properties for background images. See . type - The type of the video source. See .In this method, this parameter supports only the following two settings:
      -
    • The default value is .
    • -
    • If you want to use the second camera to capture video, set this parameter to .
    • + The type of the video source. See .In this method, this parameter supports only the following two settings:
        +
      • The default value is .
      • +
      • If you want to use the second camera to capture video, set this parameter 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.
        -
      • -1: The custom background image does not exist. Check the value of source in .
      • -
      • -2: The color format of the custom background image is invalid. Check the value of color in .
      • +
      • -1: The custom background image does not exist. Check the value of source in .
      • +
      • -2: The color format of the custom background image is invalid. Check the value of color in .
      • -3: The device does not support virtual background.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita index 7af9752c219..3803ae2b685 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita @@ -1,12 +1,12 @@ - <ph keyref="getExtensionProperty2"/> + <ph keyref="getExtensionProperty2" /> Gets detailed information on the extensions. - + @@ -40,17 +40,17 @@ bufLen: number, type?: MediaSourceType ): string;
    - Future<String> getExtensionProperty( + Future<String> getExtensionProperty( {required String provider, required String extension, required String key, required int bufLen, MediaSourceType type = MediaSourceType.unknownMediaSource}); -

    +

    Details -

    +

    Parameters @@ -77,7 +77,7 @@ sourceType type - Source type of the extension. See . + Source type of the extension. See . buf_len @@ -89,11 +89,11 @@ 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.
    • 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_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita index 3fa7322ff1b..a1e600dee2c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita @@ -32,7 +32,7 @@ {required Size thumbSize, required Size iconSize, required bool includeScreen});
    -

    +

    Details @@ -64,4 +64,4 @@

    The array.

    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita index d962196b1d8..770768f8c6e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -1,12 +1,12 @@ - <ph keyref="initialize"/> - Creates and initializes . Initializes . + <ph keyref="initialize" /> + Creates and initializes . Initializes . - + @@ -22,17 +22,17 @@ public abstract int Initialize(RtcEngineContext context); abstract initialize(context: RtcEngineContext): number; Future<void> initialize(RtcEngineContext context); -

    +

    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 and to create and initialize the object.
    • -
    • 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 this method 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 and to create and initialize the object.
    • +
    • 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 this method 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 @@ -41,21 +41,21 @@ context config -

    Configurations for the instance. See .

    +

    Configurations for the instance. See .

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

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

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

    When the method call succeeds, there is no return 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 instance, if the method call succeeds.
    • +
    • The instance, if the method call succeeds.
    • 0: Success.
    • -
    • 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 method call fails and an exception is thrown, you need to catch the exception and handle it. See for details and resolution suggestions.
    • < 0: Failure.
      • -1: A general error occurs (no specified reason).
      • -2: The parameter is invalid.
      • @@ -64,6 +64,6 @@
      • -101: The App ID is invalid.
    -
    +
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita b/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita index 7e1cb8789ee..df68336aa63 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita @@ -1,12 +1,12 @@ - <ph keyref="isFeatureAvailableOnDevice"/> + <ph keyref="isFeatureAvailableOnDevice" /> Checks whether the device supports the specified advanced feature. - + @@ -39,7 +39,7 @@ type - The type of the advanced feature, see . + The type of the advanced feature, see .

    The type of the advanced feature.

    • (1): Virutual background.
    • @@ -55,4 +55,4 @@
    • : The current device does not support the specified feature.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index 99abe864cf4..be33f384296 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -36,12 +36,12 @@ uid: number, options: ChannelMediaOptions ): number; - Future<void> joinChannel( + Future<void> joinChannel( {required String token, required String channelId, required int uid, required ChannelMediaOptions options}); -

    +

    Details @@ -62,7 +62,7 @@ token - The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . + The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See . channelId @@ -72,7 +72,7 @@
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
  • -
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
  • +
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
  • @@ -91,8 +91,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.
        @@ -106,4 +106,4 @@
    -
    + \ 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 81899fdeaf2..963ce80bc46 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita @@ -13,8 +13,8 @@

    - - + + virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0; abstract loadExtensionProvider( path: string, diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index a140c6d0daf..1b04fbb0ef9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel"/> + <ph keyref="preloadChannel" /> Preloads a channel with token, channelIdchannelName, and uidoptionalUid. - + @@ -29,7 +29,7 @@ channelId: string, uid: number ): number; - Future<void> preloadChannel( + Future<void> preloadChannel( {required String token, required String channelId, required int uid});

    @@ -41,9 +41,9 @@

    When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel.

    -
    • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
    • +
      • When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
      • You also need to make sure that the channel name, user ID and token passed in for preloading are the same as the values passed in when joinning the channel, otherwise, this method does not take effect.
      • -
      • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
      • +
      • One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
      • Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.

      If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.

    @@ -52,8 +52,8 @@ token - The token generated on your server for authentication. See .

    When the token for preloading channels expires, you can update the token based on the number of channels you preload.

    • When preloading one channel, calling this method to pass in the new token.
    • -
    • When preloading more than one channels:
      • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
      • + The token generated on your server for authentication. See .

        When the token for preloading channels expires, you can update the token based on the number of channels you preload.

        • When preloading one channel, calling this method to pass in the new token.
        • +
        • When preloading more than one channels:
          • If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
          • If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.

        @@ -65,17 +65,17 @@
      • All 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.
          @@ -84,4 +84,4 @@
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita index 3aff9269f23..cb13450015b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita @@ -20,7 +20,7 @@ abstract pushReverseAudioFrame(frame: AudioFrame): number; Future<void> pushReverseAudioFrame(AudioFrame frame); -

      +

      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_pushvideoframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita index 8b9d50bb20c..532e8c7ddcc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita @@ -1,12 +1,12 @@ - <ph keyref="pushVideoFrame2"/> + <ph keyref="pushVideoFrame2" /> Pushes the external video frame. - + @@ -14,32 +14,32 @@

      public abstract boolean pushExternalVideoFrame(VideoFrame frame); - - - - - - -

      + + + + + + +

      Details -

      This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

      -

      You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

      +

      This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.

      +

      You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.

      Parameters frame - Video frame to be pushed. See . + Video frame to be pushed. See .
      Returns
        -
      • : Pushes the external raw video frame to the SDK successfully.
      • -
      • : Fails to push external raw video frame to the SDK.
      • +
      • : Pushes the external raw video frame to the SDK successfully.
      • +
      • : Fails to push external raw video frame to the SDK.
      -
      + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita index 5855456247d..bd4f010f2dd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryCodecCapability"/> + <ph keyref="queryCodecCapability" /> Queries the current device's supported video codec capabilities. - + @@ -14,13 +14,13 @@

      public abstract CodecCapInfo[] queryCodecCapability(); - - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; + - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability; virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0; abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; public abstract int QueryCodecCapability(ref CodecCapInfo[] codecInfo, ref int size); abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number }; - Future<List<CodecCapInfo>> queryCodecCapability(int size);

      + Future<List<CodecCapInfo>> queryCodecCapability(int size);

      Details @@ -30,7 +30,7 @@
      v4.2.0
      -

      +

      Parameters @@ -38,37 +38,37 @@ codecInfo -

      Input and output parameter. An array representing the video codec capabilities of the device. See .

      +

      Input and output parameter. An array representing the video codec capabilities of the device. See .

        -
      • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
      • -
      • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
      • +
      • Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
      • +
      • Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
      size - Input and output parameter, represent the size of the array.
        -
      • Input value: Size of the defined by the user when executing the method.
      • -
      • Output value: Size of the output after this method is executed.
      • + Input and output parameter, represent the size of the array.
          +
        • Input value: Size of the defined by the user when executing the method.
        • +
        • Output value: Size of the output after this method is executed.
        - The size of . + The size of .
      Returns
      • If the call is successful, an object containing the following attributes is returned:
          -
        • codecInfo: The array, indicating the video codec capabillity of the device.
        • -
        • size: The size of the array.
      • +
      • codecInfo: The array, indicating the video codec capabillity of the device.
      • +
      • size: The size of the array.
    • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
    • 0: Success.
    • -
    • < 0: Failure. See for details and resolution suggestions.
    • +
    • < 0: Failure. See for details and resolution suggestions.
      -
    • One array indicating the video encoding capability of the device, if the method call succeeds.
    • +
    • One array indicating the video encoding capability of the device, if the method call succeeds.
    • If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita index a5c5c9bdd05..7afadbb1bfd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita @@ -1,12 +1,12 @@ - <ph keyref="queryScreenCaptureCapability"/> + <ph keyref="queryScreenCaptureCapability" /> Queries the highest frame rate supported by the device during screen sharing. - + @@ -18,10 +18,10 @@ #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) virtual int queryScreenCaptureCapability() = 0; #endif - + public abstract int QueryScreenCaptureCapability(); abstract queryScreenCaptureCapability(): number; - Future<int> queryScreenCaptureCapability();

    + Future<int> queryScreenCaptureCapability();

    Details @@ -31,7 +31,7 @@
    v4.2.0
    -

    +

    Applicable scenarios @@ -39,15 +39,15 @@

    To ensure optimal screen sharing performance, particularly in enabling high frame rates like 60 fps, Agora recommends you to query the device's maximum supported frame rate using this method beforehand. This way, if the device cannot support such a high frame rate, you can adjust the screen sharing stream accordingly to avoid any negative impact on the sharing quality. If the device does not support high frame rate, you can reduce the frame rate of the screen sharing stream appropriately when sharing the screen to ensure that the sharing effect meets your expectation.

    - <ph keyref="return-section-title"/> -
    • The highest frame rate supported by the device, if the method is called successfully. See .
    • -
    • If the call fails, returns .
    + <ph keyref="return-section-title" /> +
    • The highest frame rate supported by the device, if the method is called successfully. See .
    • +
    • If the call fails, returns .
      -
    • The highest frame rate supported by the device, if the method is called successfully. See .
        +
      • The highest frame rate supported by the device, if the method is called successfully. See .
        • 0: The device supports the frame rate of up to 15 fps.
        • 1: The device supports the frame rate of up to 30 fps.
        • 2: The device supports the frame rate of up to 60 fps.
      • -
      • < 0: Failure. See for details and resolution suggestions.
      +
    • < 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_registeraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita index 1d02bd7d0e5..af70206c7a2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita @@ -30,7 +30,7 @@ void registerAudioEncodedFrameObserver( {required AudioEncodedFrameObserverConfig config, required AudioEncodedFrameObserver observer}); -

    +

    Details @@ -57,12 +57,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.
    -

    One object.

    +

    One object.

    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita index 2fd9148d87d..feb57cf4a9a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita @@ -25,7 +25,7 @@ observer: IAudioSpectrumObserver ): number;
    void registerAudioSpectrumObserver(AudioSpectrumObserver observer); -

    +

    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.
    -

    One object.

    +

    One object.

    - + \ No newline at end of file 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 c400e38efef..30c1efbaead 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita @@ -13,8 +13,8 @@

    - - + + virtual int registerExtension(const char* provider, const char* extension, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0; abstract registerExtension( diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index 88a5a7f38cd..bf1f58fb587 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita @@ -28,7 +28,7 @@ ): number; void registerMediaMetadataObserver( {required MetadataObserver observer, required MetadataType type}); -

    +

    Details @@ -51,12 +51,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_removehandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita index 377d7e71c80..1d5ff941292 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita @@ -24,7 +24,7 @@ eventHandler: IRtcEngineEventHandler ): boolean;
    void unregisterEventHandler(RtcEngineEventHandler eventHandler); -

    +

    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.

    • : 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_sendmetadata.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita index db84b53b771..a2233e2ec6f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita @@ -21,7 +21,7 @@ abstract sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number; Future<void> sendMetaData( {required Metadata metadata, required VideoSourceType sourceType}); -

    +

    Details @@ -33,20 +33,20 @@ metadata - Media metadata See . + Media metadata See . sourceType source_type - 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_setadvancedaudiooptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita index 3f63744d977..cd1b84e9283 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita @@ -19,8 +19,8 @@ abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; public abstract int SetAdvancedAudioOptions(AdvancedAudioOptions options); abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number; - Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); -

    + Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options); +

    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_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index 87cbe321767..759d8d78c9f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita @@ -20,7 +20,7 @@ public abstract int SetAudioMixingDualMonoMode(AUDIO_MIXING_DUAL_MONO_MODE mode); abstract setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): number; Future<void> setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode); -

    +

    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_setcameraexposurefactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita index c3b51588482..ab4472cf181 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita @@ -17,7 +17,7 @@ - (CGFloat)setCameraExposureFactor:(CGFloat)exposureFactor NS_SWIFT_NAME(setCameraExposureFactor(_:)); virtual int setCameraExposureFactor(float factor) = 0; - + public abstract int SetCameraExposureFactor(float factor); abstract setCameraExposureFactor(factor: number): number; Future<void> setCameraExposureFactor(double factor); diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita index 1179f56b951..e1a37166d64 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita @@ -20,7 +20,7 @@ public abstract int SetChannelProfile(CHANNEL_PROFILE_TYPE profile); abstract setChannelProfile(profile: ChannelProfileType): number; Future<void> setChannelProfile(ChannelProfileType profile); -

    +

    Details @@ -45,13 +45,13 @@
  • (2): Gaming.
    Deprecated:
    -
    Use instead.
    +
    Use instead.
  • (3): Interaction. The scenario is optimized for latency. Use this profile if the use case requires frequent interactions between users.
    Deprecated:
    -
    Use instead.
    +
    Use instead.
  • @@ -59,8 +59,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(ERR_OK): Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index 46af17733e2..d10f2b5fc1a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -30,7 +30,7 @@
        Details

        You can call this method either before or after joining the channel to set the user role as audience or host.

        -

        +

        If you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks:

        • The local client: .
        • The remote client: or ().
        • @@ -62,4 +62,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita index dbe107f97b5..5cfe8167aea 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -27,7 +27,7 @@ ): number;
    Future<void> setClientRole( {required ClientRoleType role, ClientRoleOptions? options}); -

    +

    Details @@ -39,7 +39,7 @@
  • Triggers on the local client.
  • Triggers or on the remote client.
  • -

    The difference between this method and is that this method can set the user level in addition to the user role.

      +

      The difference between this method and is that this method can set the user level in addition to the user role.

      • The user role (role) determines the permissions that the SDK grants to a user, such as permission to send local streams, receive remote streams, and push streams to a CDN address.
      • The user level (level) determines the level of services that a user can enjoy within the permissions of the user's role. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. User level affects the pricing of services.

      @@ -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.
        • -1: A general error occurs (no specified reason).
        • -2: The parameter is invalid.
        • -5: The request is rejected.
        • @@ -73,4 +73,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita index f2d5491b62f..80c45acc675 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita @@ -30,11 +30,11 @@ options: ColorEnhanceOptions, type?: MediaSourceType ): number;
    - Future<void> setColorEnhanceOptions( + Future<void> setColorEnhanceOptions( {required bool enabled, required ColorEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

    +

    Details @@ -48,7 +48,7 @@
  • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
  • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
  • -
  • 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.
  • Parameters @@ -66,16 +66,16 @@ The color enhancement 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_setdualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita index cf4a2f77dce..4084e253a7f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode"/> + <ph keyref="setDualStreamMode" /> Sets the dual-stream mode on the sender side. - + @@ -16,11 +16,11 @@ public abstract int setDualStreamMode(Constants.SimulcastStreamMode mode); - (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode; virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0; - + public abstract int SetDualStreamMode(SIMULCAST_STREAM_MODE mode); - - -

    + + +

    Details
    @@ -29,12 +29,12 @@
    v4.0.1
    -

    The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

      -
    • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
    • -
    • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as ().
    • -
    • When calling this method and setting mode to , it has the same effect as ().
    • +

      The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.

        +
      • If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
      • +
      • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as ().
      • +
      • When calling this method and setting mode to , it has the same effect as ().
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -43,15 +43,15 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. 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_setdualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita index 62e3821a2cd..d7d24b05232 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamMode2"/> + <ph keyref="setDualStreamMode2" /> Sets dual-stream mode configuration on the sender, and sets the low-quality video stream. - + @@ -28,9 +28,9 @@ mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig ): number;
    - Future<void> setDualStreamMode( + Future<void> setDualStreamMode( {required SimulcastStreamMode mode, SimulcastStreamConfig? streamConfig}); -

    +

    Details @@ -40,11 +40,11 @@
    v4.0.1
    -

    -

    The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
    • -
    • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
    • +

      +

      The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
      • +
      • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -53,22 +53,22 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. See . streamConfig -

    The configuration of the low-quality video stream. See .

    - When setting mode to , setting streamConfig will not take effect. +

    The configuration of the low-quality video stream. See .

    + When setting mode to , setting streamConfig will 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_irtcengine_setexternalaudiosourcevolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita index a420b8b61c8..835be9dd6a2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita @@ -1,26 +1,26 @@ - <ph keyref="setExternalAudioSourceVolume"/> + <ph keyref="setExternalAudioSourceVolume" /> Sets the volume of the external audio frame in the specified position. - +

    - - - - + + + + public abstract int SetExternalAudioSourceVolume(int sourcePos, int volume); - - -

    + + +

    Details @@ -31,7 +31,7 @@ sourcePos - The push position of the external audio frame. See . + The push position of the external audio frame. See . The push position of the external audio frame.
    • 0: The position before local playback. If you need to play the external audio frame on the local client, set this position.
    • 1: The position after audio capture and before audio pre-processing. If you need the audio module of the SDK to process the external audio frame, set this position.
    • @@ -47,7 +47,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_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita index 1d7816d5df6..56ad4f71422 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita @@ -1,12 +1,12 @@ - <ph keyref="setHeadphoneEQPreset"/> + <ph keyref="setHeadphoneEQPreset" /> Sets the preset headphone equalization effect. - + @@ -19,8 +19,8 @@ abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; public abstract int SetHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset); abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number; - Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); -

    + Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset); +

    Details @@ -37,12 +37,12 @@ preset - The preset headphone equalization effect. See . + The preset headphone equalization effect. 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.
        @@ -50,4 +50,4 @@
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita index bea0c1062b7..e16af742e02 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita @@ -20,7 +20,7 @@ public abstract int SetLiveTranscoding(LiveTranscoding transcoding); abstract setLiveTranscoding(transcoding: LiveTranscoding): number; Future<void> setLiveTranscoding(LiveTranscoding transcoding); -

    +

    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_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita index e42bbe4b26d..6ca21e715ec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita @@ -20,7 +20,7 @@ public abstract int SetLocalAccessPoint(LocalAccessPointConfiguration config); abstract setLocalAccessPoint(config: LocalAccessPointConfiguration): number; Future<void> setLocalAccessPoint(LocalAccessPointConfiguration config); -

    +

    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_setlocalpublishfallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita index 43c5e906b59..354436e12c4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita @@ -20,7 +20,7 @@ public abstract int SetLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option); Future<void> setLocalPublishFallbackOption(StreamFallbackOptions option); -

    +

    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_setlocalrendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita index 382f44434f0..52a09fa51d5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita @@ -27,7 +27,7 @@ mirrorMode?: VideoMirrorModeType ): number;
    Future<void> setLocalRenderMode2(RenderModeType renderMode); -

    +

    Details @@ -58,11 +58,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_setlocalrendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index 0359b740d7e..362e5a34877 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -30,7 +30,7 @@ {required RenderModeType renderMode, VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto});
    -

    +

    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_irtcengine_setlocalvideomirrormode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita index 436c98bb8a0..340b1fe564e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita @@ -20,7 +20,7 @@ public abstract int SetLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode); abstract setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number; Future<void> setLocalVideoMirrorMode(VideoMirrorModeType mirrorMode); -

    +

    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_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita index eb5b49f5ce6..194df414a2a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita @@ -30,11 +30,11 @@ options: LowlightEnhanceOptions, type?: MediaSourceType ): number;
    - Future<void> setLowlightEnhanceOptions( + Future<void> setLowlightEnhanceOptions( {required bool enabled, required LowlightEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

    +

    Details @@ -48,7 +48,7 @@
  • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
  • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
  • -
  • 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.
  • Parameters @@ -67,15 +67,15 @@ type - 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_setremoteuserspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita index 8f447d3fe1a..c83aecfc281 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita @@ -28,7 +28,7 @@ ): number;
    Future<void> setRemoteUserSpatialAudioParams( {required int uid, required SpatialAudioParams params}); -

    +

    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_setscreencapturecontenthint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita index d79ce4737f5..240ffaf0035 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita @@ -21,7 +21,7 @@ public abstract int SetScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint); abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number; Future<void> setScreenCaptureContentHint(VideoContentHint contentHint); -

    +

    Details @@ -37,8 +37,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_setuplocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 7f976c8b44e..abf5f1e479a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -20,7 +20,7 @@ public abstract int SetupLocalVideo(VideoCanvas canvas); abstract setupLocalVideo(canvas: VideoCanvas): number; Future<void> setupLocalVideo(VideoCanvas canvas); -

      +

    Details @@ -28,7 +28,7 @@

    After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as .

      -
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
    • +
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
    • You can call this method either before or after joining a channel.
    • To update the rendering or mirror mode of the local video view during a call, use the method.
    @@ -38,15 +38,15 @@ canvas local - The local video view and settings. See . + The local video view and settings. 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_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index 34b3ebe145b..88595963864 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -1,12 +1,12 @@ - <ph keyref="setupRemoteVideo"/> + <ph keyref="setupRemoteVideo" /> Initializes the video view of a remote user. - + @@ -20,19 +20,19 @@ public abstract int SetupRemoteVideo(VideoCanvas canvas); abstract setupRemoteVideo(canvas: VideoCanvas): number; Future<void> setupRemoteVideo(VideoCanvas canvas); -

    +

    Details

    This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.

    -

    You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

    +

    You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.

    To unbind the remote user from the view, set the view parameter to NULL.

    Once the remote user leaves the channel, the SDK unbinds the remote user.

      -
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
    • -
    • To update the rendering or mirror mode of the remote video view during a call, use the method.
    • -
    • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
    • +
    • If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
    • +
    • To update the rendering or mirror mode of the remote video view during a call, use the method.
    • +
    • If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
    Parameters @@ -41,16 +41,16 @@ canvas remote -

    The remote video view and settings. See .

    +

    The remote video view and settings. 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_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita index e2bd1d4e345..9b16e756311 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoDenoiserOptions"/> + <ph keyref="setVideoDenoiserOptions" /> Sets video noise reduction. - + @@ -30,11 +30,11 @@ options: VideoDenoiserOptions, type?: MediaSourceType ): number;
    - Future<void> setVideoDenoiserOptions( + Future<void> setVideoDenoiserOptions( {required bool enabled, required VideoDenoiserOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

    +

    Details @@ -42,13 +42,13 @@

    You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.

      -
    • Call this method after calling .
    • +
    • Call this method after calling .
    • Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.
    • -
    • Both this method and can turn on video noise reduction function:
        +
      • Both this method and can turn on video noise reduction function:
        • When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
        • -
        • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
        • +
        • When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
      • -
      • 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.
    Parameters @@ -57,25 +57,25 @@ enabled enable Whether to enable video noise reduction:
      -
    • : Enable video noise reduction.
    • -
    • : (Default) Disable video noise reduction.
    • +
    • : Enable video noise reduction.
    • +
    • : (Default) Disable video noise reduction.
    options - The video noise reduction options. See . + The video noise reduction 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_setvideoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita index c44e8ee5653..5b3f3047fd6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoEncoderConfiguration"/> + <ph keyref="setVideoEncoderConfiguration" /> Sets the video encoder configuration. - + @@ -24,32 +24,32 @@ config: VideoEncoderConfiguration ): number;
    Future<void> setVideoEncoderConfiguration(VideoEncoderConfiguration config); -

    +

    Details

    Sets the encoder configuration for the local video.

      -
    • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
    • -
    • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
    • +
    • You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
    • +
    • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
    - You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. - Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
    + You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame. + Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
    Parameters config - Video profile. See . + Video profile. 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_setvideoprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita index bd6091ec096..a3eadbc0327 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoProfile"/> + <ph keyref="setVideoProfile" /> Sets the video encoder configuration. - + @@ -17,21 +17,21 @@ - (int)setVideoProfile:(AgoraVideoProfile)profile swapWidthAndHeight:(BOOL)swapWidthAndHeight virtual int setVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) = 0; - + public abstract int SetVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight = false); - - -

    + + +

    Details
    Deprecated:
    -
    This method is deprecated. Use instead.
    +
    This method is deprecated. Use instead.
    -

    This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

    +

    This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.

    Parameters @@ -39,7 +39,7 @@ profile -

    Video profile. See .

    +

    Video profile. See .

    @@ -47,8 +47,8 @@

    The SDK outputs video with a fixed width and height according to the video profile (profile) you selected. This parameter sets whether to swap width and height of the video:

      -
    • : Swap the width and height.
    • -
    • : (Default) Do not swap the width and height.
    • +
    • : Swap the width and height.
    • +
    • : (Default) Do not swap the width and height.
    @@ -56,7 +56,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_startaudiorecording3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita index 3fe55ac3479..64405795936 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita @@ -20,7 +20,7 @@ public abstract int StartAudioRecording(AudioRecordingConfiguration config); abstract startAudioRecording(config: AudioRecordingConfiguration): number; Future<void> startAudioRecording(AudioRecordingConfiguration config); -

    +

    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_startcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index a12efd298c8..fac5545f581 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startCameraCapture"/> + <ph keyref="startCameraCapture" /> Starts camera capture. - + @@ -26,10 +26,10 @@ sourceType: VideoSourceType, config: CameraCapturerConfiguration ): number;
    - Future<void> startCameraCapture( + Future<void> startCameraCapture( {required VideoSourceType sourceType, required CameraCapturerConfiguration config}); -

    +

    Details @@ -40,7 +40,7 @@

    You can call this method to start capturing video from one or more cameras by specifying sourceType.

    - On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method. + On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method.
    Parameters @@ -48,7 +48,7 @@ sourceType -

    The type of the video source. See .

    +

    The type of the video source. See .

    • On the mobile platforms, you can capture video from up to 2 cameras, provided the device has dual cameras or supports an external camera.
    • On the desktop platforms, you can capture video from up to 4 cameras.
    @@ -57,18 +57,18 @@ config -

    The configuration of the video capture. See .

    - On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
    +

    The configuration of the video capture. See .

    + On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
    - <ph keyref="return-section-title"/> -

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

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

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. 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_startchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita index 7e0f909d14e..f554f21fafc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelay"/> + <ph keyref="startChannelMediaRelay" /> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,7 +26,7 @@ ): number;
    Future<void> startChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

    +

    Details @@ -36,16 +36,16 @@
    This method is deprecated. Use instead.
    -

    After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

      -
    • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
    • -
    • If the callback returns (3), an exception occurs during the media stream relay.
    • +

      After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

        +
      • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
      • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
      • -
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
      • -
      • The relaying media streams across channels function needs to be enabled by contacting .
      • +
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
      • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -55,12 +55,12 @@ 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.
        @@ -71,4 +71,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita index ac0eff4bd5b..5e4840e581b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita @@ -28,11 +28,11 @@ publishUrl: string, options: DirectCdnStreamingMediaOptions ): number;
    - Future<void> startDirectCdnStreaming( + Future<void> startDirectCdnStreaming( {required DirectCdnStreamingEventHandler eventHandler, required String publishUrl, required DirectCdnStreamingMediaOptions options}); -

    +

    Details

    Aogra does not support pushing media streams to one URL repeatedly.

    @@ -46,7 +46,7 @@
  • publishCameraTrack is set as (the default value)
  • publishMicrophoneTrack is set as (the default value)
  • -

    As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

    +

    As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.

    Parameters @@ -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_startechotest3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita index c2a8a6417fb..610717b10b2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita @@ -1,12 +1,12 @@ - <ph keyref="startEchoTest3"/> + <ph keyref="startEchoTest3" /> Starts an audio device loopback test. - + @@ -19,8 +19,8 @@ abstract startEchoTest(config: EchoTestConfiguration): number; public abstract int StartEchoTest(EchoTestConfiguration config); abstract startEchoTest(config: EchoTestConfiguration): number; - Future<void> startEchoTest(EchoTestConfiguration config); -

    + Future<void> startEchoTest(EchoTestConfiguration config); +

    Details @@ -28,7 +28,7 @@

    After starting the test, the user needs to make a sound or face the camera. The audio or video is output after about two seconds. If the audio playback is normal, the audio device and the user's upstream and downstream networks are working properly; if the video playback is normal, the video device and the user's upstream and downstream networks are working properly.

    • You can call this method either before or after joining a channel. When calling in a channel, make sure that no audio or video stream is being published.
    • -
    • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
    • +
    • After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
    • In live streaming scenarios, this method only applies to hosts.

    @@ -37,14 +37,14 @@ config - The configuration of the audio and video call loop test. See . + The configuration of the audio and video call loop test. 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_startorupdatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita index ec1ae30871c..4681e3714ae 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelay"/> + <ph keyref="startOrUpdateChannelMediaRelay" /> Starts relaying media streams across channels or updates channels for media relay. - + @@ -24,9 +24,9 @@ abstract startOrUpdateChannelMediaRelay( configuration: ChannelMediaRelayConfiguration ): number; - Future<void> startOrUpdateChannelMediaRelay( + Future<void> startOrUpdateChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

    +

    Details @@ -36,15 +36,15 @@
    v4.2.0

    The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

    -

    After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

      -
    • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
    • -
    • If the callback returns (3), an exception occurs during the media stream relay.
    • +

      After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

        +
      • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
      • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
      • -
      • The relaying media streams across channels function needs to be enabled by contacting .
      • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -54,12 +54,12 @@ 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.
        @@ -70,4 +70,4 @@
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index df2d1a9093f..49d2ca96f57 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="startRhythmPlayer"/> + <ph keyref="startRhythmPlayer" /> Enables the virtual metronome. - + @@ -28,42 +28,42 @@ sound2: string, config: AgoraRhythmPlayerConfig ): number;
    - Future<void> startRhythmPlayer( + Future<void> startRhythmPlayer( {required String sound1, required String sound2, required AgoraRhythmPlayerConfig config}); -

    +

    Details

    In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.

    In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.

    -

    After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

    +

    After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.

    • This method is for Android and iOS only.
    • -
    • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
    • -
    • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
    • +
    • After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
    • +
    • By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
    Parameters sound1 - The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. sound2 - The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. + The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. config - The metronome configuration. See . + The metronome configuration. 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.
        @@ -71,4 +71,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index acace31050f..5b78fd8562a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startScreenCapture"/> + <ph keyref="startScreenCapture" /> Starts screen capture. - + @@ -22,32 +22,32 @@ abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; public abstract int StartScreenCapture(ScreenCaptureParameters2 captureParams); abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; - Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); -

    + Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); +

    Details

    There are two ways to start screen sharing, you can choose one according to your needs:

      -
    • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
    • -
    • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.
    • +
    • Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
    • +
    • Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.

    -

    When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

    +

    When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.

    • This method applies to Android and iOS only.
    • On the iOS platform, screen sharing is only available on iOS 12.0 and later.
    • -
    • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. For billing details, see .
    • +
    • The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. For billing details, see .
    • If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.
    • This feature requires high-performance device, and Agora recommends that you use it on iPhone X and later models.
    • This method relies on the iOS screen sharing dynamic library AgoraReplayKitExtension.xcframework. If the dynamic library is deleted, screen sharing cannot be enabled normally.
    • On the Android platform, make sure the user has granted the app screen capture permission.
    • -
    • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
    • -
    • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
    • +
    • Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
    • +
    • To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
    • On Android 9 and later, to avoid the application being killed by the system after going to the background, Agora recommends you add the foreground service android.permission.FOREGROUND_SERVICE to the /app/Manifests/AndroidManifest.xml file.
    • Due to performance limitations, screen sharing is not supported on Android TV.
    • Due to system limitations, if you are using Huawei phones, do not adjust the video encoding resolution of the screen sharing stream during the screen sharing, or you could experience crashes.
    • Due to system limitations, some Xiaomi devices do not support capturing system audio during screen sharing.
    • -
    • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
    • +
    • To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
    Parameters @@ -56,12 +56,12 @@ parameters screenCaptureParameters captureParams - The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. 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.
        @@ -69,4 +69,4 @@
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita index b3acaac3c5f..4351ddd9106 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita @@ -22,11 +22,11 @@ config: ScreenCaptureConfiguration ): number;
    public abstract int StartScreenCapture(VIDEO_SOURCE_TYPE sourceType, ScreenCaptureConfiguration config); - - Future<void> startScreenCaptureBySourceType( + + Future<void> startScreenCaptureBySourceType( {required VideoSourceType sourceType, required ScreenCaptureConfiguration config}); -

    +

    Details @@ -36,15 +36,15 @@
    v4.2.0
    -

    This method, as well as and , all have the capability to start screen capture, with the following differences: -This method, as well as , , and , all have the capability to start screen capture, with the following differences:

      -
    • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
    • -
    • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
    • +

      This method, as well as and , all have the capability to start screen capture, with the following differences: +This method, as well as , , and , all have the capability to start screen capture, with the following differences:

        +
      • only applies to Android and iOS, whereas this method only applies to Windows and iOS.
      • +
      • and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.

      • This method applies to the macOS and Windows only.
      • -
      • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
      +
    • If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
    Parameters @@ -52,10 +52,10 @@ sourceType -

    The type of the video source. See .

    +

    The type of the video source. See .

    • Windows supports up to four screen capture video streams.
    • -
    • macOS supports only one screen capture video stream. You can only set this parameter to (2).
    +
  • macOS supports only one screen capture video stream. You can only set this parameter to (2).
  • @@ -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. See for details and resolution suggestions.
    • +
    • < 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_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita index ac1b202e9b8..51eb23c221a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita @@ -36,7 +36,7 @@ {required int displayId, required Rectangle regionRect, required ScreenCaptureParameters captureParams});
    -

    +

    Details @@ -71,8 +71,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_startscreencapturebyscreenrect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita index d846756b42d..9b06c582e4b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita @@ -34,7 +34,7 @@ {required Rectangle screenRect, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

        +

    Details @@ -65,8 +65,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_startscreencapturebywindowid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita index 58f2d07be9e..6c74606aa3e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita @@ -35,7 +35,7 @@ {required int windowId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

      +

    Details @@ -196,8 +196,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_switchchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita index 4f419c0f36a..968cf91cf25 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita @@ -1,33 +1,33 @@ - <ph keyref="switchChannel2"/> + <ph keyref="switchChannel2" /> Switches to a different channel, and configures whether to automatically subscribe to audio or video streams in the target channel. - +

      - - + + virtual int switchChannel(const char* token, const char* channelId, const ChannelMediaOptions& options) = 0; - + public abstract int SwitchChannel(string token, string channelId, ChannelMediaOptions options); - - -

      + + +

      Details

      This method allows the audience of an interactive live streaming channel to switch to a different channel.

      -

      After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

      +

      After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.

      Once the user switches to another channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.

      @@ -37,10 +37,10 @@ token

      The token generated at your server.

        -
      • In scenarios with low security requirements, token is optional and can be set as .
      • +
      • In scenarios with low security requirements, token is optional and can be set as .
      • In scenarios with high security requirements, set the value to the token generated from your server. If you enable the App Certificate, you must use a token to join the channel.
      - Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

      + Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.

      @@ -52,20 +52,20 @@
    • All uppercase English letters: A to Z.
    • All numeric characters: 0 to 9.
    • Space
    • -
    • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    • +
    • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    options - The channel media options. See . + The channel media options. See .
    Returns
    • 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.
        • -5: The request is rejected. This is probably because the user is not an audience member.
        • @@ -75,4 +75,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita index 25c56c42613..74bc073bab3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita @@ -1,21 +1,21 @@ - <ph keyref="unregisterAudioEncodedFrameObserver"/> + <ph keyref="unregisterAudioEncodedFrameObserver" /> Unregisters the encoded audio frame observer. - +

    - - - + + + abstract unregisterAudioEncodedFrameObserver( observer: IAudioEncodedFrameObserver ): number; @@ -26,7 +26,7 @@ ): number; void unregisterAudioEncodedFrameObserver(AudioEncodedFrameObserver observer); -

    +

    Parameters @@ -38,12 +38,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_unregisteraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita index d7588032f0e..5561b357549 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita @@ -13,10 +13,10 @@

    - - - - + + + + public abstract int UnRegisterAudioFrameObserver(); diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita index 9079b6d47d2..341e28b20fd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita @@ -21,13 +21,13 @@ public abstract int UpdateScreenCapture(ScreenCaptureParameters2 captureParams); abstract updateScreenCapture(captureParams: ScreenCaptureParameters2): number; Future<void> updateScreenCapture(ScreenCaptureParameters2 captureParams); -

    +

    Details

    If the system audio is not captured when screen sharing is enabled, and then you want to update the parameter configuration and publish the system audio, you can refer to the following steps:

      -
    1. Call this method, and set captureAudio to .
    2. -
    3. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.
    4. +
    5. Call this method, and set captureAudio to .
    6. +
    7. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.

      @@ -46,13 +46,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.
        -
      • +
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index b43a79f1ce3..9a817e0cbbb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -27,7 +27,7 @@ ): number;
    Future<void> updateScreenCaptureParameters( ScreenCaptureParameters captureParams); -

    +

    Details @@ -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.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita index af8ccc10121..896e8791aca 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita @@ -20,7 +20,7 @@ public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); abstract updateScreenCaptureRegion(regionRect: Rectangle): number; Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

        +

    Details @@ -47,8 +47,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_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita index 4d357579b6f..4df413dcf99 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita @@ -1,26 +1,26 @@ - <ph keyref="updateScreenCaptureRegion2"/> + <ph keyref="updateScreenCaptureRegion2" /> Updates the screen capturing region. - +

      - + - (int)updateScreenCaptureRegion:(CGRect)rect; virtual int updateScreenCaptureRegion(const Rect* rect) = 0; abstract updateScreenCaptureRegion(regionRect: Rectangle): number; public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); - + Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

      +

      Parameters @@ -28,15 +28,15 @@ rect regionRect - The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
      - <ph keyref="return-section-title"/> -

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

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

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. 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_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index 1926b7219ae..2cf86168db9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -30,7 +30,7 @@ ): number;
    Future<int> createDataStreamEx( {required DataStreamConfig config, required RtcConnection connection}); -

    +

    Details @@ -58,7 +58,7 @@
    • 0: The data stream is successfully created.
    • ID of the created data stream, if the 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_irtcengineex_enablecontentinspectex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita index c0dc2a5a7c4..98854c5e517 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita @@ -36,8 +36,8 @@
    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 uploads 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 uploads 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 diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index 18f12794ebf..b033808fc8a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita @@ -1,12 +1,12 @@ - <ph keyref="joinChannelEx"/> + <ph keyref="joinChannelEx" /> Joins a channel with the connection ID. - + @@ -38,7 +38,7 @@ {required String token, required RtcConnection connection, required ChannelMediaOptions options}); -

    +

    Details @@ -47,34 +47,34 @@
    • If you are already in a channel, you cannot rejoin it with the same user ID.
    • If you want to join the same channel from different devices, ensure that the user IDs are different for all devices.
    • -
    • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
    • -
    • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
    • +
    • Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
    • +
    • In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
    Parameters - - + + connection - The connection information. See . + The connection information. See . - - + + eventHandler delegate - The callback class of .See . + The callback class of .See . - - + +
    -
    +
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index f9a531c43a6..7b0fb1c0049 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamModeEx"/> + <ph keyref="setDualStreamModeEx" /> Sets the dual-stream mode on the sender side. - + @@ -32,11 +32,11 @@ streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number; - Future<void> setDualStreamModeEx( + Future<void> setDualStreamModeEx( {required SimulcastStreamMode mode, required SimulcastStreamConfig streamConfig, required RtcConnection connection}); -

    +

    Details @@ -46,10 +46,10 @@
    v4.0.1
    -

    The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

    - The difference and connection between this method and is as follows:
      -
    • When calling this method and setting mode to , it has the same effect as ().
    • -
    • When calling this method and setting mode to , it has the same effect as ().
    • +

      The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).

      + The difference and connection between this method and is as follows:
        +
      • When calling this method and setting mode to , it has the same effect as ().
      • +
      • When calling this method and setting mode to , it has the same effect as ().
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    @@ -57,23 +57,23 @@ mode - The mode in which the video stream is sent. See . + The mode in which the video stream is sent. 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_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index 2dc8b8161d6..5975b307f28 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita @@ -28,7 +28,7 @@ ): number; Future<void> setupRemoteVideoEx( {required VideoCanvas canvas, required RtcConnection connection}); -

    +

    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_irtcengineex_setvideoencoderconfigurationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita index 1ddbbe434ba..01d4f31d67b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita @@ -30,7 +30,7 @@ Future<void> setVideoEncoderConfigurationEx( {required VideoEncoderConfiguration config, required RtcConnection connection}); -

    +

    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_irtcengineex_startchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita index b9d4e5e12c1..74af9bcb24a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startChannelMediaRelayEx"/> + <ph keyref="startChannelMediaRelayEx" /> Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;
    - Future<void> startChannelMediaRelayEx( + Future<void> startChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

    +

    Details @@ -39,16 +39,16 @@
    This method is deprecated. Use instead.
    -

    After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

      -
    • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
    • -
    • If the callback returns (3), an exception occurs during the media stream relay.
    • +

      After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.

        +
      • If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
      • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
      • -
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
      • -
      • The relaying media streams across channels function needs to be enabled by contacting .
      • +
      • After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
      • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -58,16 +58,16 @@ 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.
        @@ -78,4 +78,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index c48db5d76e8..20723ed2831 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="startOrUpdateChannelMediaRelayEx"/> + <ph keyref="startOrUpdateChannelMediaRelayEx" /> Starts relaying media streams across channels or updates channels for media relay. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;
    - Future<void> startOrUpdateChannelMediaRelayEx( + Future<void> startOrUpdateChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

    +

    Details @@ -39,15 +39,15 @@
    v4.2.0

    The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.

    -

    After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

      -
    • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
    • -
    • If the callback returns (3), an exception occurs during the media stream relay.
    • +

      After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:

        +
      • If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
      • +
      • If the callback returns (3), an exception occurs during the media stream relay.

      • Call this method after joining the channel.
      • This method takes effect only when you are a host in a live streaming channel.
      • -
      • The relaying media streams across channels function needs to be enabled by contacting .
      • +
      • The relaying media streams across channels function needs to be enabled by contacting .
      • Agora does not support string user accounts in this API.
    @@ -57,16 +57,16 @@ 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.
        @@ -77,4 +77,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita index 276bd773c9d..3f0d78bcbd5 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita @@ -26,9 +26,9 @@ deviceIdUTF8: string, deviceCapabilityNumber: number ): VideoFormat;
    - Future<VideoFormat> getCapability( + Future<VideoFormat> getCapability( {required String deviceIdUTF8, required int deviceCapabilityNumber}); -

    +

    Details @@ -55,7 +55,7 @@ Returns
    • 0: Success.
    • -
    • < 0: Failure. See for details and resolution suggestions.
    +
  • < 0: Failure. See for details and resolution suggestions.
  • The specific information of the specified video format, including width (px), height (px), and frame rate (fps). See .

    \ 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 29df4a3a75e..3999b1526fb 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita @@ -13,8 +13,8 @@

    - - + + virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract setDevice(deviceIdUTF8: string): number; public abstract int SetDevice(string deviceIdUTF8); diff --git a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita index 5e938362dc7..48f3597553f 100644 --- a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita @@ -1,9 +1,8 @@ - <ph keyref="LocalAccessPointConfiguration"/> - The configurations of the Local Access Point. + <ph keyref="LocalAccessPointConfiguration" /> + The configurations of the Local Access Point.

    @@ -60,8 +59,8 @@ return logUploadServer; } }; - public ArrayList<String> ipList = null; - public ArrayList<String> domainList = null; + public ArrayList<String> ipList = null; + public ArrayList<String> domainList = null; public String verifyDomainName = null; public int mode = Constants.LOCAL_RPOXY_CONNECTIVITY_FIRST; public AdvancedConfigInfo advancedConfig = null; @@ -147,13 +146,13 @@ this.advancedConfig}); @JsonKey(name: 'ipList') - final List<String>? ipList; + final List<String>? ipList; @JsonKey(name: 'ipListSize') final int? ipListSize; @JsonKey(name: 'domainList') - final List<String>? domainList; + final List<String>? domainList; @JsonKey(name: 'domainListSize') final int? domainListSize; @@ -167,15 +166,15 @@ @JsonKey(name: 'advancedConfig') final AdvancedConfigInfo? advancedConfig; - factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) => _$LocalAccessPointConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> ipList @@ -200,17 +199,17 @@ mode -

    The connection mode. See .

    +

    The connection mode. See .

    Select one of the following connection modes:

      -
    • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
    • -
    • (1) The SDK only tries to connect to the specified Agora private media server.
    • +
    • (0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
    • +
    • (1) The SDK only tries to connect to the specified Agora private media server.

    advancedConfig - The advanced options for the Local Access Point. See . + The advanced options for the Local Access Point. See .
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_advanceoptions.dita b/en-US/dita/RTC-NG/API/class_advanceoptions.dita index 9bdc1a2e617..0dc3b8188c3 100644 --- a/en-US/dita/RTC-NG/API/class_advanceoptions.dita +++ b/en-US/dita/RTC-NG/API/class_advanceoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="AdvanceOptions"/> + <ph keyref="AdvanceOptions" /> Advanced options for video encoding.
    @@ -75,12 +75,12 @@ @JsonKey(name: 'compressionPreference') final CompressionPreference? compressionPreference; - factory AdvanceOptions.fromJson(Map<String, dynamic> json) => + factory AdvanceOptions.fromJson(Map<String, dynamic> json) => _$AdvanceOptionsFromJson(json); - Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); + Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this); } -

    +

    @@ -89,19 +89,19 @@
    v4.1.0
    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> encodingPreference - Video encoder preference. See . + Video encoder preference. See . compressionPreference - Compression preference for video encoding. See . + Compression preference for video encoding. See .
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita index 9293da4048f..8e884f6f6d3 100644 --- a/en-US/dita/RTC-NG/API/class_audioparams.dita +++ b/en-US/dita/RTC-NG/API/class_audioparams.dita @@ -1,7 +1,7 @@ - <ph keyref="AudioParams"/> + <ph keyref="AudioParams" /> Audio data format.
    @@ -98,33 +98,33 @@ @JsonKey(name: 'samples_per_call') final int? samplesPerCall; - factory AudioParams.fromJson(Map<String, dynamic> json) => + factory AudioParams.fromJson(Map<String, dynamic> json) => _$AudioParamsFromJson(json); - Map<String, dynamic> toJson() => _$AudioParamsToJson(this); + Map<String, dynamic> toJson() => _$AudioParamsToJson(this); } -

    +

    -

    You can pass the object in the following APIs to set the audio data format for the corresponding callback:

      -
    • : Sets the audio data format for the callback.
    • -
    • : Sets the audio data format for the callback.
    • -
    • : Sets the audio data format for the callback.
    • -
    • : Sets the audio data format for the callback.
    • +

      You can pass the object in the following APIs to set the audio data format for the corresponding callback:

        +
      • : Sets the audio data format for the callback.
      • +
      • : Sets the audio data format for the callback.
      • +
      • : Sets the audio data format for the callback.
      • +
      • : Sets the audio data format for the callback.

      -

      The SDK sets the audio data format in the following callbacks according to .

        -
      • -
      • -
      • +

        The SDK sets the audio data format in the following callbacks according to .

          +
        • +
        • +

          -
        • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
        • +
        • The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
        • Sample interval (sec) = samplePerCall/(sampleRate × channel).
        • Ensure that the sample interval ≥ 0.01 (s).
    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> sampleRate @@ -147,10 +147,10 @@ mode - The use mode of the audio data. See . + The use mode of the audio data. See . The use mode of the audio data, which can be set as either of the following values:
      -
    • (0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
    • -
    • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, 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): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
    • +
    • (2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, 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.
    @@ -160,4 +160,4 @@
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita index 039b4d298c6..b694d999d95 100644 --- a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita @@ -164,12 +164,12 @@ @JsonKey(name: 'recordingChannel') final int? recordingChannel; - factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => + factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) => _$AudioRecordingConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); + Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index 12b2e5c04f2..c0f274a22e8 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -1,7 +1,7 @@ - <ph keyref="CameraCapturerConfiguration"/> + <ph keyref="CameraCapturerConfiguration" /> The camera capturer preference.
    @@ -199,40 +199,40 @@ @JsonKey(name: 'followEncodeDimensionRatio') final bool? followEncodeDimensionRatio; - factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => + factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) => _$CameraCapturerConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); + Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <title> <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> cameraDirection - This parameter applies to Android and iOS only.The camera direction. See . + This parameter applies to Android and iOS only.The camera direction. See . format captureFormat - The format of the video frame. See . + The format of the video frame. See . deviceId This method applies to Windows only. - This method applies to macOS only.The ID of the camera. The maximum length is . + This method applies to macOS only.The ID of the camera. The maximum length is . followEncodeDimensionRatio - Whether to follow the video aspect ratio set in :
      -
    • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
    • -
    • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
    • + Whether to follow the video aspect ratio set in :
        +
      • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
      • +
      • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita index fa0acf721d0..95fe49b0845 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="ChannelMediaOptions"/> + <ph keyref="ChannelMediaOptions" /> The channel media options.
    @@ -80,8 +80,8 @@ struct ChannelMediaOptions { Optional<bool> publishCameraTrack; Optional<bool> publishSecondaryCameraTrack; - Optional<bool> publishThirdCameraTrack; - Optional<bool> publishFourthCameraTrack; + Optional<bool> publishThirdCameraTrack; + Optional<bool> publishFourthCameraTrack; Optional<bool> publishMicrophoneTrack; #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) @@ -90,8 +90,8 @@ #else Optional<bool> publishScreenTrack; Optional<bool> publishSecondaryScreenTrack; - Optional<bool> publishThirdScreenTrack; - Optional<bool> publishFourthScreenTrack; + Optional<bool> publishThirdScreenTrack; + Optional<bool> publishFourthScreenTrack; #endif Optional<bool> publishCustomAudioTrack; @@ -223,37 +223,37 @@ } public class ChannelMediaOptions : OptionalJsonParse { - public Optional<bool> publishCameraTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); - public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); - public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); - public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); - public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); - public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); - public Optional<bool> publishScreenTrack = new Optional<bool>(); - public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); - public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); - public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); - public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); - public Optional<int> publishCustomAudioTrackId = new Optional<int>(); - public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); - public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); - public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); - public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); - public Optional<bool> autoSubscribeAudio = new Optional<bool>(); - public Optional<bool> autoSubscribeVideo = new Optional<bool>(); - public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); - public Optional<int> publishMediaPlayerId = new Optional<int>(); - public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); - public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); - public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); - public Optional<string> token = new Optional<string>(); - public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); - public Optional<bool> isInteractiveAudience = new Optional<bool>(); - public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); - public Optional<bool> isAudioFilterable = new Optional<bool>(); + public Optional<bool> publishCameraTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>(); + public Optional<bool> publishThirdCameraTrack = new Optional<bool>(); + public Optional<bool> publishFourthCameraTrack = new Optional<bool>(); + public Optional<bool> publishMicrophoneTrack = new Optional<bool>(); + public Optional<bool> publishScreenCaptureVideo = new Optional<bool>(); + public Optional<bool> publishScreenCaptureAudio = new Optional<bool>(); + public Optional<bool> publishScreenTrack = new Optional<bool>(); + public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>(); + public Optional<bool> publishThirdScreenTrack = new Optional<bool>(); + public Optional<bool> publishFourthScreenTrack = new Optional<bool>(); + public Optional<bool> publishCustomAudioTrack = new Optional<bool>(); + public Optional<int> publishCustomAudioTrackId = new Optional<int>(); + public Optional<bool> publishCustomVideoTrack = new Optional<bool>(); + public Optional<bool> publishEncodedVideoTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>(); + public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>(); + public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>(); + public Optional<bool> autoSubscribeAudio = new Optional<bool>(); + public Optional<bool> autoSubscribeVideo = new Optional<bool>(); + public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>(); + public Optional<int> publishMediaPlayerId = new Optional<int>(); + public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>(); + public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>(); + public Optional<string> token = new Optional<string>(); + public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>(); + public Optional<bool> isInteractiveAudience = new Optional<bool>(); + public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>(); + public Optional<bool> isAudioFilterable = new Optional<bool>(); } export class ChannelMediaOptions { @@ -462,68 +462,68 @@ class ChannelMediaOptions { @JsonKey(name: 'isAudioFilterable') final bool? isAudioFilterable; - factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => + factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) => _$ChannelMediaOptionsFromJson(json); - Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); + Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this); } -

    +

    -
    Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters. +
    Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> publishCameraTrack Whether to publish the video captured by the camera:
      -
    • : Publish the video captured by the camera.
    • -
    • : Do not publish the video captured by the camera.
    • +
    • : Publish the video captured by the camera.
    • +
    • : Do not publish the video captured by the camera.
    publishSecondaryCameraTrack Whether to publish the video captured by the second camera:
      -
    • : Publish the video captured by the second camera.
    • -
    • : Do not publish the video captured by the second camera.
    • +
    • : Publish the video captured by the second camera.
    • +
    • : Do not publish the video captured by the second camera.
    publishMicrophoneTrack Whether to publish the audio captured by the microphone:
      -
    • : Publish the audio captured by the microphone.
    • -
    • : Do not publish the audio captured by the microphone.
    • +
    • : Publish the audio captured by the microphone.
    • +
    • : Do not publish the audio captured by the microphone.
    • As of v4.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
    • As of v6.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
    • -
    • If you set this parameter as , SDK turns off microphone capturing.
    • -
    • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
    • +
    • If you set this parameter as , SDK turns off microphone capturing.
    • +
    • If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
    publishThirdCameraTrack Whether to publish the video captured by the third camera:
      -
    • : Publish the video captured by the third camera.
    • -
    • : Do not publish the video captured by the third camera.
    • +
    • : Publish the video captured by the third camera.
    • +
    • : Do not publish the video captured by the third camera.

    This method is for Windows and macOS only.

    publishFourthCameraTrack Whether to publish the video captured by the fourth camera:
      -
    • : Publish the video captured by the fourth camera.
    • -
    • : Do not publish the video captured by the fourth camera.
    • +
    • : Publish the video captured by the fourth camera.
    • +
    • : Do not publish the video captured by the fourth camera.

    This method is for Windows and macOS only.

    publishScreenTrack

    Whether to publish the video captured from the screen:

      -
    • : Publish the video captured from the screen.
    • -
    • : Do not publish the video captured from the screen.
    • +
    • : Publish the video captured from the screen.
    • +
    • : Do not publish the video captured from the screen.

    This method is for Windows and macOS only.
    @@ -532,8 +532,8 @@ class ChannelMediaOptions { publishScreenCaptureVideo

    Whether to publish the video captured from the screen:

      -
    • : Publish the video captured from the screen.
    • -
    • : Do not publish the video captured from the screen.
    • +
    • : Publish the video captured from the screen.
    • +
    • : Do not publish the video captured from the screen.

    This parameter applies to Android and iOS only. As of v4.0.0, the parameter name is changed from publishScreenTrack to publishScreenCaptureVideo.
    @@ -542,8 +542,8 @@ class ChannelMediaOptions { publishScreenCaptureAudio

    Whether to publish the audio captured from the screen:

      -
    • : Publish the audio captured from the screen.
    • -
    • : Publish the audio captured from the screen.
    • +
    • : Publish the audio captured from the screen.
    • +
    • : Publish the audio captured from the screen.

    This parameter applies to Android and iOS only.
    @@ -551,16 +551,16 @@ class ChannelMediaOptions { publishSecondaryScreenTrack Whether to publish the video captured from the second screen:
      -
    • : Publish the video captured from the second screen.
    • -
    • : Do not publish the video captured from the second screen.
    • +
    • : Publish the video captured from the second screen.
    • +
    • : Do not publish the video captured from the second screen.
    publishThirdScreenTrack Whether to publish the video captured from the third screen:
      -
    • : Publish the captured video from the third screen.
    • -
    • : Do not publish the video captured from the third screen.
    • +
    • : Publish the captured video from the third screen.
    • +
    • : Do not publish the video captured from the third screen.

    This method is for Windows and macOS only.

    @@ -569,8 +569,8 @@ class ChannelMediaOptions { publishFourthScreenTrack Whether to publish the video captured from the fourth screen:
      -
    • : Publish the captured video from the fourth screen.
    • -
    • : Do not publish the video captured from the fourth screen.
    • +
    • : Publish the captured video from the fourth screen.
    • +
    • : Do not publish the video captured from the fourth screen.

    This method is for Windows and macOS only.

    @@ -579,8 +579,8 @@ class ChannelMediaOptions { publishTranscodedVideoTrack Whether to publish the local transcoded video:
      -
    • : Publish the local transcoded video.
    • -
    • : Do not publish the local transcoded video.
    • +
    • : Publish the local transcoded video.
    • +
    • : Do not publish the local transcoded video.

    As of v4.2.0, the parameter name is corrected from publishTrancodedVideoTrack to publishTranscodedVideoTrack.

    @@ -588,64 +588,64 @@ class ChannelMediaOptions { publishCustomAudioTrack Whether to publish the audio captured from a custom source:
      -
    • : Publish the audio captured from the custom source.
    • -
    • : Do not publish the captured audio from a custom source.
    • +
    • : Publish the audio captured from the custom source.
    • +
    • : Do not publish the captured audio from a custom source.
    publishCustomAudioTrackId - The ID of the custom audio source to publish. The default value is 0.

    If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

    + The ID of the custom audio source to publish. The default value is 0.

    If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

    publishCustomVideoTrack Whether to publish the video captured from a custom source:
      -
    • : Publish the video captured from the custom source.
    • -
    • : Do not publish the captured video from a custom source.
    • +
    • : Publish the video captured from the custom source.
    • +
    • : Do not publish the captured video from a custom source.
    publishEncodedVideoTrack Whether to publish the encoded video:
      -
    • : Publish the encoded video.
    • -
    • : Do not publish the encoded video.
    • +
    • : Publish the encoded video.
    • +
    • : Do not publish the encoded video.
    publishMediaPlayerAudioTrack Whether to publish the audio from the media player:
      -
    • : Publish the audio from the media player.
    • -
    • : Do not publish the audio from the media player.
    • +
    • : Publish the audio from the media player.
    • +
    • : Do not publish the audio from the media player.
    publishMediaPlayerVideoTrack Whether to publish the video from the media player:
      -
    • : Publish the video from the media player.
    • -
    • : Do not publish the video from the media player.
    • +
    • : Publish the video from the media player.
    • +
    • : Do not publish the video from the media player.
    autoSubscribeAudio Whether to automatically subscribe to all remote audio streams when the user joins a channel:
      -
    • : Subscribe to all remote audio streams.
    • -
    • : Do not automatically subscribe to any remote audio streams.
    • +
    • : Subscribe to all remote audio streams.
    • +
    • : Do not automatically subscribe to any remote audio streams.
    autoSubscribeVideo Whether to automatically subscribe to all remote video streams when the user joins the channel:
      -
    • : Subscribe to all remote video streams.
    • -
    • : Do not automatically subscribe to any remote video streams.
    • +
    • : Subscribe to all remote video streams.
    • +
    • : Do not automatically subscribe to any remote video streams.
    enableAudioRecordingOrPlayout Whether to enable audio capturing or playback:
      -
    • : Enable audio capturing or playback.
    • -
    • : Do not enable audio capturing or playback.
    • +
    • : Enable audio capturing or playback.
    • +
    • : Do not enable audio capturing or playback.
    - If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .
    + If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .
    publishMediaPlayerId @@ -653,23 +653,23 @@ class ChannelMediaOptions { clientRoleType - + clientRoleType - The user role. See . + The user role. See . - - + + defaultVideoStreamType - + channelProfile - + audioDelayMs @@ -681,8 +681,8 @@ class ChannelMediaOptions { publishCustomAudioTrackAec Whether to publish audio frames processed by an external echo cancellation module.
      -
    • : Publish audio frames processed by the external echo cancellation module.
    • -
    • : Do not publish to publish audio frames processed by the external echo cancellation module.
    • +
    • : Publish audio frames processed by the external echo cancellation module.
    • +
    • : Do not publish to publish audio frames processed by the external echo cancellation module.
    @@ -691,48 +691,48 @@ class ChannelMediaOptions {

    (Optional) The token generated on your server for authentication. See Authenticate Your Users with Token.

      -
    • This parameter takes effect only when calling or .
    • -
    • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
    • +
    • This parameter takes effect only when calling or .
    • +
    • Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
    startPreview Whether to automatically start the preview when joining a channel:
      -
    • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
    • -
    • : Do not automatically start the preview.
    • +
    • : Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
    • +
    • : Do not automatically start the preview.
    publishRhythmPlayerTrack Whether to publish the sound of a metronome to remote users:
      -
    • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
    • -
    • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
    • +
    • : Publish processed audio frames. Both the local user and remote users can hear the metronome.
    • +
    • : Do not publish the sound of the metronome. Only the local user can hear the metronome.
    isInteractiveAudience Whether to enable interactive mode:
      -
    • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
    • -
    • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
    • +
    • : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
    • +
    • :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
      -
    • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
    • -
    • This parameter takes effect only when the user role is .
    • +
    • This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
    • +
    • This parameter takes effect only when the user role is .
    customVideoTrackId - The video track ID returned by calling the method. The default value is 0. + The video track ID returned by calling the method. The default value is 0. isAudioFilterable Whether the audio stream being published is filtered according to the volume algorithm:
      -
    • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
    • -
    • : The audio stream is not filtered.
    • +
    • : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
    • +
    • : The audio stream is not filtered.
    - If you need to enable this function, contact .
    + If you need to enable this function, contact .
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita index 32d206bfbf4..0cec8673f65 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita @@ -1,17 +1,17 @@ - <ph keyref="ChannelMediaRelayConfiguration"/> + <ph keyref="ChannelMediaRelayConfiguration" /> Configuration of cross channel media relay.

    public class ChannelMediaRelayConfiguration { private ChannelMediaInfo srcInfo = null; - private Map<String, ChannelMediaInfo> destInfos = null; + private Map<String, ChannelMediaInfo> destInfos = null; public ChannelMediaRelayConfiguration() { - destInfos = new HashMap<String, ChannelMediaInfo>(); + destInfos = new HashMap<String, ChannelMediaInfo>(); srcInfo = new ChannelMediaInfo(null, null, 0); } @@ -31,7 +31,7 @@ return srcInfo; } - public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } } @@ -104,44 +104,44 @@ _$ChannelMediaRelayConfigurationFromJson(json); Map<String, dynamic> toJson() => _$ChannelMediaRelayConfigurationToJson(this); } -

    +

    Method setSrcChannelInfo - Sets the information of the source channel. See . + Sets the information of the source channel. See . setDestChannelInfo - Sets the information of the target channel. See . + Sets the information of the target channel. See . removeDestChannelInfo - Deletes the information of target channel. See . + Deletes the information of target channel. See . getSrcChannelMediaInfo - Gets the information of the source channel. See . + Gets the information of the source channel. See . getDestChannelMediaInfos - Gets the information of the target channel. See . + Gets the information of the target channel. See .
    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> srcInfo sourceInfo -

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

      -
    • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
    • +

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

        +
      • channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
      • token: The token for joining the source channel. This token is generated with the channelName and uid you set in srcInfo.
          -
        • 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, and the uid must be set as 0.
      • uid: The unique user ID to identify the relay stream in the source channel. Agora recommends leaving the default value of 0 unchanged.
      • @@ -152,10 +152,10 @@ destInfos destinationInfos -

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

          +

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

          • channelName: The name of the target channel.
          • token: The token for joining the target channel. It 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.
          • @@ -164,16 +164,16 @@ destCount - The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. + The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo. setDestinationInfo - Sets the information of the target channel. See . + Sets the information of the target channel. See . removeDestinationInfoForChannelName - Deletes the information of target channel. See . + Deletes the information of target channel. See .
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita index 0db7da8ee6a..e23d6c97366 100644 --- a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita +++ b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapInfo"/> + <ph keyref="CodecCapInfo" /> The codec capability of the device.
    @@ -70,10 +70,10 @@ class CodecCapInfo { @JsonKey(name: 'codecLevels') final CodecCapLevels? codecLevels; - factory CodecCapInfo.fromJson(Map<String, dynamic> json) => + factory CodecCapInfo.fromJson(Map<String, dynamic> json) => _$CodecCapInfoFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); + Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this); }

    @@ -83,14 +83,14 @@ class CodecCapInfo {
    v4.2.0
    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> codecType - The video codec types. See . + The video codec types. See .

    The video codec types:

    • 1: VP8.
    • @@ -100,7 +100,7 @@ class CodecCapInfo { codecCapMask - The bit mask of the codec type. See . + The bit mask of the codec type. See .

      The bit mask of the codec type:

      • (0): The device does not support encoding or decoding.
      • @@ -113,8 +113,8 @@ class CodecCapInfo { codecLevels - The level of the codec capability. See . + The level of the codec capability. See .
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita index 02291a389e8..b120ee0a9bf 100644 --- a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita +++ b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita @@ -1,7 +1,7 @@ - <ph keyref="CodecCapLevels"/> + <ph keyref="CodecCapLevels" /> The level of the codec capability.
    @@ -60,10 +60,10 @@ class CodecCapLevels { @JsonKey(name: 'swDecodingLevel') final VideoCodecCapabilityLevel? swDecodingLevel; - factory CodecCapLevels.fromJson(Map<String, dynamic> json) => + factory CodecCapLevels.fromJson(Map<String, dynamic> json) => _$CodecCapLevelsFromJson(json); - Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); + Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this); }

    @@ -73,19 +73,19 @@ class CodecCapLevels {
    v4.2.2
    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> hwDecodingLevel - Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . + Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See . swDecodingLevel - Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See . + Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See .
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita index a5b8be949a4..970de4ab592 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita @@ -1,7 +1,7 @@ - <ph keyref="ContentInspectConfig"/> + <ph keyref="ContentInspectConfig" /> Configuration of video screenshot and upload.
    @@ -95,16 +95,16 @@ class ContentInspectConfig { const ContentInspectConfig( {this.extraInfo, this.serverConfig, this.modules, this.moduleCount}); - @JsonKey(name: 'extraInfo') + @JsonKey(name: 'extraInfo') final String? extraInfo; - @JsonKey(name: 'serverConfig') + @JsonKey(name: 'serverConfig') final String? serverConfig; - @JsonKey(name: 'modules') + @JsonKey(name: 'modules') final List<ContentInspectModule>? modules; - @JsonKey(name: 'moduleCount') + @JsonKey(name: 'moduleCount') final int? moduleCount; factory ContentInspectConfig.fromJson(Map<String, dynamic> json) => @@ -112,7 +112,7 @@ class ContentInspectConfig { Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this); } -

    +

    Parameters @@ -143,20 +143,20 @@ class ContentInspectConfig { serverConfig - (Optional) Server configuration related to uploading video screenshots via extensions from Agora Extensions Marketplace. This parameter only takes effect when type in is set to . If you want to use it, contact . + (Optional) Server configuration related to uploading video screenshots via extensions from Agora Extensions Marketplace. This parameter only takes effect when type in is set to . If you want to use it, contact . modules -

    Functional module. See .

    -

    A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

    +

    Functional module. See .

    +

    A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

    A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.
    moduleCount - The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32. + The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32.
    -
    + \ 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 da868a40228..35ceab71c3d 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita @@ -1,8 +1,8 @@ - <ph keyref="ContentInspectModule"/> - A structure used to configure the frequency of video screenshot and upload. + <ph keyref="ContentInspectModule" /> + A structure used to configure the frequency of video screenshot and upload.

    @@ -56,19 +56,19 @@ final ContentInspectType? type; @JsonKey(name: 'interval') final int? interval; - factory ContentInspectModule.fromJson(Map<String, dynamic> json) => + factory ContentInspectModule.fromJson(Map<String, dynamic> json) => _$ContentInspectModuleFromJson(json); - Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); + Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> type - Types of functional module. See . + Types of functional module. See .

    Types of functional modules:

    • (0): (Default) This module has no actual function. Do not set to this value.
    • @@ -84,4 +84,4 @@
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita index 78da718d6ad..d453f97a3b4 100644 --- a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita +++ b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita @@ -299,12 +299,12 @@ @JsonKey(name: 'streamType') final VideoStreamType? streamType; - factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => + factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) => _$EncodedVideoFrameInfoFromJson(json); - Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); + Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -313,9 +313,9 @@ codecType The codec type of the local video stream. See . The default value is (2).

    The codec type of the video:

      -
    • (1): VP8.
    • -
    • (2): (Default) H.264.
    • -
    • (3): H.265.
    • +
    • (1): VP8.
    • +
    • (2): (Default) H.264.
    • +
    • (3): H.265.

    @@ -382,4 +382,4 @@
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita index 0a05a41985f..811b3e69def 100644 --- a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita +++ b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita @@ -177,58 +177,58 @@ class ExternalVideoFrame { this.alphaBuffer, this.textureSliceIndex}); - @JsonKey(name: 'type') + @JsonKey(name: 'type') final VideoBufferType? type; - @JsonKey(name: 'format') + @JsonKey(name: 'format') final VideoPixelFormat? format; - @JsonKey(name: 'buffer', ignore: true) + @JsonKey(name: 'buffer', ignore: true) final Uint8List? buffer; - @JsonKey(name: 'stride') + @JsonKey(name: 'stride') final int? stride; - @JsonKey(name: 'height') + @JsonKey(name: 'height') final int? height; - @JsonKey(name: 'cropLeft') + @JsonKey(name: 'cropLeft') final int? cropLeft; - @JsonKey(name: 'cropTop') + @JsonKey(name: 'cropTop') final int? cropTop; - @JsonKey(name: 'cropRight') + @JsonKey(name: 'cropRight') final int? cropRight; - @JsonKey(name: 'cropBottom') + @JsonKey(name: 'cropBottom') final int? cropBottom; - @JsonKey(name: 'rotation') + @JsonKey(name: 'rotation') final int? rotation; - @JsonKey(name: 'timestamp') + @JsonKey(name: 'timestamp') final int? timestamp; - @JsonKey(name: 'eglType') + @JsonKey(name: 'eglType') final EglContextType? eglType; - @JsonKey(name: 'textureId') + @JsonKey(name: 'textureId') final int? textureId; - @JsonKey(name: 'matrix') + @JsonKey(name: 'matrix') final List<double>? matrix; - @JsonKey(name: 'metadata_buffer', ignore: true) + @JsonKey(name: 'metadata_buffer', ignore: true) final Uint8List? metadataBuffer; - @JsonKey(name: 'metadata_size') + @JsonKey(name: 'metadata_size') final int? metadataSize; - @JsonKey(name: 'alphaBuffer', ignore: true) + @JsonKey(name: 'alphaBuffer', ignore: true) final Uint8List? alphaBuffer; - @JsonKey(name: 'texture_slice_index') + @JsonKey(name: 'texture_slice_index') final int? textureSliceIndex; factory ExternalVideoFrame.fromJson(Map<String, dynamic> json) => @@ -236,7 +236,7 @@ class ExternalVideoFrame { Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this); } -

    +

    @@ -414,4 +414,4 @@ class ExternalVideoFrame {
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita index 31ad3643074..452d88bb0fc 100644 --- a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita @@ -143,7 +143,7 @@ _$InjectStreamConfigFromJson(json); Map<String, dynamic> toJson() => _$InjectStreamConfigToJson(this); }
    -

    +

    diff --git a/en-US/dita/RTC-NG/API/class_livetranscoding.dita b/en-US/dita/RTC-NG/API/class_livetranscoding.dita index 0a6ae1719d9..003438e6b86 100644 --- a/en-US/dita/RTC-NG/API/class_livetranscoding.dita +++ b/en-US/dita/RTC-NG/API/class_livetranscoding.dita @@ -1,7 +1,7 @@ - <ph keyref="LiveTranscoding"/> + <ph keyref="LiveTranscoding" /> Transcoding configurations for Media Push.
    @@ -513,7 +513,7 @@ final int? userCount; @JsonKey(name: 'transcodingUsers') - final List<TranscodingUser>? transcodingUsers; + final List<TranscodingUser>? transcodingUsers; @JsonKey(name: 'transcodingExtraInfo') final String? transcodingExtraInfo; @@ -522,13 +522,13 @@ final String? metadata; @JsonKey(name: 'watermark') - final List<RtcImage>? watermark; + final List<RtcImage>? watermark; @JsonKey(name: 'watermarkCount') final int? watermarkCount; @JsonKey(name: 'backgroundImage') - final List<RtcImage>? backgroundImage; + final List<RtcImage>? backgroundImage; @JsonKey(name: 'backgroundImageCount') final int? backgroundImageCount; @@ -546,20 +546,20 @@ final AudioCodecProfileType? audioCodecProfile; @JsonKey(name: 'advancedFeatures') - final List<LiveStreamAdvancedFeature>? advancedFeatures; + final List<LiveStreamAdvancedFeature>? advancedFeatures; @JsonKey(name: 'advancedFeatureCount') final int? advancedFeatureCount; - factory LiveTranscoding.fromJson(Map<String, dynamic> json) => + factory LiveTranscoding.fromJson(Map<String, dynamic> json) => _$LiveTranscodingFromJson(json); - Map<String, dynamic> toJson() => _$LiveTranscodingToJson(this); + Map<String, dynamic> toJson() => _$LiveTranscodingToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> width @@ -615,8 +615,8 @@

    Latency mode:

      -
    • : Low latency with unassured quality.
    • -
    • : (Default) High latency with assured quality.
    • +
    • : Low latency with unassured quality.
    • +
    • : (Default) High latency with assured quality.
    @@ -626,17 +626,17 @@ videoCodecProfile -

    Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See for details.

    +

    Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See for details.

    If you set this parameter to any other value, Agora adjusts it to the default value.
    videoCodecType - Video codec profile types for Media Push. See . + Video codec profile types for Media Push. See . transcodingUsers -

    Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See .

    +

    Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See .

    @@ -663,7 +663,7 @@
    Deprecated
    -
    Obsolete and not recommended for use. Use instead.
    +
    Obsolete and not recommended for use. Use instead.
    @@ -677,7 +677,7 @@
    Deprecated
    -
    Obsolete and not recommended for use. Use instead.
    +
    Obsolete and not recommended for use. Use instead.

    The number of users in the Media Push. The value range is [0,17].

    @@ -698,25 +698,25 @@ watermark -

    The watermark on the live video. The image format needs to be PNG. See .

    +

    The watermark on the live video. The image format needs to be PNG. See .

    You can add one watermark, or add multiple watermarks using an array. This parameter is used with watermarkCount.

    backgroundImage -

    The number of background images on the live video. The image format needs to be PNG. See .

    +

    The number of background images on the live video. The image format needs to be PNG. See .

    You can add a background image or use an array to add multiple background images. This parameter is used with backgroundImageCount.

    backgroundImageArray - An array of background images on the live video. See . You can use backgroundImageArray to add one or more background images. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. + An array of background images on the live video. See . You can use backgroundImageArray to add one or more background images. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. audioSampleRate -

    The audio sampling rate (Hz) of the output media stream. See .

    +

    The audio sampling rate (Hz) of the output media stream. See .

    @@ -739,11 +739,11 @@ audioCodecProfile - Audio codec profile type for Media Push. See . + Audio codec profile type for Media Push. See . watermarkArray - The array of watermarks on the live video. See . You can add one or more watermarks using watermarkArray. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. + The array of watermarks on the live video. See . You can add one or more watermarks using watermarkArray. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10. watermarkCount @@ -755,7 +755,7 @@ advancedFeatures - Advanced features of the Media Push with transcoding. See . + Advanced features of the Media Push with transcoding. See . advancedFeatureCount @@ -767,27 +767,27 @@ addBackgroundImage - Adds a background image. See . + Adds a background image. See . addUser - Adds a user for video mixing during the CDN live streaming. See . + Adds a user for video mixing during the CDN live streaming. See . addWatermark - Adds a watermark. See . + Adds a watermark. See . getAdvancedFeatures - Gets the status of the advanced features of streaming with transcoding. See . + Gets the status of the advanced features of streaming with transcoding. See . getBackgroundColor - Gets the background color in hex. See . + Gets the background color in hex. See . getBackgroundImageList - Gets the list of background images. See . + Gets the list of background images. See . getBlue @@ -798,7 +798,7 @@
    Obsolete and not recommended for use.
    -

    Gets the background color's blue component. See .

    +

    Gets the background color's blue component. See .

    @@ -810,7 +810,7 @@
    Obsolete and not recommended for use.
    -

    Gets the background color's green component. See .

    +

    Gets the background color's green component. See .

    @@ -822,44 +822,44 @@
    Obsolete and not recommended for use.
    -

    Gets the background color's red component. See .

    +

    Gets the background color's red component. See .

    getUserCount - Gets the number of users transcoded in the CDN live streaming. See . + Gets the number of users transcoded in the CDN live streaming. See . getUsers - Gets the user list in the CDN live streaming. See . + Gets the user list in the CDN live streaming. See . getWatermarkList - Gets the watermark list. See . + Gets the watermark list. See . removeBackgroundImage - Removes a background image from the background image list. See . + Removes a background image from the background image list. See . removeUser - Removes a user from video mixing during the CDN live streaming. See . + Removes a user from video mixing during the CDN live streaming. See . removeWatermark - Removes a watermark from the watermark list. See . + Removes a watermark from the watermark list. See . setAdvancedFeatures - Sets whether to enable the advanced features of streaming with transcoding. See . + Sets whether to enable the advanced features of streaming with transcoding. See . setBackgroundColor [1/2] - Sets the background color of the CDN live stream in the format of RGB hex. See . + Sets the background color of the CDN live stream in the format of RGB hex. See . setBackgroundColor [2/2] - Sets the background color in RGB format. See . + Sets the background color in RGB format. See . setBlue @@ -870,7 +870,7 @@
    Obsolete and not recommended for use.
    -

    Sets the background color's blue component. See .

    +

    Sets the background color's blue component. See .

    @@ -882,7 +882,7 @@
    Obsolete and not recommended for use.
    -

    Sets the background color's green component. See .

    +

    Sets the background color's green component. See .

    @@ -894,22 +894,22 @@
    Obsolete and not recommended for use.
    -

    Sets the background color's red component. See .

    +

    Sets the background color's red component. See .

    setUsers [1/2] - Sets the users in batches in the CDN live streaming. See . + Sets the users in batches in the CDN live streaming. See . setUsers [2/2] - Sets the users in batches in the CDN live streaming. See . + Sets the users in batches in the CDN live streaming. See . defaultTranscoding - Applies the default transcoding settings, see . + Applies the default transcoding settings, see .
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita index d94f8db1be2..1c28c605b5c 100644 --- a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita @@ -1,24 +1,24 @@ - <ph keyref="LocalTranscoderConfiguration"/> + <ph keyref="LocalTranscoderConfiguration" /> The configuration of the video mixing on the local client.

    public class LocalTranscoderConfiguration { - public ArrayList<TranscodingVideoStream> transcodingVideoStreams; + public ArrayList<TranscodingVideoStream> transcodingVideoStreams; public VideoEncoderConfiguration videoOutputConfiguration; public LocalTranscoderConfiguration() { - transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); + transcodingVideoStreams = new ArrayList<TranscodingVideoStream>(); videoOutputConfiguration = new VideoEncoderConfiguration(); } } __attribute__((visibility("default"))) @interface AgoraLocalTranscoderConfiguration: NSObject -@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; +@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams; @property (strong, nonatomic) AgoraVideoEncoderConfiguration *_Nonnull videoOutputConfiguration; @@ -68,19 +68,19 @@ class LocalTranscoderConfiguration { final int? streamCount; @JsonKey(name: 'videoInputStreams') - final List<TranscodingVideoStream>? videoInputStreams; + final List<TranscodingVideoStream>? videoInputStreams; @JsonKey(name: 'videoOutputConfiguration') final VideoEncoderConfiguration? videoOutputConfiguration; - factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => + factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) => _$LocalTranscoderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this); }

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> streamCount @@ -89,12 +89,12 @@ class LocalTranscoderConfiguration { videoInputStreams transcodingVideoStreams - The video streams for local video mixing. See . + The video streams for local video mixing. See . videoOutputConfiguration - The encoding configuration of the mixed video stream after the local video mixing. See . + The encoding configuration of the mixed video stream after the local video mixing. See .
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_localvideostats.dita b/en-US/dita/RTC-NG/API/class_localvideostats.dita index 109b362474a..8aa1b1f5ae7 100644 --- a/en-US/dita/RTC-NG/API/class_localvideostats.dita +++ b/en-US/dita/RTC-NG/API/class_localvideostats.dita @@ -1,7 +1,7 @@ - <ph keyref="LocalVideoStats"/> + <ph keyref="LocalVideoStats" /> The statistics of the local video stream.
    @@ -296,15 +296,15 @@ @JsonKey(name: 'hwEncoderAccelerating') final int? hwEncoderAccelerating; - factory LocalVideoStats.fromJson(Map<String, dynamic> json) => + factory LocalVideoStats.fromJson(Map<String, dynamic> json) => _$LocalVideoStatsFromJson(json); - Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); + Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> uid @@ -362,11 +362,11 @@ qualityAdaptIndication - The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

    + The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .

      -
    • (0): The local video quality stays the same.
    • -
    • (1): The local video quality improves because the network bandwidth increases.
    • -
    • (2): The local video quality deteriorates because the network bandwidth decreases.
    • +
    • (0): The local video quality stays the same.
    • +
    • (1): The local video quality improves because the network bandwidth increases.
    • +
    • (2): The local video quality deteriorates because the network bandwidth decreases.

    @@ -390,11 +390,11 @@ codecType - The codec type of the local video. See .

    + The codec type of the local video. See .

      -
    • (1): VP8.
    • -
    • (2): (Default) H.264.
    • -
    • (3): H.265.
    • +
    • (1): VP8.
    • +
    • (2): (Default) H.264.
    • +
    • (3): H.265.

    @@ -408,24 +408,24 @@ captureBrightnessLevel - The brightness level of the video image captured by the local camera. See . + The brightness level of the video image captured by the local camera. See . captureBrightnessLevel The brightness level of the video image captured by the local camera.
      -
    • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
    • -
    • (0): The brightness level of the video image is normal.
    • -
    • (1): The brightness level of the video image is too bright.
    • -
    • (2): The brightness level of the video image is too dark.
    • +
    • (-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
    • +
    • (0): The brightness level of the video image is normal.
    • +
    • (1): The brightness level of the video image is too bright.
    • +
    • (2): The brightness level of the video image is too dark.
    hwEncoderAccelerating - The local video encoding acceleration type. See .
      + The local video encoding acceleration type. See .
      • 0: Software encoding is applied without acceleration.
      • 1: Hardware encoding is applied for acceleration.
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita index e76727e38a1..0fce85b477d 100644 --- a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita @@ -93,12 +93,12 @@ @JsonKey(name: 'recorderInfoUpdateInterval') final int? recorderInfoUpdateInterval; - factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => + factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) => _$MediaRecorderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this); }
    -

    +

    @@ -109,10 +109,10 @@ storagePath The absolute path (including the filename extensions) of the recording file. For example:

      -
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
    • +
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4
    • iOS: /App Sandbox/Library/Caches/example.mp4
    • macOS: ~/Library/Logs/example.mp4
    • -
    • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
    • +
    • Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4
    Ensure that the directory for the log files exists and is writable. @@ -123,7 +123,7 @@ streamType - The recording content. See . + The recording content. See . The recording content:
    • : Only audio.
    • : Only video.
    • @@ -140,4 +140,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita index 5f87bc7a086..3d76952e6e7 100644 --- a/en-US/dita/RTC-NG/API/class_mediasource.dita +++ b/en-US/dita/RTC-NG/API/class_mediasource.dita @@ -1,7 +1,7 @@ - <ph keyref="MediaSource"/> + <ph keyref="MediaSource" /> Information related to the media file to be played and the playback scenario configurations.
    @@ -134,12 +134,12 @@ @JsonKey(name: 'isLiveSource') final bool? isLiveSource; - factory MediaSource.fromJson(Map<String, dynamic> json) => + factory MediaSource.fromJson(Map<String, dynamic> json) => _$MediaSourceFromJson(json); - Map<String, dynamic> toJson() => _$MediaSourceToJson(this); + Map<String, dynamic> toJson() => _$MediaSourceToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -207,7 +207,7 @@ provider -

    The callback for custom media resource files. See .

    +

    The callback for custom media resource files. See .

    If you open a custom media resource, pass in the value to provider. If you open a common media resource, pass in the value to url. Agora recommends that you do not pass in values to both url and provider in one call; otherwise, this call may fail.

    @@ -216,19 +216,19 @@ playerOnReadCallback -

    Occurs when the SDK reads the media resource data. See .

    +

    Occurs when the SDK reads the media resource data. See .

    -

    +

    playerOnSeekCallback -

    Occurs when the SDK seeks the media resource data. See .

    +

    Occurs when the SDK seeks the media resource data. See .

    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita index c6dede7d234..d46370f7af9 100644 --- a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita @@ -260,10 +260,10 @@ @JsonKey(name: 'qualityChangedReason') final int? qualityChangedReason; - factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => + factory RemoteAudioStats.fromJson(Map<String, dynamic> json) => _$RemoteAudioStatsFromJson(json); - Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); + Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this); }

    diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita index a7d2f86a57d..d8d2ccef7f4 100644 --- a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita +++ b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita @@ -1,8 +1,8 @@ - <ph keyref="RtcEngineConfig"/> - Configurations for the instance. + <ph keyref="RtcEngineConfig" /> + Configurations for the instance.

    @@ -214,25 +214,25 @@ class RtcEngineContext { @JsonKey(name: 'autoRegisterAgoraExtensions') final bool? autoRegisterAgoraExtensions; - factory RtcEngineContext.fromJson(Map<String, dynamic> json) => + factory RtcEngineContext.fromJson(Map<String, dynamic> json) => _$RtcEngineContextFromJson(json); - Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); + Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> eventHandler mEventHandler - The event handler for . See . + The event handler for . See . appId mAppId - The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. + The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one. context @@ -256,33 +256,33 @@ class RtcEngineContext {
    • This method is applicable when you integrate the SDK manually but not when you integrate the SDK with Maven Central or JitPack.
    • -
    • Ensure the specified directory exists; otherwise, the initialization fails.
    • +
    • Ensure the specified directory exists; otherwise, the initialization fails.
    channelProfile mChannelProfile - + audioScenario mAudioScenario - + areaCode mAreaCode - The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. + The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. After specifying the region, the app integrated with the Agora SDK connects to the Agora servers within that region. logConfig mLogConfig -

    Sets the log file size. See .

    +

    Sets the log file size. See .

    By default, the SDK generates five SDK log files and five API call log files with the following rules:

      -
    • +
    @@ -292,19 +292,19 @@ class RtcEngineContext { mExtensionObserver eventDelegate - The instance. + The instance. mediaFilterExtensions - The instance. + The instance. mDomainLimit domainLimit

    Whether to enable domain name restriction:

      -
    • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
    • -
    • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
    • +
    • : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
    • +
    • : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.

    @@ -312,9 +312,9 @@ class RtcEngineContext { mAutoRegisterAgoraExtensions autoRegisterAgoraExtensions -

    Whether to automatically register the Agora extensions when initializing :

      -
    • : (Default) Automatically register the Agora extensions when initializing .
    • -
    • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.
    • +

      Whether to automatically register the Agora extensions when initializing :

        +
      • : (Default) Automatically register the Agora extensions when initializing .
      • +
      • : Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.

      @@ -324,9 +324,9 @@ class RtcEngineContext { addExtension - Adds the extension. See . + Adds the extension. See .
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita index 8d5a72b3fa8..0d43f31acc0 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita @@ -101,7 +101,7 @@ __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguratio _$ScreenCaptureConfigurationFromJson(json); Map<String, dynamic> toJson() => _$ScreenCaptureConfigurationToJson(this); }
    -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita index 8d41f2b02c2..303f196dce1 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureParameters"/> + <ph keyref="ScreenCaptureParameters" /> Screen sharing configurations.

    - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureParameters: NSObject @property (assign, nonatomic) CGSize dimensions; @property (assign, nonatomic) NSInteger frameRate; @@ -206,7 +206,7 @@ final bool? windowFocus; @JsonKey(name: 'excludeWindowList') - final List<int>? excludeWindowList; + final List<int>? excludeWindowList; @JsonKey(name: 'excludeWindowCount') final int? excludeWindowCount; @@ -220,21 +220,21 @@ @JsonKey(name: 'enableHighLight') final bool? enableHighLight; - factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParametersFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParametersToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - The video profiles of the shared screen stream are only set by , independent of . + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + The video profiles of the shared screen stream are only set by , independent of . dimensions -

    The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

    +

    The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.

    If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose dimensions is set to 1920 × 1080:

    • If the value of the screen dimensions is lower than that of dimensions, for example, 1000 × 1000 pixels, the SDK uses the screen dimensions, that is, 1000 × 1000 pixels, for encoding.
    • If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under dimensions with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 × 1080.
    • @@ -253,33 +253,33 @@ captureMouseCursor

      Whether to capture the mouse in screen sharing:

        -
      • : (Default) Capture the mouse.
      • -
      • : Do not capture the mouse.
      • +
      • : (Default) Capture the mouse.
      • +
      • : Do not capture the mouse.

      - Due to macOS system restrictions, setting this parameter to is ineffective during screen sharing (it has no impact when sharing a window). + Due to macOS system restrictions, setting this parameter to is ineffective during screen sharing (it has no impact when sharing a window).
      windowFocus -

      Whether to bring the window to the front when calling the method to share it:

        -
      • : Bring the window to the front.
      • -
      • : (Default) Do not bring the window to the front.
      • +

        Whether to bring the window to the front when calling the method to share it:

          +
        • : Bring the window to the front.
        • +
        • : (Default) Do not bring the window to the front.

        excludeWindowList - The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. + The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window. highLighted enableHighLight (For macOS and Windows only) Whether to place a border around the shared window or screen:
          -
        • : Place a border.
        • -
        • : (Default) Do not place a border.
        • +
        • : Place a border.
        • +
        • : (Default) Do not place a border.
        - When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .
        + When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .
        highLightColor @@ -289,7 +289,7 @@ highLightWidth - (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . + (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to . excludeWindowCount @@ -298,4 +298,4 @@
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita index c13c18f9924..0527a680bb0 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita @@ -1,7 +1,7 @@ - <ph keyref="ScreenCaptureParameters2"/> + <ph keyref="ScreenCaptureParameters2" /> Screen sharing configurations.
    @@ -169,58 +169,58 @@ @JsonKey(name: 'videoParams') final ScreenVideoParameters? videoParams; - factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) => _$ScreenCaptureParameters2FromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this); } -

    +

    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> captureAudio Determines whether to capture system audio during screen sharing:
      -
    • : Capture system audio.
    • -
    • : (Default) Do not capture system audio.
    • +
    • : Capture system audio.
    • +
    • : (Default) Do not capture system audio.
    • Due to system limitations, capturing system audio is only applicable to Android API level 29 and later (that is, Android 10 and later).
    • -
    • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
    +
  • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
  • audioParams - The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . + The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . captureVideo Whether to capture the screen when screen sharing:
      -
    • : (Default) Capture the screen.
    • -
    • : Do not capture the screen.
    • +
    • : (Default) Capture the screen.
    • +
    • : Do not capture the screen.
    Due to system limitations, the capture screen is only applicable to Android API level 21 and above, that is, Android 5 and above.
    videoParams - The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is . + The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is .
    Subclass - - The video configuration for the shared screen stream. See . + + The video configuration for the shared screen stream. See . - - The audio configuration for the shared screen stream. See . + + The audio configuration for the shared screen stream. See .
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita index 7e34c34419f..11b9db647ba 100644 --- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="ScreenCaptureSourceInfo"/> - The information about the specified shareable window or screen. The information is returned in . + <ph keyref="ScreenCaptureSourceInfo" /> + The information about the specified shareable window or screen. The information is returned in .

    - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureSourceInfo : NSObject @property(assign, nonatomic) AgoraScreenCaptureSourceType type; @property(assign, nonatomic) CGWindowID sourceId; @@ -76,7 +76,7 @@ public Rectangle position; public view_t sourceDisplayId; }; - + class ScreenCaptureSourceInfo { const ScreenCaptureSourceInfo( {this.type, @@ -124,19 +124,19 @@ @JsonKey(name: 'sourceDisplayId') final int? sourceDisplayId; - factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => _$ScreenCaptureSourceInfoFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> type - The type of the shared target. See . + The type of the shared target. See . sourceId @@ -148,11 +148,11 @@ thumbImage - The image content of the thumbnail. See . + The image content of the thumbnail. See . iconImage - The image content of the icon. See . + The image content of the icon. See . processPath @@ -165,19 +165,19 @@ primaryMonitor Determines whether the screen is the primary display:
      -
    • : The screen is the primary display.
    • -
    • : The screen is not the primary display.
    • +
    • : The screen is the primary display.
    • +
    • : The screen is not the primary display.
    position - The position of a window relative to the entire screen space (including all shareable screens). See . See . + The position of a window relative to the entire screen space (including all shareable screens). See . See . minimizeWindow (For Windows only) Whether the window is minimized:
      -
    • : The window is minimized.
    • -
    • : The window is not minimized.
    • +
    • : The window is minimized.
    • +
    • : The window is not minimized.
    @@ -186,4 +186,4 @@
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita index 3d0308e16a3..d6b9c671871 100644 --- a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita +++ b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita @@ -1,7 +1,7 @@ - <ph keyref="TranscodingVideoStream"/> + <ph keyref="TranscodingVideoStream" /> The video streams for local video mixing.
    @@ -176,18 +176,18 @@ class TranscodingVideoStream { @JsonKey(name: 'mirror') final bool? mirror; - factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => + factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) => _$TranscodingVideoStreamFromJson(json); - Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); + Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this); }

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> sourceType - The video source type for local video mixing. See . + The video source type for local video mixing. See . remoteUserUid @@ -203,7 +203,7 @@ class TranscodingVideoStream { mediaPlayerId - (Optional) Media player ID. Use the parameter only when you set sourceType to . + (Optional) Media player ID. Use the parameter only when you set sourceType to . x @@ -246,4 +246,4 @@ class TranscodingVideoStream {
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita index e596c79a50d..83b1e96284f 100644 --- a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita +++ b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita @@ -53,7 +53,7 @@ _$UserAudioSpectrumInfoFromJson(json); Map<String, dynamic> toJson() => _$UserAudioSpectrumInfoToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_videocanvas.dita b/en-US/dita/RTC-NG/API/class_videocanvas.dita index 802aaae693d..239a10a4f4c 100644 --- a/en-US/dita/RTC-NG/API/class_videocanvas.dita +++ b/en-US/dita/RTC-NG/API/class_videocanvas.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoCanvas"/> + <ph keyref="VideoCanvas" /> Attributes of the video canvas object.
    @@ -173,16 +173,16 @@ class VideoCanvas { @JsonKey(name: 'enableAlphaMask') final bool? enableAlphaMask; - factory VideoCanvas.fromJson(Map<String, dynamic> json) => + factory VideoCanvas.fromJson(Map<String, dynamic> json) => _$VideoCanvasFromJson(json); - Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); + Map<String, dynamic> toJson() => _$VideoCanvasToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> view @@ -193,16 +193,16 @@ class VideoCanvas { renderMode - The rendering mode of the video. See . -
    + The rendering mode of the video. See . +
    mirrorMode -

    The mirror mode of the view. See .

    +

    The mirror mode of the view. See .

      -
    • +

      @@ -216,7 +216,7 @@ class VideoCanvas { sourceType - The type of the video source. See . + The type of the video source. See . sourceId @@ -224,29 +224,29 @@ class VideoCanvas { setupMode - Setting mode of the view. See . + Setting mode of the view. See . Setting mode of the view.
        -
      • (0): (Default) Replaces a view.
      • -
      • (1): Adds a view.
      • -
      • (2): Deletes a view.
      • +
      • (0): (Default) Replaces a view.
      • +
      • (1): Adds a view.
      • +
      • (2): Deletes a view.
      mediaPlayerId - The ID of the media player. You can get the Device ID by calling . - This parameter is required when sourceType is . + The ID of the media player. You can get the Device ID by calling . + This parameter is required when sourceType is . rect - (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. cropArea - (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. + (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. backgroundColor @@ -256,15 +256,15 @@ class VideoCanvas { enableAlphaMask

      (Optional) Whether the receiver enables alpha mask rendering:

        -
      • : The receiver enables alpha mask rendering.
      • -
      • : (default) The receiver disables alpha mask rendering.
      • +
      • : The receiver enables alpha mask rendering.
      • +
      • : (default) The receiver disables alpha mask rendering.

      Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as picture-in-picture and watermarking.

      -
      • This property applies to macOS only.
      • The receiver can render alpha channel information only when the sender enables alpha transmission.
      • To enable alpha transmission, .
      +
      • This property applies to macOS only.
      • The receiver can render alpha channel information only when the sender enables alpha transmission.
      • To enable alpha transmission, .
      Reserved.
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 15fbcf7c09d..ac76a9da5b3 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoEncoderConfiguration"/> + <ph keyref="VideoEncoderConfiguration" /> Video encoder configurations.
    @@ -420,43 +420,41 @@ @JsonKey(name: 'advanceOptions') final AdvanceOptions? advanceOptions; - factory VideoEncoderConfiguration.fromJson(Map<String, dynamic> json) => + factory VideoEncoderConfiguration.fromJson(Map<String, dynamic> json) => _$VideoEncoderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); } -

    +

    - <text - conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" - /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> dimensions -

    The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.

    +

    The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.

    Users can set the resolution by themselves, or directly select the desired resolution from the following list:

      -
    • : The video resolution is 120 × 120.
    • -
    • : The video resolution is 160 × 120.
    • -
    • : The video resolution is 180 × 180.
    • -
    • : The video resolution is 240 × 180.
    • -
    • : The video resolution is 320 × 180.
    • -
    • : The video resolution is 240 × 240.
    • -
    • : The video resolution is 320 × 240.
    • -
    • : The video resolution is 424 × 240.
    • -
    • : The video resolution is 360 × 360.
    • -
    • : The video resolution is 480 × 360.
    • -
    • : The video resolution is 640 × 360.
    • -
    • : The video resolution is 480 × 480.
    • -
    • : The video resolution is 640 × 480.
    • -
    • : The video resolution is 840 × 480.
    • -
    • : The video resolution is 960 × 540.
    • -
    • : The video resolution is 960 × 720.
    • -
    • : The video resolution is 1280 × 720.
    • -
    • : The video resolution is 1920 × 1080.
    • -
    • : The video resolution is 2540 × 1440.
    • -
    • : The video resolution is 3840 × 2160.
    • +
    • : The video resolution is 120 × 120.
    • +
    • : The video resolution is 160 × 120.
    • +
    • : The video resolution is 180 × 180.
    • +
    • : The video resolution is 240 × 180.
    • +
    • : The video resolution is 320 × 180.
    • +
    • : The video resolution is 240 × 240.
    • +
    • : The video resolution is 320 × 240.
    • +
    • : The video resolution is 424 × 240.
    • +
    • : The video resolution is 360 × 360.
    • +
    • : The video resolution is 480 × 360.
    • +
    • : The video resolution is 640 × 360.
    • +
    • : The video resolution is 480 × 480.
    • +
    • : The video resolution is 640 × 480.
    • +
    • : The video resolution is 840 × 480.
    • +
    • : The video resolution is 960 × 540.
    • +
    • : The video resolution is 960 × 720.
    • +
    • : The video resolution is 1280 × 720.
    • +
    • : The video resolution is 1920 × 1080.
    • +
    • : The video resolution is 2540 × 1440.
    • +
    • : The video resolution is 3840 × 2160.
      @@ -467,19 +465,19 @@ codecType - The codec type of the local video stream. See . + The codec type of the local video stream. See . frameRate - The frame rate (fps) of the encoding video frame. The default value is 15. See . + The frame rate (fps) of the encoding video frame. The default value is 15. See . bitrate -

      The encoding bitrate (Kbps) of the video. See .

      +

      The encoding bitrate (Kbps) of the video. See .

        -
      • -
      • +
      • +
      @@ -491,16 +489,16 @@ orientationMode - The orientation mode of the encoded video. See . + The orientation mode of the encoded video. See . degradationPreference - Video degradation preference under limited bandwidth. See . + Video degradation preference under limited bandwidth. See . mirrorMode -

      Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See .

      +

      Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See .

      The mirror mode specified in video encoder configurations only affect the view of remote users.

      • (0): The SDK determines whether to enable the mirror mode. The SDK disables mirror mode by default.
      • (1): Enables the mirror mode for remote users.
      • @@ -510,7 +508,7 @@ advanceOptions - Advanced options for video encoding. See . + Advanced options for video encoding. See .
    @@ -518,13 +516,13 @@ initWithSize - Specifies the video resolution and initializes the object. See . + Specifies the video resolution and initializes the object. See . initWithWidth - Specifies the video width and height, and initializes the object. See . + Specifies the video width and height, and initializes the object. See .
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita index 6c92820296a..820f0dc0beb 100644 --- a/en-US/dita/RTC-NG/API/class_videoframe.dita +++ b/en-US/dita/RTC-NG/API/class_videoframe.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoFrame"/> + <ph keyref="VideoFrame" /> Configurations of the video frame.
    @@ -476,28 +476,28 @@ class VideoFrame { final int? textureId; @JsonKey(name: 'matrix') - final List<double>? matrix; + final List<double>? matrix; @JsonKey(name: 'pixelBuffer', ignore: true) final Uint8List? pixelBuffer; - factory VideoFrame.fromJson(Map<String, dynamic> json) => + factory VideoFrame.fromJson(Map<String, dynamic> json) => _$VideoFrameFromJson(json); - Map<String, dynamic> toJson() => _$VideoFrameToJson(this); + Map<String, dynamic> toJson() => _$VideoFrameToJson(this); } -

    +

    Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> type - The pixel format. See . - + The pixel format. See . + width @@ -602,7 +602,7 @@ class VideoFrame { colorSpace - The color space of a video frame. See . + The color space of a video frame. See . sourceType @@ -620,9 +620,9 @@ class VideoFrame { alphaBuffer

    Indicates the alpha channel data output by the portrait segmentation algorithm, which is consistent with the size of the video frame. The value range of each pixel is [0,255], where 0 represents the background; 255 represents the foreground (portrait).

    -

    In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .

    +

    In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.To use this parameter, contact .

    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita index ed72701605a..3eb62b97334 100644 --- a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoSubscriptionOptions"/> + <ph keyref="VideoSubscriptionOptions" /> Video subscription options.
    @@ -48,8 +48,8 @@ @end struct VideoSubscriptionOptions { - Optional<VIDEO_STREAM_TYPE> type; - Optional<bool> encodedFrameOnly; + Optional<VIDEO_STREAM_TYPE> type; + Optional<bool> encodedFrameOnly; VideoSubscriptionOptions() {} }; @@ -61,9 +61,9 @@ } public class VideoSubscriptionOptions:OptionalJsonParse { - public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); + public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>(); - public Optional<bool> encodedFrameOnly = new Optional<bool>(); + public Optional<bool> encodedFrameOnly = new Optional<bool>(); } export class VideoSubscriptionOptions { @@ -80,33 +80,33 @@ @JsonKey(name: 'encodedFrameOnly') final bool? encodedFrameOnly; - factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => + factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) => _$VideoSubscriptionOptionsFromJson(json); - Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); + Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> streamType type - The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . + The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . The video stream type that you want to subscribe to:
      -
    • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
    • -
    • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
    • +
    • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
    • +
    • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
    encodedFrameOnly Whether to subscribe to encoded video frames only:
      -
    • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
    • -
    • : (Default) Subscribe to both raw video data and encoded video data.
    • +
    • : Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
    • +
    • : (Default) Subscribe to both raw video data and encoded video data.
    -
    + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita index 14f964b573c..51b194856e3 100644 --- a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita +++ b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="WatermarkOptions"/> + <ph keyref="WatermarkOptions" /> Configurations of the watermark image.
    @@ -121,13 +121,13 @@ _$WatermarkOptionsFromJson(json); Map<String, dynamic> toJson() => _$WatermarkOptionsToJson(this); } -

    +

    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> visibleInPreview @@ -135,8 +135,8 @@ positionInLandscapeMode - The area to display the watermark image in landscape mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . + The area to display the watermark image in landscape mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See . The area to display the watermark image in landscape mode. This parameter contains the following members:
    • x: The horizontal position of the watermark relative to the upper left corner.
    • y: The vertical position of the watermark relative to the upper left corner.
    • @@ -146,8 +146,8 @@ positionInPortraitMode - The area to display the watermark image in portrait mode. See . - When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . + The area to display the watermark image in portrait mode. See . + When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See . The area to display the watermark image in portrait mode. This parameter contains the following members:
      • x: The horizontal position of the watermark relative to the upper left corner.
      • y: The vertical position of the watermark relative to the upper left corner.
      • @@ -157,12 +157,12 @@ watermarkRatio - When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . + When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See . mode - The adaptation mode of the watermark. See . + The adaptation mode of the watermark. See .
    -
    + \ No newline at end of file From 15d530e406149e384818365c09bd169e3d8626b3 Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Tue, 26 Sep 2023 16:16:51 +0800 Subject: [PATCH 5/6] add isfeaturesupported in releasenotes --- dita/RTC-NG/release/release_notes.dita | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/dita/RTC-NG/release/release_notes.dita b/dita/RTC-NG/release/release_notes.dita index b490792e440..bd7e01c186f 100644 --- a/dita/RTC-NG/release/release_notes.dita +++ b/dita/RTC-NG/release/release_notes.dita @@ -34,6 +34,11 @@
  • (27):进行屏幕采集的窗口已经从最小化状态中恢复。
  • +
  • 进阶功能查询 +

    该版本新增了 方法,用于查询设备能力是否满足虚拟背景、美颜等进阶功能的使用要求。

    +

    在使用进阶功能前,你可以根据查询结果判断当前设备是否支持这些功能,从而避免在低端设备上开启进阶功能导致性能下降或功能不可用的问题。你可以根据该方法的返回值,决定是否显示或启用相应的功能按钮,或者在设备能力不足时,为用户提示相应信息。

    +

    此外,自该版本起,启用进阶功能时(例如调用 启用虚拟背景时)将自动调用 方法,如果当前设备能力不满足进阶功能的使用要求将返回 -4: ,表示设备不支持该功能。

    +
  • @@ -65,7 +70,7 @@
    • 在屏幕共享场景下偶现崩溃、掉帧。
    • 在采用 H.265 编码模式时,如果 Web 端加入互动,会导致 Native 端出现冗余的 回调:当主播调用 (true)时,接收端在收到 (enabledtrue) 回调之前,会先收到一个 (enabledfalse) 回调。
    • -
    • 加入频道偶现的崩溃。(macOS)

    • +
    • 加入频道偶现的崩溃。(macOS)

    • 本地系统时间不正确时,偶现加入频道失败。
    • 调用 使用相同的 soundId 播放两个不同的音效文件,偶现第一个音效文件播放完毕后会重复播放。
    • 主播调用 播放音乐文件时,偶现主播本地无法听见音乐,远端用户可以正常听见。(Android)

    • From d2ca57e4c28e3955084be52a695bad4b94a92156 Mon Sep 17 00:00:00 2001 From: Nero-Hu Date: Tue, 26 Sep 2023 16:53:10 +0800 Subject: [PATCH 6/6] add -4 for advance features --- dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita | 2 ++ .../API/api_irtcengine_isfeatureavailableondevice.dita | 1 + dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita | 6 ++++-- dita/RTC-NG/release/release_notes.dita | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 2711db61540..93542899215 100644 --- a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -74,6 +74,7 @@
    • 摄像画面中,物件较少,用户的人像为半身人像且基本无遮挡,背景色较单一且与用户着装颜色不同。
  • 该方法依赖于虚拟背景动态库 ,如果删除该动态库会导致无法正常开启该功能。
  • +
  • 调用该方法时 SDK 会自动对当前设备能力进行检查,并在设备能力不足时,通过返回错误码 -4: 表示该设备不支持开启该功能。
  • 参数 @@ -125,6 +126,7 @@
  • -1:自定义的背景图不存在。请检查 source 的值。
  • -2:自定义的背景图颜色格式出错。请检查 color 的值。
  • -3:设备不支持使用虚拟背景。
  • +
  • -4:设备能力不满足虚拟背景的使用要求。
  • diff --git a/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita b/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita index 1326b7c43e8..01079b5bebe 100644 --- a/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita +++ b/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita @@ -29,6 +29,7 @@

    查询当前设备能力是否满足虚拟背景、美颜等进阶功能的要求。

    + 启用进阶功能时(例如调用 启用虚拟背景时)SDK 会自动对当前设备能力进行检查,并在设备能力不足时,通过返回错误码 -4:,表示设备不支持该功能。
    适用场景 diff --git a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita index 5a732f90247..e2462fb70a6 100644 --- a/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita +++ b/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita @@ -41,6 +41,7 @@
  • 请在 之后调用该方法。
  • 该方法仅适用于 Android 5.0 及以上版本。
  • 该方法依赖于视频增强动态库 ,如果删除该动态库会导致无法正常开启该功能。
  • +
  • 调用该方法时 SDK 会自动对当前设备能力进行检查,并在设备能力不足时,通过返回错误码 -4: 表示该设备不支持开启该功能。
  • @@ -71,8 +72,9 @@
    • 0: 方法调用成功。
    • < 0: 方法调用失败。 -
        -
      • (4):当前设备版本低于 Android 5.0,不支持该操作。
      • +
          +
        • (4):当前设备能力不满足美颜的使用要求。 + (4):当前设备能力不满足美颜的使用要求,或当前设备版本低于 Android 5.0,不支持该操作。
    diff --git a/dita/RTC-NG/release/release_notes.dita b/dita/RTC-NG/release/release_notes.dita index bd7e01c186f..e512c6679a7 100644 --- a/dita/RTC-NG/release/release_notes.dita +++ b/dita/RTC-NG/release/release_notes.dita @@ -37,7 +37,7 @@
  • 进阶功能查询

    该版本新增了 方法,用于查询设备能力是否满足虚拟背景、美颜等进阶功能的使用要求。

    在使用进阶功能前,你可以根据查询结果判断当前设备是否支持这些功能,从而避免在低端设备上开启进阶功能导致性能下降或功能不可用的问题。你可以根据该方法的返回值,决定是否显示或启用相应的功能按钮,或者在设备能力不足时,为用户提示相应信息。

    -

    此外,自该版本起,启用进阶功能时(例如调用 启用虚拟背景时)将自动调用 方法,如果当前设备能力不满足进阶功能的使用要求将返回 -4: ,表示设备不支持该功能。

    +

    此外,自该版本起,启用进阶功能时(例如调用 启用虚拟背景时)SDK 会自动对当前设备能力进行检查,并在设备能力不足时,通过返回错误码 -4: 表示该设备不支持开启该功能。