From 2e9956069c07b9caf4a3fae1be25de36c1116afd Mon Sep 17 00:00:00 2001 From: Cilla-luodan Date: Mon, 25 Sep 2023 04:11:01 +0000 Subject: [PATCH] Sync cn prototype to en prototype --- ...onfiguration_getdestchannelmediainfos.dita | 24 +- ...ayconfiguration_removedestchannelinfo.dita | 22 +- ...relayconfiguration_setdestchannelinfo.dita | 24 +- .../api_iaudiodevicecollection_getdevice.dita | 4 +- .../api_iaudiodevicecollection_setdevice.dita | 10 +- ...evicemanager_enumerateplaybackdevices.dita | 2 +- ...icemanager_followsystemloopbackdevice.dita | 26 +-- ...icemanager_followsystemplaybackdevice.dita | 20 +- ...cemanager_followsystemrecordingdevice.dita | 8 +- ...iaudiodevicemanager_getloopbackdevice.dita | 20 +- ...evicemanager_getplaybackdefaultdevice.dita | 22 +- ...iaudiodevicemanager_getplaybackdevice.dita | 6 +- ...iodevicemanager_getplaybackdeviceinfo.dita | 6 +- ...iodevicemanager_getplaybackdevicemute.dita | 4 +- ...devicemanager_getplaybackdevicevolume.dita | 4 +- ...vicemanager_getrecordingdefaultdevice.dita | 22 +- ...audiodevicemanager_getrecordingdevice.dita | 14 +- ...odevicemanager_getrecordingdeviceinfo.dita | 6 +- ...odevicemanager_getrecordingdevicemute.dita | 4 +- ...evicemanager_getrecordingdevicevolume.dita | 4 +- ...iaudiodevicemanager_setloopbackdevice.dita | 26 +-- ...iaudiodevicemanager_setplaybackdevice.dita | 10 +- ...iodevicemanager_setplaybackdevicemute.dita | 8 +- ...devicemanager_setplaybackdevicevolume.dita | 8 +- ...audiodevicemanager_setrecordingdevice.dita | 10 +- ...odevicemanager_setrecordingdevicemute.dita | 8 +- ...evicemanager_setrecordingdevicevolume.dita | 20 +- ...emanager_startaudiodeviceloopbacktest.dita | 10 +- ...devicemanager_startplaybackdevicetest.dita | 8 +- ...evicemanager_startrecordingdevicetest.dita | 20 +- ...cemanager_stopaudiodeviceloopbacktest.dita | 8 +- ...odevicemanager_stopplaybackdevicetest.dita | 10 +- ...devicemanager_stoprecordingdevicetest.dita | 20 +- ...audioengine_muteallremoteaudiostreams.dita | 24 +- ...atialaudioengine_mutelocalaudiostream.dita | 26 +-- ...tialaudioengine_muteremoteaudiostream.dita | 28 +-- ...espatialaudioengine_setaudiorecvrange.dita | 8 +- ...asespatialaudioengine_setdistanceunit.dita | 8 +- ...atialaudioengine_setmaxaudiorecvcount.dita | 8 +- ...atialaudioengine_setplayerattenuation.dita | 26 +-- .../api_ibasespatialaudioengine_setzones.dita | 24 +- ...laudioengine_updateplayerpositioninfo.dita | 14 +- ...spatialaudioengine_updateselfposition.dita | 18 +- ...atialaudioengine_clearremotepositions.dita | 8 +- ...i_ilocalspatialaudioengine_initialize.dita | 28 +-- ...atialaudioengine_removeremoteposition.dita | 8 +- ...audioengine_setremoteaudioattenuation.dita | 30 +-- ...atialaudioengine_updateremoteposition.dita | 12 +- .../API/api_imediaengine_addlistener.dita | 30 +-- ...i_imediaengine_createcustomaudiotrack.dita | 18 +- ..._imediaengine_destroycustomaudiotrack.dita | 18 +- .../API/api_imediaengine_pullaudioframe.dita | 30 +-- .../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 +-- ...api_imediaengine_setexternalaudiosink.dita | 10 +- ..._imediaengine_setexternalaudiosource2.dita | 28 +-- ...i_imediaengine_setexternalvideosource.dita | 10 +- ...iaengine_unregisteraudioframeobserver.dita | 22 +- ...e_unregistervideoencodedframeobserver.dita | 22 +- ...iaengine_unregistervideoframeobserver.dita | 24 +- .../API/api_imediaplayer_addlistener.dita | 28 +-- .../api_imediaplayer_adjustplayoutvolume.dita | 8 +- ...mediaplayer_adjustpublishsignalvolume.dita | 8 +- ...imediaplayer_enableautoswitchagoracdn.dita | 8 +- .../API/api_imediaplayer_getduration.dita | 6 +- .../RTC-NG/API/api_imediaplayer_getmute.dita | 6 +- .../api_imediaplayer_getplayoutvolume.dita | 6 +- ...i_imediaplayer_getpublishsignalvolume.dita | 6 +- .../API/api_imediaplayer_getstreamcount.dita | 6 +- .../API/api_imediaplayer_getstreaminfo.dita | 4 +- .../RTC-NG/API/api_imediaplayer_mute.dita | 10 +- .../RTC-NG/API/api_imediaplayer_open.dita | 10 +- .../api_imediaplayer_openwithagoracdnsrc.dita | 8 +- ...api_imediaplayer_openwithcustomsource.dita | 2 +- .../api_imediaplayer_openwithmediasource.dita | 12 +- .../RTC-NG/API/api_imediaplayer_pause.dita | 8 +- .../RTC-NG/API/api_imediaplayer_play.dita | 8 +- .../api_imediaplayer_playpreloadedsrc.dita | 8 +- .../API/api_imediaplayer_preloadsrc.dita | 8 +- ...ediaplayer_registeraudioframeobserver.dita | 26 +-- ...diaplayer_registeraudioframeobserver2.dita | 24 +- ...iaplayer_registerplayersourceobserver.dita | 8 +- ...ediaplayer_registervideoframeobserver.dita | 22 +- ...pi_imediaplayer_renewagoracdnsrctoken.dita | 8 +- .../RTC-NG/API/api_imediaplayer_resume.dita | 8 +- .../RTC-NG/API/api_imediaplayer_seek.dita | 8 +- .../api_imediaplayer_selectaudiotrack.dita | 10 +- ...i_imediaplayer_selectinternalsubtitle.dita | 16 +- ...api_imediaplayer_setaudiodualmonomode.dita | 8 +- .../API/api_imediaplayer_setaudiopitch.dita | 8 +- .../API/api_imediaplayer_setloopcount.dita | 8 +- .../api_imediaplayer_setplaybackspeed.dita | 8 +- .../API/api_imediaplayer_setplayeroption.dita | 20 +- .../API/api_imediaplayer_setrendermode.dita | 8 +- ...pi_imediaplayer_setspatialaudioparams.dita | 8 +- .../RTC-NG/API/api_imediaplayer_setview.dita | 8 +- .../RTC-NG/API/api_imediaplayer_stop.dita | 8 +- ...mediaplayer_switchagoracdnlinebyindex.dita | 8 +- .../api_imediaplayer_switchagoracdnsrc.dita | 8 +- .../API/api_imediaplayer_switchsrc.dita | 10 +- .../API/api_imediaplayer_unloadsrc.dita | 8 +- ...iaplayer_unregisteraudioframeobserver.dita | 12 +- ...player_unregisterplayersourceobserver.dita | 8 +- ...iaplayer_unregistervideoframeobserver.dita | 20 +- ...yercachemanager_enableautoremovecache.dita | 12 +- ..._imediaplayercachemanager_getcachedir.dita | 14 +- ...diaplayercachemanager_removeallcaches.dita | 16 +- .../API/api_imediarecorder_addlistener.dita | 28 +-- ...ediarecorder_setmediarecorderobserver.dita | 26 +-- .../api_imediarecorder_startrecording.dita | 28 +-- .../API/api_imediarecorder_stoprecording.dita | 16 +- .../RTC-NG/API/api_irtcengine_addhandler.dita | 26 +-- .../api_irtcengine_addinjectstreamurl.dita | 6 +- .../API/api_irtcengine_addlistener.dita | 28 +-- .../api_irtcengine_addpublishstreamurl.dita | 6 +- .../API/api_irtcengine_addvideowatermark.dita | 8 +- .../api_irtcengine_addvideowatermark2.dita | 30 +-- ...engine_adjustaudiomixingplayoutvolume.dita | 8 +- ...engine_adjustaudiomixingpublishvolume.dita | 8 +- ...pi_irtcengine_adjustaudiomixingvolume.dita | 18 +- ...engine_adjustcustomaudiopublishvolume.dita | 12 +- ...irtcengine_adjustloopbacksignalvolume.dita | 10 +- ...irtcengine_adjustplaybacksignalvolume.dita | 8 +- ...rtcengine_adjustrecordingsignalvolume.dita | 10 +- ...engine_adjustuserplaybacksignalvolume.dita | 10 +- .../api_irtcengine_clearvideowatermarks.dita | 8 +- .../RTC-NG/API/api_irtcengine_complain.dita | 16 +- .../api_irtcengine_configrhythmplayer.dita | 24 +- .../RTC-NG/API/api_irtcengine_create.dita | 36 +-- .../API/api_irtcengine_createdatastream2.dita | 6 +- ...pi_irtcengine_destroycustomvideotrack.dita | 16 +- .../api_irtcengine_destroymediaplayer.dita | 10 +- .../API/api_irtcengine_disableaudio.dita | 8 +- ...rtcengine_disableaudiospectrummonitor.dita | 8 +- .../api_irtcengine_disablelastmiletest.dita | 20 +- .../API/api_irtcengine_disablevideo.dita | 8 +- .../API/api_irtcengine_enableaudio.dita | 8 +- ...irtcengine_enableaudiospectrummonitor.dita | 14 +- ...rtcengine_enableaudiovolumeindication.dita | 12 +- .../api_irtcengine_enablecontentinspect.dita | 26 +-- .../api_irtcengine_enabledualstreammode.dita | 6 +- .../api_irtcengine_enabledualstreammode2.dita | 8 +- .../api_irtcengine_enabledualstreammode3.dita | 24 +- ...engine_enableechocancellationexternal.dita | 8 +- .../API/api_irtcengine_enableencryption.dita | 6 +- .../API/api_irtcengine_enableextension.dita | 6 +- .../api_irtcengine_enablefacedetection.dita | 8 +- .../api_irtcengine_enableinearmonitoring.dita | 24 +- ...api_irtcengine_enableinearmonitoring2.dita | 28 +-- ...rtcengine_enableinstantmediarendering.dita | 18 +- .../api_irtcengine_enablelastmiletest.dita | 28 +-- .../API/api_irtcengine_enablelocalaudio.dita | 8 +- .../API/api_irtcengine_enablelocalvideo.dita | 8 +- ...pi_irtcengine_enableloopbackrecording.dita | 20 +- .../API/api_irtcengine_enablemulticamera.dita | 40 ++-- ...rtcengine_enableremotesuperresolution.dita | 16 +- ...cengine_enablesoundpositionindication.dita | 8 +- .../api_irtcengine_enablespatialaudio.dita | 10 +- .../API/api_irtcengine_enablevideo.dita | 8 +- ...api_irtcengine_enablevideoimagesource.dita | 12 +- ...pi_irtcengine_enablevirtualbackground.dita | 36 +-- ...tcengine_enablewebsdkinteroperability.dita | 8 +- .../api_irtcengine_getaudiodeviceinfo.dita | 14 +- ...cengine_getaudiomixingcurrentposition.dita | 8 +- ...api_irtcengine_getaudiomixingduration.dita | 6 +- ...rtcengine_getaudiomixingplayoutvolume.dita | 4 +- ...rtcengine_getaudiomixingpublishvolume.dita | 4 +- .../RTC-NG/API/api_irtcengine_getcallid.dita | 6 +- .../api_irtcengine_getconnectionstate.dita | 2 +- ...rtcengine_getcurrentmonotonictimeinms.dita | 12 +- .../API/api_irtcengine_geteffectsvolume.dita | 4 +- .../api_irtcengine_getextensionproperty.dita | 2 +- .../api_irtcengine_getextensionproperty2.dita | 16 +- .../API/api_irtcengine_getnativehandle.dita | 14 +- ...pi_irtcengine_getscreencapturesources.dita | 4 +- .../API/api_irtcengine_getuserinfobyuid.dita | 4 +- ...i_irtcengine_getuserinfobyuseraccount.dita | 10 +- .../API/api_irtcengine_getvolumeofeffect.dita | 4 +- .../RTC-NG/API/api_irtcengine_initialize.dita | 34 +-- ..._irtcengine_iscameraexposuresupported.dita | 16 +- ...irtcengine_isfeatureavailableondevice.dita | 12 +- .../api_irtcengine_isspeakerphoneenabled.dita | 2 +- .../API/api_irtcengine_joinchannel2.dita | 14 +- ...irtcengine_joinchannelwithuseraccount.dita | 10 +- ...rtcengine_joinchannelwithuseraccount2.dita | 4 +- ...tcengine_joinchannelwithuseraccountex.dita | 8 +- .../API/api_irtcengine_leavechannel.dita | 30 +-- .../API/api_irtcengine_leavechannel2.dita | 24 +- .../api_irtcengine_loadextensionprovider.dita | 24 +- ..._irtcengine_muteallremoteaudiostreams.dita | 20 +- ..._irtcengine_muteallremotevideostreams.dita | 10 +- .../api_irtcengine_mutelocalaudiostream.dita | 20 +- .../api_irtcengine_mutelocalvideostream.dita | 22 +- .../api_irtcengine_muterecordingsignal.dita | 10 +- .../api_irtcengine_muteremoteaudiostream.dita | 20 +- .../api_irtcengine_muteremotevideostream.dita | 8 +- ..._irtcengine_pauseallchannelmediarelay.dita | 10 +- .../API/api_irtcengine_pausealleffects.dita | 8 +- .../API/api_irtcengine_pauseaudiomixing.dita | 8 +- .../API/api_irtcengine_pauseeffect.dita | 8 +- .../API/api_irtcengine_playalleffects.dita | 8 +- .../API/api_irtcengine_playeffect2.dita | 6 +- .../API/api_irtcengine_playeffect3.dita | 16 +- .../API/api_irtcengine_preloadchannel.dita | 26 +-- .../API/api_irtcengine_preloadchannel2.dita | 34 +-- .../API/api_irtcengine_preloadeffect.dita | 8 +- .../API/api_irtcengine_pushaudioframe2.dita | 24 +- .../api_irtcengine_pushcaptureaudioframe.dita | 8 +- .../api_irtcengine_pushreverseaudioframe.dita | 8 +- .../API/api_irtcengine_pushvideoframe2.dita | 30 +-- .../api_irtcengine_querycodeccapability.dita | 34 +-- ...tcengine_queryscreencapturecapability.dita | 22 +- .../dita/RTC-NG/API/api_irtcengine_rate.dita | 8 +- ...ine_registeraudioencodedframeobserver.dita | 12 +- ...cengine_registeraudiospectrumobserver.dita | 12 +- .../API/api_irtcengine_registerextension.dita | 32 +-- ...i_irtcengine_registerlocaluseraccount.dita | 10 +- ...cengine_registermediametadataobserver.dita | 10 +- .../API/api_irtcengine_removehandler.dita | 8 +- .../api_irtcengine_removeinjectstreamurl.dita | 8 +- ...api_irtcengine_removepublishstreamurl.dita | 8 +- .../RTC-NG/API/api_irtcengine_renewtoken.dita | 6 +- ...irtcengine_resumeallchannelmediarelay.dita | 8 +- .../API/api_irtcengine_resumealleffects.dita | 8 +- .../API/api_irtcengine_resumeaudiomixing.dita | 8 +- .../API/api_irtcengine_resumeeffect.dita | 8 +- .../API/api_irtcengine_selectaudiotrack.dita | 22 +- .../API/api_irtcengine_sendmetadata.dita | 14 +- .../API/api_irtcengine_sendstreammessage.dita | 8 +- ...pi_irtcengine_setadvancedaudiooptions.dita | 10 +- .../API/api_irtcengine_setainsmode.dita | 20 +- ...i_irtcengine_setaudioeffectparameters.dita | 8 +- .../api_irtcengine_setaudioeffectpreset.dita | 10 +- ...irtcengine_setaudiomixingdualmonomode.dita | 10 +- .../api_irtcengine_setaudiomixingpitch.dita | 8 +- ...api_irtcengine_setaudiomixingposition.dita | 8 +- .../API/api_irtcengine_setaudioprofile.dita | 10 +- .../API/api_irtcengine_setaudioprofile2.dita | 6 +- .../API/api_irtcengine_setaudioscenario.dita | 22 +- ...e_setaudiosessionoperationrestriction.dita | 8 +- .../API/api_irtcengine_setavsyncsource.dita | 8 +- ...api_irtcengine_setbeautyeffectoptions.dita | 16 +- ..._setcameraautoexposurefacemodeenabled.dita | 8 +- ...ine_setcameraautofocusfacemodeenabled.dita | 10 +- ...engine_setcameracapturerconfiguration.dita | 10 +- ...irtcengine_setcameradeviceorientation.dita | 10 +- ...pi_irtcengine_setcameraexposurefactor.dita | 18 +- ..._irtcengine_setcameraexposureposition.dita | 8 +- ...ngine_setcamerafocuspositioninpreview.dita | 8 +- .../API/api_irtcengine_setcameratorchon.dita | 8 +- .../api_irtcengine_setcamerazoomfactor.dita | 6 +- .../API/api_irtcengine_setchannelprofile.dita | 10 +- .../API/api_irtcengine_setclientrole.dita | 4 +- .../API/api_irtcengine_setclientrole2.dita | 12 +- .../API/api_irtcengine_setcloudproxy.dita | 6 +- ...api_irtcengine_setcolorenhanceoptions.dita | 18 +- ...ne_setdefaultaudioroutetospeakerphone.dita | 14 +- ...e_setdefaultmuteallremoteaudiostreams.dita | 8 +- ...e_setdefaultmuteallremotevideostreams.dita | 8 +- ...tdirectcdnstreamingaudioconfiguration.dita | 8 +- ...tdirectcdnstreamingvideoconfiguration.dita | 22 +- .../API/api_irtcengine_setdualstreammode.dita | 30 +-- .../api_irtcengine_setdualstreammode2.dita | 32 +-- ..._setearmonitoringaudioframeparameters.dita | 32 +-- .../API/api_irtcengine_seteffectposition.dita | 12 +- .../API/api_irtcengine_seteffectsvolume.dita | 8 +- .../api_irtcengine_setenablespeakerphone.dita | 8 +- .../API/api_irtcengine_setencryptionmode.dita | 8 +- .../api_irtcengine_setencryptionsecret.dita | 8 +- .../api_irtcengine_setextensionproperty.dita | 8 +- ...tcengine_setextensionproviderproperty.dita | 8 +- ...tcengine_setexternalaudiosourcevolume.dita | 24 +- ...i_irtcengine_setheadphoneeqparameters.dita | 16 +- .../api_irtcengine_setheadphoneeqpreset.dita | 16 +- ...i_irtcengine_setinearmonitoringvolume.dita | 8 +- .../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 +- .../api_irtcengine_setlocalvoicechanger.dita | 64 +++--- ..._irtcengine_setlocalvoiceequalization.dita | 8 +- .../api_irtcengine_setlocalvoiceformant.dita | 16 +- .../api_irtcengine_setlocalvoicepitch.dita | 8 +- .../api_irtcengine_setlocalvoicereverb.dita | 8 +- ..._irtcengine_setlocalvoicereverbpreset.dita | 42 ++-- .../RTC-NG/API/api_irtcengine_setlogfile.dita | 8 +- .../API/api_irtcengine_setlogfilesize.dita | 8 +- .../API/api_irtcengine_setlogfilter.dita | 8 +- .../API/api_irtcengine_setloglevel.dita | 8 +- ..._irtcengine_setlowlightenhanceoptions.dita | 16 +- .../api_irtcengine_setmaxmetadatasize.dita | 8 +- ...tcengine_setmixedaudioframeparameters.dita | 10 +- .../API/api_irtcengine_setparameters.dita | 14 +- ...ybackaudioframebeforemixingparameters.dita | 10 +- ...ngine_setplaybackaudioframeparameters.dita | 10 +- ...gine_setrecordingaudioframeparameters.dita | 10 +- ...ngine_setremotedefaultvideostreamtype.dita | 16 +- .../api_irtcengine_setremoterendermode.dita | 24 +- .../api_irtcengine_setremoterendermode2.dita | 10 +- ...gine_setremotesubscribefallbackoption.dita | 12 +- .../api_irtcengine_setremoteuserpriority.dita | 22 +- ...ngine_setremoteuserspatialaudioparams.dita | 8 +- ...i_irtcengine_setremotevideostreamtype.dita | 12 +- ...ine_setremotevideosubscriptionoptions.dita | 32 +-- ...api_irtcengine_setremotevoiceposition.dita | 8 +- ...rtcengine_setrouteincommunicationmode.dita | 20 +- ...rtcengine_setscreencapturecontenthint.dita | 6 +- ...i_irtcengine_setscreencapturescenario.dita | 10 +- ...irtcengine_setsubscribeaudioallowlist.dita | 26 +-- ...irtcengine_setsubscribeaudioblocklist.dita | 14 +- ...irtcengine_setsubscribevideoallowlist.dita | 32 +-- ...irtcengine_setsubscribevideoblocklist.dita | 32 +-- .../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/api_irtcengine_setvideoscenario.dita | 22 +- ...tcengine_setvoicebeautifierparameters.dita | 8 +- ...i_irtcengine_setvoicebeautifierpreset.dita | 10 +- ...i_irtcengine_setvoiceconversionpreset.dita | 50 ++-- .../API/api_irtcengine_setvolumeofeffect.dita | 8 +- .../API/api_irtcengine_startaudiomixing.dita | 12 +- .../API/api_irtcengine_startaudiomixing2.dita | 14 +- .../api_irtcengine_startaudiorecording.dita | 24 +- .../api_irtcengine_startaudiorecording2.dita | 30 +-- .../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 | 12 +- .../API/api_irtcengine_startechotest3.dita | 16 +- ...api_irtcengine_startlastmileprobetest.dita | 8 +- ..._irtcengine_startlocalvideotranscoder.dita | 18 +- ...irtcengine_startmediarenderingtracing.dita | 20 +- ...engine_startorupdatechannelmediarelay.dita | 24 +- .../API/api_irtcengine_startpreview.dita | 2 +- .../API/api_irtcengine_startpreview2.dita | 10 +- .../API/api_irtcengine_startrhythmplayer.dita | 26 +-- ...engine_startrtmpstreamwithtranscoding.dita | 20 +- .../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 | 8 +- .../API/api_irtcengine_stopaudiomixing.dita | 8 +- .../api_irtcengine_stopaudiorecording.dita | 8 +- .../API/api_irtcengine_stopcameracapture.dita | 14 +- .../api_irtcengine_stopchannelmediarelay.dita | 8 +- ...api_irtcengine_stopdirectcdnstreaming.dita | 6 +- .../API/api_irtcengine_stopechotest.dita | 6 +- .../RTC-NG/API/api_irtcengine_stopeffect.dita | 8 +- .../api_irtcengine_stoplastmileprobetest.dita | 8 +- ...i_irtcengine_stoplocalvideotranscoder.dita | 8 +- .../API/api_irtcengine_stoppreview.dita | 2 +- .../API/api_irtcengine_stoppreview2.dita | 10 +- .../API/api_irtcengine_stoprhythmplayer.dita | 8 +- .../API/api_irtcengine_stoprtmpstream.dita | 18 +- .../API/api_irtcengine_stopscreencapture.dita | 8 +- .../api_irtcengine_stopscreencapture2.dita | 20 +- .../API/api_irtcengine_switchcamera.dita | 10 +- .../API/api_irtcengine_switchchannel.dita | 26 +-- .../API/api_irtcengine_switchchannel2.dita | 30 +-- .../API/api_irtcengine_takesnapshot.dita | 18 +- .../API/api_irtcengine_unloadalleffects.dita | 8 +- .../API/api_irtcengine_unloadeffect.dita | 8 +- ...e_unregisteraudioencodedframeobserver.dita | 20 +- ...tcengine_unregisteraudioframeobserver.dita | 26 +-- ...ngine_unregisteraudiospectrumobserver.dita | 10 +- ...ngine_unregistermediametadataobserver.dita | 8 +- ..._irtcengine_updatechannelmediaoptions.dita | 6 +- ...pi_irtcengine_updatechannelmediarelay.dita | 8 +- ...ne_updatelocaltranscoderconfiguration.dita | 10 +- ..._irtcengine_updatepreloadchanneltoken.dita | 14 +- .../api_irtcengine_updatertmptranscoding.dita | 22 +- .../api_irtcengine_updatescreencapture.dita | 14 +- ...cengine_updatescreencaptureparameters.dita | 6 +- ..._irtcengine_updatescreencaptureregion.dita | 6 +- ...irtcengine_updatescreencaptureregion2.dita | 20 +- .../API/api_irtcengine_uploadlogfile.dita | 6 +- ...pi_irtcengineex_addpublishstreamurlex.dita | 8 +- .../api_irtcengineex_addvideowatermarkex.dita | 8 +- ...neex_adjustuserplaybacksignalvolumeex.dita | 28 +-- ...pi_irtcengineex_clearvideowatermarkex.dita | 8 +- .../api_irtcengineex_createdatastreamex2.dita | 4 +- ...ngineex_enableaudiovolumeindicationex.dita | 36 +-- ...i_irtcengineex_enablecontentinspectex.dita | 32 +-- ...i_irtcengineex_enabledualstreammodeex.dita | 32 +-- ...rtcengineex_enableloopbackrecordingex.dita | 28 +-- .../API/api_irtcengineex_joinchannelex.dita | 30 +-- .../API/api_irtcengineex_leavechannelex.dita | 34 +-- .../API/api_irtcengineex_leavechannelex2.dita | 40 ++-- ...cengineex_muteallremoteaudiostreamsex.dita | 26 +-- ...cengineex_muteallremotevideostreamsex.dita | 24 +- ...i_irtcengineex_mutelocalaudiostreamex.dita | 26 +-- ...i_irtcengineex_mutelocalvideostreamex.dita | 22 +- ..._irtcengineex_muteremoteaudiostreamex.dita | 8 +- ..._irtcengineex_muteremotevideostreamex.dita | 8 +- ...cengineex_pauseallchannelmediarelayex.dita | 24 +- ...engineex_resumeallchannelmediarelayex.dita | 20 +- .../api_irtcengineex_sendstreammessageex.dita | 8 +- .../api_irtcengineex_setdualstreammodeex.dita | 34 +-- ...pi_irtcengineex_setremoterendermodeex.dita | 10 +- ...tcengineex_setremotevideostreamtypeex.dita | 24 +- ...irtcengineex_setremotevoicepositionex.dita | 8 +- ...engineex_setsubscribeaudioallowlistex.dita | 32 +-- ...engineex_setsubscribeaudioblocklistex.dita | 34 +-- ...engineex_setsubscribevideoallowlistex.dita | 32 +-- ...engineex_setsubscribevideoblocklistex.dita | 32 +-- .../api_irtcengineex_setupremotevideoex.dita | 8 +- ...gineex_setvideoencoderconfigurationex.dita | 8 +- ...irtcengineex_startchannelmediarelayex.dita | 30 +-- ...engineex_startmediarenderingtracingex.dita | 22 +- ...neex_startorupdatechannelmediarelayex.dita | 28 +-- ...neex_startrtmpstreamwithtranscodingex.dita | 28 +-- ..._irtcengineex_stopchannelmediarelayex.dita | 20 +- .../api_irtcengineex_stoprtmpstreamex.dita | 22 +- .../API/api_irtcengineex_takesnapshotex.dita | 36 +-- ...rtcengineex_updatechannelmediarelayex.dita | 26 +-- ..._irtcengineex_updatertmptranscodingex.dita | 26 +-- .../api_ivideodevicecollection_getdevice.dita | 4 +- .../api_ivideodevicecollection_setdevice.dita | 10 +- ...api_ivideodevicemanager_getcapability.dita | 6 +- .../api_ivideodevicemanager_getdevice.dita | 6 +- ...deodevicemanager_numberofcapabilities.dita | 10 +- .../api_ivideodevicemanager_setdevice.dita | 22 +- ...i_ivideodevicemanager_startdevicetest.dita | 8 +- ...pi_ivideodevicemanager_stopdevicetest.dita | 8 +- .../RTC-NG/API/api_monitordevicechange.dita | 22 +- .../class_Localaccesspointconfiguration.dita | 31 ++- .../dita/RTC-NG/API/class_advanceoptions.dita | 18 +- en-US/dita/RTC-NG/API/class_audioframe.dita | 2 +- en-US/dita/RTC-NG/API/class_audioparams.dita | 38 +-- .../class_audiorecordingconfiguration.dita | 6 +- .../class_cameracapturerconfiguration.dita | 24 +- .../RTC-NG/API/class_channelmediainfo.dita | 8 +- .../RTC-NG/API/class_channelmediaoptions.dita | 216 +++++++++--------- .../class_channelmediarelayconfiguration.dita | 40 ++-- .../RTC-NG/API/class_clientroleoptions.dita | 14 +- .../API/class_cloudspatialaudioconfig.dita | 2 +- 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 | 24 +- .../class_directcdnstreamingmediaoptions.dita | 34 +-- .../API/class_encodedaudioframeinfo.dita | 4 +- .../API/class_encodedvideoframeinfo.dita | 14 +- .../RTC-NG/API/class_externalvideoframe.dita | 41 ++-- .../RTC-NG/API/class_iaudiodevicemanager.dita | 2 +- .../RTC-NG/API/class_injectstreamconfig.dita | 2 +- .../RTC-NG/API/class_livetranscoding.dita | 96 ++++---- .../API/class_localspatialaudioconfig.dita | 4 +- .../class_localtranscoderconfiguration.dita | 22 +- .../RTC-NG/API/class_localvideostats.dita | 40 ++-- en-US/dita/RTC-NG/API/class_logconfig.dita | 10 +- .../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_remotevideostats.dita | 20 +- .../RTC-NG/API/class_rtcengineconfig.dita | 46 ++-- .../API/class_screenaudioparameters.dita | 6 +- .../API/class_screencaptureconfiguration.dita | 2 +- .../API/class_screencaptureparameters2.dita | 36 +-- .../API/class_screencapturesourceinfo.dita | 34 +-- .../API/class_screenvideoparameters.dita | 34 +-- .../API/class_segmentationproperty.dita | 10 +- .../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 +-- .../API/class_virtualbackgroundsource.dita | 4 +- .../RTC-NG/API/class_watermarkoptions.dita | 22 +- 482 files changed, 3823 insertions(+), 3827 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 0312f73bdec..8326dd9f6f0 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_channelmediarelayconfiguration_removedestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita index 2c2c4720fe2..c1c6fc1ea2f 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="removeDestChannelInfo"/> + <ph keyref="removeDestChannelInfo" /> Deletes the information of target channel. - + @@ -17,12 +17,12 @@ destInfos.remove(channelName); } - (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName; - - - - - -

+ + + + + +

Parameters @@ -34,9 +34,9 @@
    -
  • : Success.
    • -
  • : Failure. See for details and resolution suggestions.
    • +
  • : Success.
    • +
  • : Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita index 9630d265251..d535456ec2a 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="setDestChannelInfo"/> + <ph keyref="setDestChannelInfo" /> Sets the information of the target channel. - + @@ -18,12 +18,12 @@ } - (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName; - - - - - -

+ + + + + +

Parameters @@ -36,10 +36,10 @@ destInfo destinationInfo -

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

    +

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

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

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

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

+

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

Retrieves the volume of the audio recording device.

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

+

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

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

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

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

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
- + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumerateplaybackdevices.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumerateplaybackdevices.dita index 5c2794ebf4d..f4924ae6ea4 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumerateplaybackdevices.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumerateplaybackdevices.dita @@ -20,7 +20,7 @@ public abstract DeviceInfo[] EnumeratePlaybackDevices(); abstract enumeratePlaybackDevices(): AudioDeviceInfo[]; List<AudioDeviceInfo> enumeratePlaybackDevices(); -

+

Details 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 d07a51fd115..0f9020c2dd8 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="followSystemLoopbackDevice"/> + <ph keyref="followSystemLoopbackDevice" /> Sets whether the loopback device follows the system default playback device. - +

- - + + virtual int followSystemLoopbackDevice(bool enable) = 0; abstract followSystemLoopbackDevice(enable: boolean): number; public abstract int FollowSystemLoopbackDevice(bool enable); - - Future<void> followSystemLoopbackDevice(bool enable); -

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

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

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

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita index 1768ede9202..1c6b669f853 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getLoopbackDevice"/> + <ph keyref="getLoopbackDevice" /> Gets the current loopback device. - +

- - + + virtual int getLoopbackDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract getLoopbackDevice(): string; public abstract int GetLoopbackDevice(ref string deviceId); - - Future<String> getLoopbackDevice(); -

+ + Future<String> getLoopbackDevice(); +

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

The ID of the current loopback device.

 - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita index 33d6a2e8fcf..9e370e27c16 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_getplaybackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevice.dita index 1d079dff79a..264e94f8bdb 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdevice.dita @@ -20,7 +20,7 @@ public abstract int GetPlaybackDevice(ref string deviceId); abstract getPlaybackDevice(): string; Future<String> getPlaybackDevice(); -

+

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

The current audio playback device.

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

+

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

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

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

+

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

    +

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

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

diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita index bd0717f6c43..c32446ef152 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_getrecordingdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita index 8587c12c37e..0a7f2ca3d04 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getRecordingDevice"/> + <ph keyref="getRecordingDevice" /> Gets the current audio recording device. - +

- - + + virtual int getRecordingDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract getRecordingDevice(): string; public abstract int GetRecordingDevice(ref string deviceId); abstract getRecordingDevice(): string; Future<String> getRecordingDevice(); -

+

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

The current audio recording device.

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

+

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

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

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

+

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

    +

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

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

diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita index 5d851892764..3a412e7b6a6 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="setLoopbackDevice"/> + <ph keyref="setLoopbackDevice" /> Sets the loopback device. - +

- - + + virtual int setLoopbackDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract setLoopbackDevice(deviceId: string): number; public abstract int SetLoopbackDevice(string deviceId); - - Future<void> setLoopbackDevice(String deviceId); -

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

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

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

-

The maximum length is .

+

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

+

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

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

  • 0: Success.
    • -
  • < 0: Failure. See for details and resolution suggestions.
    • +
  • < 0: Failure. See for details and resolution suggestions.
\ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita index 5ad3581f64e..e56d544b398 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita @@ -1,26 +1,26 @@ - <ph keyref="setRecordingDeviceVolume"/> + <ph keyref="setRecordingDeviceVolume" /> Sets the volume of the audio capture device. - +

- - + + virtual int setRecordingDeviceVolume(int volume) = 0; abstract setRecordingDeviceVolume(volume: number): number; public abstract int SetRecordingDeviceVolume(int volume); abstract setRecordingDeviceVolume(volume: number): number; - Future<void> setRecordingDeviceVolume(int volume); -

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

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

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

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

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

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

+

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

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

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

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

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

    +

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

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

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

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

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

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

    Details -

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

    +

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

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

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

    + Future<void> stopRecordingDeviceTest(); +

    Details -

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

    +

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

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

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

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

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

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

    +

    Details

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

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

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

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

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

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

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

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

    +

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

    Whether to stop publishing the local audio stream:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita index dc83981a85c..8b65a70c29c 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita @@ -1,12 +1,12 @@ - <ph keyref="setZones"/> + <ph keyref="setZones" /> Sets the sound insulation area. - + @@ -14,14 +14,14 @@

    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); abstract setZones(zones: SpatialAudioZone, zoneCount: number): number; - Future<void> setZones( + Future<void> setZones( {required SpatialAudioZone zones, required int zoneCount}); -

    +

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

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

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita index 9dbf8b59733..300692762de 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_ibasespatialaudioengine_updateselfposition.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita index 886afee5cc7..2caa19b9d97 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateselfposition.dita @@ -30,12 +30,12 @@ axisRight: number[], axisUp: number[] ): number;     - Future<void> updateSelfPosition( - {required List<double> position, - required List<double> axisForward, - required List<double> axisRight, - required List<double> axisUp}); -

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

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

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

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

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

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

    +

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

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

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita index 06db6bec41f..bb83a2b74ef 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_removeremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita index 0b8bad8d6eb..c20ffdbdd53 100644 --- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita +++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_removeremoteposition.dita @@ -20,7 +20,7 @@ public abstract int RemoveRemotePosition(uint uid); abstract removeRemotePosition(uid: number): number; Future<void> removeRemotePosition(int uid); -

    +

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

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

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

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

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

    +

    Details @@ -41,37 +41,37 @@ int SetRemoteAudioAttenuation(int64 uid, bool forceSet, FString attenuation = "0
    v4.0.1
    -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita index b2b6e903130..20f0f6e6edc 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 330082aef13..e59d5215833 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 b88531a5e03..3b13ff2d16b 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. -
    2. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
      3. -
    3. 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.
      4. +
    4. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
      5. +
    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.

    @@ -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_destroycustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita index fbe32b08b34..dce269c4d61 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_destroycustomaudiotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="destroyCustomAudioTrack"/> + <ph keyref="destroyCustomAudioTrack" /> Destroys the specified audio track. - + @@ -19,8 +19,8 @@ abstract destroyCustomAudioTrack(trackId: number): number; public abstract int DestroyCustomAudioTrack(uint trackId); abstract destroyCustomAudioTrack(trackId: number): number; - Future<void> destroyCustomAudioTrack(int trackId); -

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

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

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

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

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

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

    +

    Details -

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

    +

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

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

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
      -
    • : Success.
      • -
    • : Failure. See for details and resolution suggestions.
      • +
    • : Success.
      • +
    • : Failure. See for details and resolution suggestions.
    • The instance, if the method call succeeds.
    • An error code, if the call fails,.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita index e5117c78152..44abb4eef55 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 5f086267350..37d5f91436d 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 c58bd6ac335..9772c8db5ce 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 822dc2c1d66..6d1a4426af8 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 6fa96edd8f3..b5242a85065 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 61f70160415..df053ceb739 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. -
    2. Call to register the encoded video frame observer before joining the channel.
      3. -
    3. 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 .
      4. -
    4. 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 3f360d7dade..e6bfa5c5405 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 f2e6de53cbc..4b5f80032c2 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalaudiosink.dita @@ -29,9 +29,9 @@ sampleRate: number, channels: number ): number;     - Future<void> setExternalAudioSink( + Future<void> setExternalAudioSink( {required bool enabled, required int sampleRate, required int channels}); -

    +

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

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

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

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

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

    +

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

    Whether to enable the external audio source:

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

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

    Whether to play the external audio source:

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

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

    Whether to publish audio to the remote users:

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

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

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

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

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

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita index 82d219fde61..dac093a8eb1 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita @@ -1,26 +1,26 @@ - <ph keyref="unregisterAudioFrameObserver_IMediaEngine"/> + <ph keyref="unregisterAudioFrameObserver_IMediaEngine" /> Unregisters an audio frame observer. - +

    - - - + + + abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; - + abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; void unregisterAudioFrameObserver(AudioFrameObserver observer); -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita index 5495e8053cf..45a4bf751c6 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita @@ -1,21 +1,21 @@ - <ph keyref="unregisterVideoEncodedFrameObserver"/> + <ph keyref="unregisterVideoEncodedFrameObserver" /> Unregisters a receiver object for the encoded video frame. - +

    - - - + + + abstract unregisterVideoEncodedFrameObserver( observer: IVideoEncodedFrameObserver ): number; @@ -24,22 +24,22 @@ observer: IVideoEncodedFrameObserver ): number; void unregisterVideoEncodedFrameObserver(VideoEncodedFrameObserver observer); -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita index 9dfc201da51..72bc0db11a3 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita @@ -1,42 +1,42 @@ - <ph keyref="unregisterVideoFrameObserver_IMediaEngine"/> - Unregisters the video frame observer. + <ph keyref="unregisterVideoFrameObserver_IMediaEngine" /> + Unregisters the video frame observer. - +

    - - - + + + abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number; public abstract int UnRegisterVideoFrameObserver(); abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number; void unregisterVideoFrameObserver(VideoFrameObserver observer); -

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

    The total duration (ms) of the media file.

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

    +

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

    +

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

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

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

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

    +

    Parameters @@ -34,11 +34,11 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    • ≥ 0: The remote playback volume.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita index 2b3e4d3496d..161fd2edf4f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita @@ -20,11 +20,11 @@ public abstract int GetStreamCount(ref Int64 count); abstract getStreamCount(): number; Future<int> getStreamCount(); -

    +

    Details - Call this method after you call and receive the callback reporting the state .
    + Call this method after you call and receive the callback reporting the state .
    Parameters @@ -41,4 +41,4 @@
  • < 0: Failure. See .
    • - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita index 76bfc54b1c6..f4659aade1e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita @@ -20,7 +20,7 @@ public abstract int GetStreamInfo(Int64 index, ref PlayerStreamInfo info); abstract getStreamInfo(index: number): PlayerStreamInfo; Future<PlayerStreamInfo> getStreamInfo(int index); -

    +

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita index a5a35b3281f..270d30a798b 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_openwithmediasource.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita index 40346240046..2c539b8486e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita @@ -20,11 +20,11 @@ public abstract int OpenWithMediaSource(MediaSource source); abstract openWithMediaSource(source: MediaSource): number; Future<void> openWithMediaSource(MediaSource source); -

    +

    Details

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

    -

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

    Details

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

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita index 0c86d4ddb0f..e5e3c9d4e1f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita @@ -1,45 +1,45 @@ - <ph keyref="registerAudioFrameObserver1_IMediaPlayer"/> + <ph keyref="registerAudioFrameObserver1_IMediaPlayer" /> Registers a PCM audio frame observer object. - +

    - - + + virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink* observer) = 0; - + public abstract int RegisterAudioFrameObserver(IAudioPcmFrameSink observer); - - -

    + + +

    Details -

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

    +

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

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

    int registerAudioFrameObserver(IMediaPlayerAudioFrameObserver audioFrameObserver, int mode); - + virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink* observer, RAW_AUDIO_FRAME_OP_MODE_TYPE mode) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") @@ -33,7 +33,7 @@ int RegisterAudioFrameObserver(UIAudioPcmFrameSink* observer, ERAW_AUDIO_FRAME_O {required AudioPcmFrameSink observer, RawAudioFrameOpModeType mode = RawAudioFrameOpModeType.rawAudioFrameOpModeReadOnly}); -

    +

    Parameters @@ -42,28 +42,28 @@ int RegisterAudioFrameObserver(UIAudioPcmFrameSink* observer, ERAW_AUDIO_FRAME_O audioFrameObserver observer -

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

    -

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

    +

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

    +

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

     mode -

    The use mode of the audio frame. See .

    +

    The use mode of the audio frame. See .

    The use mode of the audio frame:

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

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

    +

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    + + +

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

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

    Details

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

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index 9ae36a6426f..6a8bff72497 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 eda894bfee0..d99e4528c33 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 ddfb28bca85..964ba2fcefc 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita @@ -22,7 +22,7 @@ public abstract int SetView(); abstract setView(view: any): number; Future<void> setView(int view); -

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita index c7ef4adbd4f..3f35de4def1 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita @@ -1,20 +1,20 @@ - <ph keyref="unregisterVideoFrameObserver_IMediaPlayer"/> + <ph keyref="unregisterVideoFrameObserver_IMediaPlayer" /> Unregisters the video frame observer. - +

    - - + + virtual int unregisterVideoFrameObserver(agora::media::base::IVideoFrameObserver* observer) = 0; abstract unregisterVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver @@ -24,22 +24,22 @@ observer: IMediaPlayerVideoFrameObserver ): number; void unregisterVideoFrameObserver(MediaPlayerVideoFrameObserver observer); -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_enableautoremovecache.dita b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_enableautoremovecache.dita index 49b6dc460e4..6255ba6c10a 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_enableautoremovecache.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_enableautoremovecache.dita @@ -1,12 +1,12 @@ - <ph keyref="enableAutoRemoveCache"/> + <ph keyref="enableAutoRemoveCache" /> Sets whether to delete cached media files automatically. - + @@ -19,8 +19,8 @@ abstract enableAutoRemoveCache(enable: boolean): number; public abstract int EnableAutoRemoveCache(bool enable); abstract enableAutoRemoveCache(enable: boolean): number; - Future<void> enableAutoRemoveCache(bool enable); -

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

    Details @@ -32,8 +32,8 @@ enable Whether to enable the SDK to delete cached media files automatically:
      -
    • : Delete cached media files automatically.
      • -
    • : (Default) Do not delete cached media files automatically.
      • +
    • : Delete cached media files automatically.
      • +
    • : (Default) Do not delete cached media files automatically.
    diff --git a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_getcachedir.dita b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_getcachedir.dita index e77e78d6169..7822b711f30 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_getcachedir.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_getcachedir.dita @@ -1,12 +1,12 @@ - <ph keyref="getCacheDir"/> + <ph keyref="getCacheDir" /> Gets the storage path of the cached media files. - + @@ -19,12 +19,12 @@ abstract getCacheDir(length: number): string; public abstract int GetCacheDir(out string path, int length); abstract getCacheDir(length: number): string; - Future<String> getCacheDir(int length); -

    + Future<String> getCacheDir(int length); +

    Details -

    If you have not called the method to set the storage path for the media files to be cached before calling this method, you get the default storage path used by the SDK.

    +

    If you have not called the method to set the storage path for the media files to be cached before calling this method, you get the default storage path used by the SDK.

    Parameters @@ -43,7 +43,7 @@
    • 0: Success.
    • The call succeeds, and the SDK returns the storage path of the cached media files.
      • -
    • < 0: Failure. See .
      • +
    • < 0: Failure. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita index 842bbc08143..ebc29f6d134 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeallcaches.dita @@ -1,12 +1,12 @@ - <ph keyref="removeAllCaches"/> + <ph keyref="removeAllCaches" /> Deletes all cached media files in the media player. - + @@ -19,8 +19,8 @@ abstract removeAllCaches(): number; public abstract int RemoveAllCaches(); abstract removeAllCaches(): number; - Future<void> removeAllCaches(); -

    + Future<void> removeAllCaches(); +

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

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

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See .
      • +
    • < 0: Failure. See .
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita index 384d63cf763..2b1ac3a1891 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 e14b3a13143..e02a471595e 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita @@ -1,12 +1,12 @@ - <ph keyref="setMediaRecorderObserver"/> - Registers one oberver. + <ph keyref="setMediaRecorderObserver" /> + Registers one oberver. - + @@ -14,22 +14,22 @@

    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); abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number; - Future<void> setMediaRecorderObserver( + Future<void> setMediaRecorderObserver( {required RtcConnection connection, required MediaRecorderObserver callback}); -

    +

    Details

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

    Before calling this method, ensure the following:

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

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

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

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

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

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

    +

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

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

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

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

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

    +

    Details -

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

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

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

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

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

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

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

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

    +

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

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

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

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

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita index 7dc0cf78c6c..814a1738ce8 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_addpublishstreamurl.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita index 6e039259d2f..6f73898ec4a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addpublishstreamurl.dita @@ -24,7 +24,7 @@ ): number; Future<void> addPublishStreamUrl( {required String url, required bool transcodingEnabled}); -

        +

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

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

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

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

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

      +

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

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

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

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

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

    +

    Details

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

    -

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

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

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

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

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

    Details

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

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita index 37239502de5..80db34bdd85 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustcustomaudiopublishvolume.dita @@ -27,9 +27,9 @@ trackId: number, volume: number ): number;     - Future<void> adjustCustomAudioPublishVolume( + Future<void> adjustCustomAudioPublishVolume( {required int trackId, required int volume}); -

    +

    Details @@ -41,7 +41,7 @@ trackId - The audio track ID. Set this parameter to the custom audio track ID returned in . + The audio track ID. Set this parameter to the custom audio track ID returned in . volume @@ -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.
    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 04fb8ecd8ac..5419459a0cc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustloopbacksignalvolume.dita @@ -21,7 +21,7 @@ public abstract int AdjustLoopbackSignalVolume(int volume); abstract adjustLoopbackSignalVolume(volume: number): number; Future<void> adjustLoopbackSignalVolume(int volume); -

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        +
      • < 0: Failure. See for details and resolution suggestions.
        • -2: The parameter is invalid.
        • - 3: The SDK is not ready. Possible reasons include the following:
          • The initialization of fails. Reinitialize the .
            • @@ -55,4 +55,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita index 8a61fbceaee..85a1c42d56d 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_create.dita b/en-US/dita/RTC-NG/API/api_irtcengine_create.dita index 859d66b60e6..253137e809a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_create.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_create.dita @@ -1,12 +1,12 @@ - <ph keyref="create"/> - Creates and initializes . + <ph keyref="create" /> + Creates and initializes . - + @@ -18,44 +18,44 @@     + (instancetype _Nonnull)sharedEngineWithAppId:(NSString * _Nonnull)appId delegate:(id<AgoraRtcEngineDelegate> _Nullable)delegate; - - - - - -

    + + + + + +

    Details -

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

    +

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

      -
    • Before calling other APIs, you must call this method to create the object.
      • -
    • You can create the instance either by calling this method or by calling . The difference between and this method is that supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
      • -
    • The SDK supports creating only one instance for an app.
      • +
    • Before calling other APIs, you must call this method to create the object.
      • +
    • You can create the instance either by calling this method or by calling . The difference between and this method is that supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
      • +
    • The SDK supports creating only one instance for an app.
    Parameters context - + appId - + handler delegate - The event handler for . See . + The event handler for . See .
    Returns
      -
    • The instance, if the method call succeeds.
      • -
    • The method call fails and an exception is thrown, you need to catch the exception and handle it. See for details and resolution suggestions.
      • +
    • The instance, if the method call succeeds.
      • +
    • The method call fails and an exception is thrown, you need to catch the exception and handle it. See for details and resolution suggestions.
    • An error code, if the method call fails.
      • -1: A general error occurs (no specified reason).
      • -2: The parameter is invalid.
        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index c9c17a0d1f1..d4e871ceb16 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -23,7 +23,7 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config);public abstract int CreateDataStream(ref int streamId, DataStreamConfig config); abstract createDataStream(config: DataStreamConfig): number; Future<int> createDataStream(DataStreamConfig config); -

        +

    Details @@ -47,7 +47,7 @@ int CreateDataStream(int& streamId, const FDataStreamConfig& config);
  • 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_destroycustomvideotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita index a3d0d4ca0ae..9615b155e81 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="destroyCustomVideoTrack"/> + <ph keyref="destroyCustomVideoTrack" /> Destroys the specified video track. - + @@ -20,7 +20,7 @@ public abstract int DestroyCustomVideoTrack(video_track_id_t video_track_id); abstract destroyCustomVideoTrack(videoTrackId: number): number; Future<void> destroyCustomVideoTrack(int videoTrackId); -

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita index 35e141fa04f..f42516c29a3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita @@ -1,32 +1,32 @@ - <ph keyref="disableLastmileTest"/> + <ph keyref="disableLastmileTest" /> Disables the network connection quality test. - +

    - - + + virtual int disableLastmileTest() = 0; - + public abstract int DisableLastmileTest(); - - -

    + + +

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

    Details -

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

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

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

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

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

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

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

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

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

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

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

    - +
    Parameters @@ -53,7 +53,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita index 99015102111..4caee8276e3 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 6c812e09ccc..d2460a93dbf 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. - + @@ -28,11 +28,11 @@ int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamC enabled: boolean, streamConfig?: SimulcastStreamConfig ): number;     - Future<void> enableDualStreamMode( + Future<void> enableDualStreamMode( {required bool enabled, SimulcastStreamConfig? streamConfig}); -

    +

    -
    +
    Parameters @@ -40,24 +40,24 @@ int EnableDualStreamMode(bool enabled, const FSimulcastStreamConfig& streamC 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 12499787a50..61aeba928ec 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableechocancellationexternal.dita @@ -28,7 +28,7 @@ ): number; Future<void> enableEchoCancellationExternal( {required bool enabled, required int audioSourceDelay}); -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita index 2c2954ca5b2..62f7fe6f324 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 ccfb6bbbb58..9b5f26f4ddf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita @@ -40,7 +40,7 @@ int EnableExtension(FString provider, FString extension, bool enable = true, EME required String extension, bool enable = true, MediaSourceType type = MediaSourceType.unknownMediaSource}); -

        +

    Details @@ -80,8 +80,8 @@ int EnableExtension(FString provider, FString extension, bool enable = true, EME
    - <ph keyref="return-section-title"/> -

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

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

    When the method call succeeds, there is no return value; when fails, the 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 a2c63d0a04b..f9419127c62 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita @@ -20,7 +20,7 @@ abstract enableFaceDetection(enabled: boolean): number; abstract enableFaceDetection(enabled: boolean): number; Future<void> enableFaceDetection(bool enabled); -

        +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita index ce3afea6da7..a01b66cc6a9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita @@ -1,12 +1,12 @@ - <ph keyref="enableInEarMonitoring"/> + <ph keyref="enableInEarMonitoring" /> Enables in-ear monitoring. - + @@ -15,16 +15,16 @@

    public abstract int enableInEarMonitoring(boolean enabled); - (int)enableInEarMonitoring:(BOOL)enabled; - - + + public abstract int EnableInEarMonitoring(bool enabled); - - -

    + + +

    Details -
    +
    Since
    v4.0.1
    @@ -43,8 +43,8 @@ enabled Enables in-ear monitoring.
      -
    • : Enables in-ear monitoring.
      • -
    • : (Default) Disables in-ear monitoring.
      • +
    • : Enables in-ear monitoring.
      • +
    • : (Default) Disables in-ear monitoring.
    @@ -52,8 +52,8 @@ Returns
    • 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_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 755286bf5bd..8e659237a7b 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 5b1dfef4b4b..3e3121634b6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita @@ -1,12 +1,12 @@ - <ph keyref="enableInstantMediaRendering"/> + <ph keyref="enableInstantMediaRendering" /> Enables audio and video frame instant rendering. - + @@ -19,7 +19,7 @@ abstract enableInstantMediaRendering(): number; public abstract int EnableInstantMediaRendering(); abstract enableInstantMediaRendering(): number; - Future<void> enableInstantMediaRendering();

    + Future<void> enableInstantMediaRendering();

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

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

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

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

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

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        -
      • -7: The method is called before is initialized.
        • +
      • < 0: Failure. See for details and resolution suggestions.
          +
        • -7: The method is called before is initialized.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita index d02f866203b..fc3af7cb494 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita @@ -1,26 +1,26 @@ - <ph keyref="enableLastmileTest"/> + <ph keyref="enableLastmileTest" /> Enables the network connection quality test. - +

    - - + + virtual int enableLastmileTest() = 0; - + public abstract int EnableLastmileTest(); - - -

    + + +

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

    • -

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

    +

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

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

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita index 0afac090ef6..fa4b37655b2 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. -
    2. Call to start the local video preview.
      3. -
    3. Call , and set sourceType to start video capture with the second camera.
      4. -
    4. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.
      5. +
    5. Call to start the local video preview.
      6. +
    6. Call , and set sourceType to start video capture with the second camera.
      7. +
    7. 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. -
    2. Call this method with enabled set to .
      3. +
    3. Call .
      4. +
    4. 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 7d6948bfb98..c13457b0cc6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableremotesuperresolution.dita @@ -21,13 +21,13 @@ abstract enableRemoteSuperResolution(userId: number, enable: boolean): number; Future<void> enableRemoteSuperResolution( {required int userId, required bool enable}); -

    +

    Details

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

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

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

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

    +

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

    The object that identifies the audio device information.

      +

      The object that identifies the audio device information.

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

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

    +

    Details

    Retrieves the playback position (ms) of the audio.

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

    +

    Details

    Retrieves the total duration (ms) of the audio.

    -

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

    +

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

    +

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

    +

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

    +

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

    The current call ID.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    • The current call ID, if the method succeeds.
    • An empty string, if the method call fails.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita index ab89c70308c..0e4d1925c9c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita @@ -20,7 +20,7 @@ public abstract CONNECTION_STATE_TYPE GetConnectionState(); abstract getConnectionState(): ConnectionStateType; Future<ConnectionStateType> getConnectionState(); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita index 19af4655fc5..4dbdc8280fc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita @@ -1,12 +1,12 @@ - <ph keyref="getCurrentMonotonicTimeInMs"/> + <ph keyref="getCurrentMonotonicTimeInMs" /> Gets the current Monotonic Time of the SDK. - + @@ -19,7 +19,7 @@ abstract getCurrentMonotonicTimeInMs(): number; public abstract long GetCurrentMonotonicTimeInMs(); abstract getCurrentMonotonicTimeInMs(): number; - Future<int> getCurrentMonotonicTimeInMs();

    + Future<int> getCurrentMonotonicTimeInMs();

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

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

    -

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

    +

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

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

    +

    Details @@ -30,7 +30,7 @@ Returns
    • Volume of the audio effects, if this method call succeeds.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty.dita index 3449c14eb88..fd28d3bf54c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty.dita @@ -49,7 +49,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    • The extension information, if the method call succeeds.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita index d5692a65180..54e8659c2d9 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. - + @@ -42,17 +42,17 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri 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 @@ -79,7 +79,7 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri sourceType type - Source type of the extension. See . + Source type of the extension. See . buf_len @@ -91,11 +91,11 @@ int GetExtensionProperty(FString provider, FString extension, FString key, FStri 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_getnativehandle.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita index 32431bfa8f9..15b747f7556 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita @@ -1,12 +1,12 @@ - <ph keyref="getNativeHandle"/> + <ph keyref="getNativeHandle" /> Gets the C++ handle of the Native SDK. - + @@ -15,12 +15,12 @@

      public abstract long getNativeHandle(); - (void* _Nullable)getNativeHandle; - + abstract getNativeHandle(): number; public abstract int GetNativeHandler(ref IntPtr nativeHandler); abstract getNativeHandle(): number; - Future<int> getNativeHandle(); -

      + Future<int> getNativeHandle(); +

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

      The native handle of the SDK.

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

      +

      Details @@ -62,7 +62,7 @@
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita index 5dc8f441a4c..535ccd87204 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getuserinfobyuseraccount.dita @@ -20,11 +20,11 @@ public abstract int GetUserInfoByUserAccount(string userAccount, ref UserInfo userInfo); abstract getUserInfoByUserAccount(userAccount: string): UserInfo; Future<UserInfo> getUserInfoByUserAccount(String userAccount); -

    +

    Details -

    +

    Parameters @@ -39,7 +39,7 @@ channelId -

    +

    localUserAccount @@ -51,7 +51,7 @@

    - + <title /> </section> </refbody> -</reference> +</reference> \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getvolumeofeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getvolumeofeffect.dita index 8683f428a2f..69e2da83fbc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getvolumeofeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getvolumeofeffect.dita @@ -20,7 +20,7 @@ <codeblock props="unity cs" outputclass="language-csharp">public abstract int GetVolumeOfEffect(int soundId);</codeblock> <codeblock props="rn" outputclass="language-typescript">abstract getVolumeOfEffect(soundId: number): number;</codeblock> <codeblock props="flutter" outputclass="language-dart">Future<int> getVolumeOfEffect(int soundId);</codeblock> - <codeblock props="reserve" outputclass="language-cpp"></codeblock></p> + <codeblock props="reserve" outputclass="language-cpp" /></p> </section> <section id="parameters"> <title>Parameters @@ -34,7 +34,7 @@ Returns
    • ≥ 0: Returns the volume of the specified audio effect, if the method call is successful. The value ranges between 0 and 100. 100 represents the original volume.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita index 7fc5cf926cc..00cfe357ae2 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 . - + @@ -24,17 +24,17 @@ int Initialize(const FRtcEngineContext& context);     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 @@ -43,21 +43,21 @@ int Initialize(const FRtcEngineContext& context); 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.
        • @@ -66,6 +66,6 @@ int Initialize(const FRtcEngineContext& context);
      • -101: The App ID is invalid.
    -
    +
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita index b55897ee1be..63f3202da5d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita @@ -16,11 +16,11 @@ public abstract boolean isCameraExposureSupported(); - (BOOL)isCameraExposureSupported NS_SWIFT_NAME(isCameraExposureSupported()); virtual bool isCameraExposureSupported() = 0; - + public abstract bool IsCameraExposureSupported(); abstract isCameraExposureSupported(): boolean; - Future<bool> isCameraExposureSupported(); -

    + Future<bool> isCameraExposureSupported(); +

    Details @@ -33,16 +33,16 @@
    • This method is for Android and iOS only.
      • -
    • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
      • -
    • Before calling , Agora recoomends that you call this method to query whether the current camera supports adjusting the exposure value.
      • -
    • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling .
      • +
    • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
      • +
    • Before calling , Agora recoomends that you call this method to query whether the current camera supports adjusting the exposure value.
      • +
    • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling .
    Returns
      -
    • : Success.
      • -
    • : Failure. See for details and resolution suggestions.
      • +
    • : Success.
      • +
    • : Failure. See for details and resolution suggestions.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita b/en-US/dita/RTC-NG/API/api_irtcengine_isfeatureavailableondevice.dita index 92d9adf4271..e31b678db9d 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. - + @@ -16,8 +16,8 @@ public abstract boolean isFeatureAvailableOnDevice(int type); - (BOOL)isFeatureAvailableOnDevice:(AgoraFeatureType)type; virtual bool isFeatureAvailableOnDevice(FeatureType type) = 0; - - + + abstract isFeatureAvailableOnDevice(type: FeatureType): boolean; Future<bool> isFeatureAvailableOnDevice(FeatureType type);

    @@ -40,7 +40,7 @@ type - The specific of the advanced feature, see . + The specific of the advanced feature, see .

    The specific the advanced feature.

    • (1): Virutual background.
      • @@ -56,4 +56,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_isspeakerphoneenabled.dita b/en-US/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita index a1ec0191384..3f0db6e11d4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_isspeakerphoneenabled.dita @@ -20,7 +20,7 @@ public abstract bool IsSpeakerphoneEnabled(); abstract isSpeakerphoneEnabled(): boolean; Future<bool> isSpeakerphoneEnabled(); -

    +

    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 8895b236d9e..d1b0984ed2e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -38,12 +38,12 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia uid: number, options: ChannelMediaOptions ): number; - Future<void> joinChannel( + Future<void> joinChannel( {required String token, required String channelId, required int uid, required ChannelMediaOptions options}); -

    +

    Details @@ -64,7 +64,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia 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 @@ -74,7 +74,7 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
    • -
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    • +
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    •  @@ -93,8 +93,8 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
    - <ph keyref="return-section-title"/> -

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

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

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

    • 0: Success.
    • < 0: Failure.
        @@ -108,4 +108,4 @@ int JoinChannel(FString token, FString channelId, int64 uid, const FChannelMedia
    - + \ 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 44279dcf194..397345e767f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita @@ -35,12 +35,12 @@ userAccount: string, options?: ChannelMediaOptions ): number;     - Future<void> joinChannelWithUserAccount( + Future<void> joinChannelWithUserAccount( {required String token, required String channelId, required String userAccount, ChannelMediaOptions? options}); -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        +
      • < 0: Failure. See for details and resolution suggestions.
        • -2: The parameter is invalid.
        • -3: The initialization of the SDK fails. You can try to initialize the SDK again.
        • -5: The request is rejected.
          • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita index ec23bbf3f9c..51ae81ac950 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita @@ -77,7 +77,7 @@ int JoinChannelWithUserAccount(FString token, FString channelId, FString userAcc
        • The 26 uppercase English letters: A to Z.
        • All numeric characters: 0 to 9.
        • Space
          • -
        • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
          • +
        • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

        @@ -92,4 +92,4 @@ int JoinChannelWithUserAccount(FString token, FString channelId, FString userAcc
    - + \ No newline at end of file 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 d45d30bc74c..281fab8d14a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita @@ -43,7 +43,7 @@ required String channelId, required String userAccount, required ChannelMediaOptions options}); -

    +

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

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

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

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

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

    +

    Details

    This method releases all resources related to the session.

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

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

    -

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

    +

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

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

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

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

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

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

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

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

    +

    Details

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

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

    -

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

    -

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

    -
    +

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

    +

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

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

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

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita b/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita index 6299e013120..cefd790cb24 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita @@ -1,20 +1,20 @@ - <ph keyref="loadExtensionProvider"/> + <ph keyref="loadExtensionProvider" /> Adds an extension to the SDK. - +

    - - + + virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0; abstract loadExtensionProvider( path: string, @@ -25,9 +25,9 @@ path: string, unloadAfterUse?: boolean ): number; - Future<void> loadExtensionProvider( + Future<void> loadExtensionProvider( {required String path, bool unloadAfterUse = false}); -

    +

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

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

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

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

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

    +

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

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

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

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

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

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

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

    +

    Details

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

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

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

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

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

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

    +

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

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

    +

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

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

    Whether to stop publishing the local audio stream:

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

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

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

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

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

    +

    Details -

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

    +

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

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

    Whether to stop publishing the local video stream.

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

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

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

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

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

    +

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

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

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

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

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

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

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

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

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

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

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

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

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

    +

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

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

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

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

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

    +

    Details

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

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

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

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

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

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

    +

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

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

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

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

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

    +

    Details

    Call this method after joining a channel.

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

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

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

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

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

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita b/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita index beed53b0041..01c628298f7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playalleffects.dita @@ -37,7 +37,7 @@ required double pan, required int gain, bool publish = false});     -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect2.dita index bf549c43085..c371e8baff2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect2.dita @@ -38,7 +38,7 @@
    Details - +

    To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the callback.Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See Supported Audio Formats.

    @@ -96,7 +96,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita index cecddf835bc..1ee1dbbb68a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita @@ -63,13 +63,13 @@ required int gain, bool publish = false, int startPos = 0});     -

    +

    Details - If you use this method to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call to preload the cached audio effect file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures. -

    To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the callback.

    -

    + If you use this method to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call to preload the cached audio effect file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures. +

    To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the callback.

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita index 79a92b6e8f0..a51c145d46d 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 3ba98310aa2..82387845421 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel2.dita @@ -1,12 +1,12 @@ - <ph keyref="preloadChannel2"/> + <ph keyref="preloadChannel2" /> Preloads a channel with token, channelIdchannelName, and userAccount. - + @@ -29,7 +29,7 @@ channelId: string, userAccount: string ): number; - Future<void> preloadChannelWithUserAccount( + Future<void> preloadChannelWithUserAccount( {required String token, required String channelId, required String userAccount});

      @@ -42,34 +42,34 @@
      v4.2.2
      -

      +

      -

      • +
        • You also need to make sure that the User Account, channel ID and token passed in for preloading are the same as the values passed in when joining the channel, otherwise, this method does not take effect.
          • -
        • -
        -

        +
      • +
      +

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

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

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

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

      • 0: Success.
      • < 0: Failure.
          @@ -79,4 +79,4 @@
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita index 45b5665ed89..8664b2664be 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadeffect.dita @@ -32,7 +32,7 @@ ): number; Future<void> preloadEffect( {required int soundId, required String filePath, int startPos = 0}); -

      +

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

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

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

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

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita index 2fe10ad82e7..85401f94c78 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita @@ -1,12 +1,12 @@ - <ph keyref="pushAudioFrame2"/> + <ph keyref="pushAudioFrame2" /> Pushes the external audio frame to the SDK. - + @@ -21,17 +21,17 @@ channels:(NSInteger)channels trackId:(NSInteger)trackId timestamp:(NSTimeInterval)timestamp NS_SWIFT_NAME(pushExternalAudioFrameRawData(_:samples:sampleRate:channels:trackId:timestamp:));       - - - - - -

      + + + + + +

      Details -

      Before calling this method, ensure that you set publishCustomAudioTrack to , and publishCustomAudioTrackId in to the audio track ID that you want to publish in the channel.

      +

      Before calling this method, ensure that you set publishCustomAudioTrack to , and publishCustomAudioTrackId in to the audio track ID that you want to publish in the channel.
      Parameters @@ -65,14 +65,14 @@ trackId - The audio track ID. Set this parameter to the custom audio track ID returned in . + The audio track ID. Set this parameter to the custom audio track ID returned in .
      Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita index a2f8d4ff677..3becf2db8ba 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushcaptureaudioframe.dita @@ -20,7 +20,7 @@ abstract pushCaptureAudioFrame(frame: AudioFrame): number; Future<void> pushCaptureAudioFrame(AudioFrame frame); -

      +

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

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

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

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

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita index 3cd6acec814..38489bc63d7 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 49795b6e1ef..522511a99b2 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 9a78f054615..0b015c8c51f 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 dd5a97135dc..8658e15bf3d 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_rate.dita b/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita index 47643d9ea5d..d6e0b950c8f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_rate.dita @@ -27,7 +27,7 @@ description:(NSString * _Nullable)description;     {required String callId, required int rating, required String description});     -

    +

    Details @@ -49,11 +49,11 @@ description:(NSString * _Nullable)description;
    - <ph keyref="return-section-title"/> -

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        +
      • < 0: Failure. See for details and resolution suggestions.
        • -2 (ERR_INVALID_ARGUMENT).
        • -3 (ERR_NOT_READY).
        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita index f785c668a7c..29670195497 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 8f02b0ef010..db7ab19b58f 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 c80ab95c8e4..7a225008787 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita @@ -1,20 +1,20 @@ - <ph keyref="registerExtension"/> + <ph keyref="registerExtension" /> Registers an extension. - +

    - - + + virtual int registerExtension(const char* provider, const char* extension, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0; abstract registerExtension( @@ -28,11 +28,11 @@ extension: string, type?: MediaSourceType ): number; - Future<void> registerExtension( + Future<void> registerExtension( {required String provider, required String extension, MediaSourceType type = MediaSourceType.unknownMediaSource}); -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita index a2ad26c293c..07cb8e9f4c2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita @@ -21,7 +21,7 @@ abstract registerLocalUserAccount(appId: string, userAccount: string): number; Future<void> registerLocalUserAccount( {required String appId, required String userAccount}); -

    +

    Details @@ -54,17 +54,17 @@
  • The 26 uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
    • -
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    • +
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita index ddf6428e362..b1240aa0a6b 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 76c9517a867..1faa504012c 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 2d25960973b..1f1e018fcc0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removeinjectstreamurl.dita @@ -20,7 +20,7 @@ public abstract int RemoveInjectStreamUrl(string url); Future<void> removeInjectStreamUrl(String url); -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita index c08e0a9edd4..1456c576837 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_removepublishstreamurl.dita @@ -20,7 +20,7 @@ public abstract int RemovePublishStreamUrl(string url); abstract removePublishStreamUrl(url: string): number; Future<void> removePublishStreamUrl(String url); -

    +

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita b/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita index 2a8d6626638..2ea3e2d3baa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita @@ -20,7 +20,7 @@ public abstract int RenewToken(string token); abstract renewToken(token: string): number; Future<void> renewToken(String token); -

    +

    DetailsYou can call this method to pass a new token to the SDK. A token expires after a certain period of time. In the following two cases, the app should call this method to pass in a new token. Failure to do so will result in the SDK disconnecting from the server.
      @@ -36,8 +36,8 @@
    - <ph keyref="return-section-title"/> -

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

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

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

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita index 03b4231c444..031f9a38850 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita @@ -20,18 +20,18 @@ public abstract int ResumeAllChannelMediaRelay(); abstract resumeAllChannelMediaRelay(): number; Future<void> resumeAllChannelMediaRelay(); -

        +

    Details

    After calling the method, you can call this method to resume relaying media streams to all destination channels.

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

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

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

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

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita b/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita index 60c6620b963..09975e443f4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumealleffects.dita @@ -22,14 +22,14 @@ public abstract int ResumeAllEffects(); abstract resumeAllEffects(): number; Future<void> resumeAllEffects(); -

    +

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

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

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita index 71c00845f98..9cd6ba401b0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeaudiomixing.dita @@ -20,18 +20,18 @@ public abstract int ResumeAudioMixing(); abstract resumeAudioMixing(): number; Future<void> resumeAudioMixing(); -

    +

    Details

    This method resumes playing and mixing the music file. Call this method when you are in a channel.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita index 26314af1cb5..a685604b422 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_resumeeffect.dita @@ -22,7 +22,7 @@ public abstract int ResumeEffect(int soundId); abstract resumeEffect(soundId: number): number; Future<void> resumeEffect(int soundId); -

    +

    Parameters @@ -33,11 +33,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita index a882b89021e..db7bbc40ac4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="selectAudioTrack"/> + <ph keyref="selectAudioTrack" /> Selects the audio track used during playback. - + @@ -19,16 +19,16 @@ abstract selectAudioTrack(index: number): number; public abstract int SelectAudioTrack(int index); abstract selectAudioTrack(index: number): number; - Future<void> selectAudioTrack(int index); -

    + Future<void> selectAudioTrack(int index); +

    Details

    After getting the track index of the audio file, you can call this method to specify any track to play. For example, if different tracks of a multi-track file store songs in different languages, you can call this method to set the playback language.

      -
    • For the supported formats of audio files, see .
      • -
    • You need to call this method after calling and receiving the () callback.
      • +
    • For the supported formats of audio files, see .
      • +
    • You need to call this method after calling and receiving the () callback.
    Parameters @@ -36,15 +36,15 @@ index audioIndex - The audio track you want to specify. The value range is [0, ()]. + The audio track you want to specify. The value range is [0, ()].
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita index 9484070ecf2..93f7a43a090 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 203c2bb76d9..11e843cf366 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita @@ -28,7 +28,7 @@ ): number;     Future<void> sendStreamMessage( {required int streamId, required Uint8List data, required int length}); -

    +

    Details @@ -62,11 +62,11 @@ A failed method call triggers the callbac
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita index b59eec4d79c..e26e7ae1d49 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 cd0a82e8a12..c2924f3c9b3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setainsmode.dita @@ -1,12 +1,12 @@ - <ph keyref="setAINSMode"/> + <ph keyref="setAINSMode" /> Sets whether to enable the AI ​​noise suppression function and set the noise suppression mode. - + @@ -19,7 +19,7 @@ abstract setAINSMode(enabled: boolean, mode: AudioAinsMode): number; public abstract int SetAINSMode(bool enabled, AUDIO_AINS_MODE mode); abstract setAINSMode(enabled: boolean, mode: AudioAinsMode): number; - Future<void> setAINSMode( + Future<void> setAINSMode( {required bool enabled, required AudioAinsMode mode});

    @@ -47,14 +47,14 @@ enabled Whether to enable the AI noise suppression function:
      -
    • : Enable the AI noise suppression.
      • -
    • : (Default) Disable the AI noise suppression.
      • +
    • : Enable the AI noise suppression.
      • +
    • : (Default) Disable the AI noise suppression.
         mode -

    The AI noise suppression modes. See .

    +

    The AI noise suppression modes. See .

    The AI noise suppression modes:

    • 0: (Default) Balance mode. This mode allows for a balanced performance on noice suppression and time delay.
    • 1: Aggressive mode. In scenarios where high performance on noise suppression is required, such as live streaming outdoor events, this mode reduces nosies more dramatically, but sometimes may affect the original character of the audio.
      • @@ -64,11 +64,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita index 2b8ded2c8db..a22891a8eba 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectparameters.dita @@ -27,7 +27,7 @@ {required AudioEffectPreset preset, required int param1, required int param2});     -

    +

    Details @@ -101,11 +101,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita index 33bfaf18455..268dd2384a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioeffectpreset.dita @@ -20,7 +20,7 @@ public abstract int SetAudioEffectPreset(AUDIO_EFFECT_PRESET preset); abstract setAudioEffectPreset(preset: AudioEffectPreset): number; Future<void> setAudioEffectPreset(AudioEffectPreset preset); -

    +

    Details @@ -42,7 +42,7 @@
    • -
  • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters @@ -77,11 +77,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita index db889cab3e6..3a07c981c47 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 f808884aeb9..382f0085c91 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingpitch.dita @@ -20,7 +20,7 @@ public abstract int SetAudioMixingPitch(int pitch); abstract setAudioMixingPitch(pitch: number): number; Future<void> setAudioMixingPitch(int pitch); -

    +

    Details @@ -35,11 +35,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita index 754472ecbd7..596dda1a93c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingposition.dita @@ -20,7 +20,7 @@ public abstract int SetAudioMixingPosition(int pos); abstract setAudioMixingPosition(pos: number): number; Future<void> setAudioMixingPosition(int pos); -

    +

    Details @@ -35,11 +35,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita index f4f2d260de3..1c263905a1d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita @@ -30,7 +30,7 @@ int SetAudioProfile(EAUDIO_PROFILE_TYPE profile = EAUDIO_PROFILE_TYPE::AUDIO_PRO Future<void> setAudioProfile( {required AudioProfileType profile, AudioScenarioType scenario = AudioScenarioType.audioScenarioDefault}); -

    +

    Details @@ -75,11 +75,11 @@ int SetAudioProfile(EAUDIO_PROFILE_TYPE profile = EAUDIO_PROFILE_TYPE::AUDIO_PRO
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita index c2fc5f734eb..04e0c830e9d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile2.dita @@ -29,7 +29,7 @@ int SetAudioProfile(EAUDIO_PROFILE_TYPE profile = EAUDIO_PROFILE_TYPE::AUDIO_PRO
    • You can call this method either before or after joining a channel.
    • In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set profile as (4).
      • -
    • If you need to set the audio scenario, you can either call , or and set the mAudioScenarioaudioScenario in .
      • +
    • If you need to set the audio scenario, you can either call , or and set the mAudioScenarioaudioScenario in .
    Parameters @@ -45,7 +45,7 @@ int SetAudioProfile(EAUDIO_PROFILE_TYPE profile = EAUDIO_PROFILE_TYPE::AUDIO_PRO Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita index 417b4cc6c59..202a4402286 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita @@ -20,7 +20,7 @@ public abstract int SetAudioScenario(AUDIO_SCENARIO_TYPE scenario); abstract setAudioScenario(scenario: AudioScenarioType): number; Future<void> setAudioScenario(AudioScenarioType scenario); -

    +

    Details @@ -30,24 +30,24 @@ scenario - The audio scenarios. See . Under different audio scenarios, the device uses different volume types. + The audio scenarios. See . Under different audio scenarios, the device uses different volume types. scenario - The audio scenarios:
    • (0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.
      • -
    • (3): High-quality audio scenario, where users mainly play music.
      • -
    • (5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. In this scenario, audience members receive a pop-up window to request permission of using microphones.
      • -
    • (7): Real-time chorus scenario, where users have good network conditions and require extremely low latency.Before using this enumeration, you need to call to see whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (isLowLatencyAudioSupported = ).
      • -
    • (8): Meeting scenario that mainly involves the human voice.
    + The audio scenarios:
    • (0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.
      • +
    • (3): High-quality audio scenario, where users mainly play music.
      • +
    • (5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. In this scenario, audience members receive a pop-up window to request permission of using microphones.
      • +
    • (7): Real-time chorus scenario, where users have good network conditions and require extremely low latency.Before using this enumeration, you need to call to see whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (isLowLatencyAudioSupported = ).
      • +
    • (8): Meeting scenario that mainly involves the human voice.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita index 364ad8ada5a..481d00ff03c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiosessionoperationrestriction.dita @@ -23,7 +23,7 @@ ): number;     Future<void> setAudioSessionOperationRestriction( AudioSessionOperationRestriction restriction); -

    +

    Details @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita index 5aef989db97..a82cf9dc4cd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setavsyncsource.dita @@ -20,7 +20,7 @@ public abstract int SetAVSyncSource(string channelId, uint uid); abstract setAVSyncSource(channelId: string, uid: number): number; Future<void> setAVSyncSource({required String channelId, required int uid}); -

    +

    Details @@ -39,11 +39,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita index 2f449416da3..a61ca7b15e3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setbeautyeffectoptions.dita @@ -31,7 +31,7 @@ {required bool enabled, required BeautyOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource});     -

    +

    Details @@ -40,7 +40,7 @@
    • Call this method before calling or .
    • This method only applies to Android 5.0 or later.
      • -
    • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
      • +
    • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    @@ -50,8 +50,8 @@ enabled enable Whether to enable the image enhancement function:
      -
    • : Enable the image enhancement function.
      • -
    • : (Default) Disable the image enhancement function.
      • +
    • : Enable the image enhancement function.
      • +
    • : (Default) Disable the image enhancement function.
     @@ -64,13 +64,13 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        -
      • (4): The current device version is below Android 5.0, and this operation is not supported.
        • +
      • (4): The current device version is below Android 5.0, and this operation is not supported.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita index a6845288b09..a3000ef68bd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautoexposurefacemodeenabled.dita @@ -21,7 +21,7 @@ public abstract int SetCameraAutoExposureFaceModeEnabled(bool enabled); abstract setCameraAutoExposureFaceModeEnabled(enabled: boolean): number; Future<void> setCameraAutoExposureFaceModeEnabled(bool enabled); -

    +

    Details @@ -46,11 +46,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita index 28aaa6a50ec..cb1078ff53a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita @@ -21,7 +21,7 @@ public abstract int SetCameraAutoFocusFaceModeEnabled(bool enabled); abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number; Future<void> setCameraAutoFocusFaceModeEnabled(bool enabled); -

    +

    Details @@ -48,15 +48,15 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    • : Success.
      • -
    • : Failure. See for details and resolution suggestions.
      • +
    • : Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita index 8563817dfac..0d6b83de40f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita @@ -25,14 +25,14 @@ ): number;     Future<void> setCameraCapturerConfiguration( CameraCapturerConfiguration config); -

    +

    Details
    • This method is for Android and iOS only.
      • -
    • This method must be called after the camera is turned on, such as calling after and .
      • +
    • This method must be called after the camera is turned on, such as calling after and .
    Parameters @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita index 244f3095164..7428064f465 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameradeviceorientation.dita @@ -28,13 +28,13 @@ ): number;     Future<void> setCameraDeviceOrientation( {required VideoSourceType type, required VideoOrientation orientation}); -

    +

    Details
    • This method applies to Windows only.
      • -
    • You must call this method after . The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the callback and returns the local video state as (1).
      • +
    • You must call this method after . The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the callback and returns the local video state as (1).
    • When the video capture device does not have the gravity sensing function, you can call this method to manually adjust the rotation angle of the captured video.
    @@ -53,11 +53,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita index 96178cc6b47..a612f897208 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita @@ -17,11 +17,11 @@ - (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); -

    + Future<void> setCameraExposureFactor(double factor); +

    Details @@ -35,9 +35,9 @@
    • This method is for Android and iOS only.
      • -
    • You must call this method after . The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the callback and returns the local video state as (1).
      • -
    • Before calling this method, Agora recommends calling to check whether the current camera supports adjusting the exposure value.
      • -
    • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling .
      • +
    • You must call this method after . The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the callback and returns the local video state as (1).
      • +
    • Before calling this method, Agora recommends calling to check whether the current camera supports adjusting the exposure value.
      • +
    • By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling .
    @@ -55,11 +55,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.

    Without practical meaning.

    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita index 41e14e079d9..8ceef4c3fa6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita @@ -28,7 +28,7 @@ ): number;     Future<void> setCameraExposurePosition( {required double positionXinView, required double positionYinView}); -

    +

    Details @@ -55,11 +55,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita index bf479f44016..5f83cf8fd08 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita @@ -28,7 +28,7 @@ ): number;     Future<void> setCameraFocusPositionInPreview( {required double positionX, required double positionY}); -

    +

    Details @@ -55,11 +55,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita index 1743bc5823e..4b7a42ba8c3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita @@ -21,7 +21,7 @@ public abstract int SetCameraTorchOn(bool isOn); abstract setCameraTorchOn(isOn: boolean): number; Future<void> setCameraTorchOn(bool isOn); -

    +

    Details @@ -44,11 +44,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita index 46769711ef0..504555b745d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita @@ -21,7 +21,7 @@ public abstract int SetCameraZoomFactor(float factor); abstract setCameraZoomFactor(factor: number): number; Future<void> setCameraZoomFactor(double factor); -

    +

    Details @@ -40,8 +40,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • The camera zoom factor value, if successful.
    • < 0: if the method if failed.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita index 77097e3bb87..043b8bb02d8 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 48ddabfe2cd..bbe3ea06d1c 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 e96950f35f1..d03e1b9a0e8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -29,7 +29,7 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions& ): number;     Future<void> setClientRole( {required ClientRoleType role, ClientRoleOptions? options}); -

    +

    Details @@ -41,7 +41,7 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions&
  • 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.

      @@ -63,11 +63,11 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions&
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. 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.
          • @@ -75,4 +75,4 @@ int SetClientRole(ECLIENT_ROLE_TYPE clientroletype, const FClientRoleOptions&
    - + \ 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 39cc54bdd0a..18a718a359b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita @@ -20,7 +20,7 @@ public abstract int SetCloudProxy(CLOUD_PROXY_TYPE proxyType); abstract setCloudProxy(proxyType: CloudProxyType): number; Future<void> setCloudProxy(CloudProxyType proxyType); -

    +

    Details @@ -51,8 +51,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita index 19f0753e286..8a132f4f711 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 a911593c0c2..5e6c0db099c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -1,7 +1,7 @@ - <ph keyref="setDefaultAudioRouteToSpeakerphone"/> + <ph keyref="setDefaultAudioRouteToSpeakerphone" /> Sets the default audio playback route. @@ -25,14 +25,14 @@ defaultToSpeaker: boolean ): number;     Future<void> setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker); -

    +

    Details
    • This method applies to Android and iOS only.
      • -
    • Ensure that you call this method before joining a channel. If you need to change the audio route after joining a channel, call .
      • +
    • Ensure that you call this method before joining a channel. If you need to change the audio route after joining a channel, call .

    Most mobile phones have two audio routes: an earpiece at the top, and a speakerphone at the bottom. The earpiece plays at a lower volume, and the speakerphone at a higher volume. When setting the default audio route, you determine whether audio playback comes through the earpiece or speakerphone when no external audio device is connected.

    @@ -44,7 +44,7 @@
  • Video call: Speakerphone.
  • Video broadcast: Speakerphone.

    • -

    You can call this method to change the default audio route. After a successful method call, the SDK triggers the callback.

    +

    You can call this method to change the default audio route. After a successful method call, the SDK triggers the callback.

    The system audio route changes when an external audio device, such as a headphone or a Bluetooth audio device, is connected. See Audio Route for detailed change principles.
    @@ -60,11 +60,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita index 7d6e7396d6a..c2f8f1673ad 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremoteaudiostreams.dita @@ -20,7 +20,7 @@ public abstract int SetDefaultMuteAllRemoteAudioStreams(bool mute); abstract setDefaultMuteAllRemoteAudioStreams(mute: boolean): number; Future<void> setDefaultMuteAllRemoteAudioStreams(bool mute); -

    +

    Details @@ -52,11 +52,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita index acde0916240..fa59515acf7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultmuteallremotevideostreams.dita @@ -20,7 +20,7 @@ public abstract int SetDefaultMuteAllRemoteVideoStreams(bool mute); abstract setDefaultMuteAllRemoteVideoStreams(mute: boolean): number; Future<void> setDefaultMuteAllRemoteVideoStreams(bool mute); -

    +

    Details @@ -46,11 +46,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita index 9ad488254b9..f62dd0e57f1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingaudioconfiguration.dita @@ -25,7 +25,7 @@ ): number;     Future<void> setDirectCdnStreamingAudioConfiguration( AudioProfileType profile); -

    +

    When you set the publishMicrophoneTrack or publishCustomAudioTrack in the as to capture audios, you can call this method to set the audio profile.

    @@ -41,11 +41,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita index 5e8fa7b44c8..ae0bdefe296 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdirectcdnstreamingvideoconfiguration.dita @@ -1,12 +1,12 @@ - <ph keyref="setDirectCdnStreamingVideoConfiguration"/> + <ph keyref="setDirectCdnStreamingVideoConfiguration" /> Sets the video profile of the media streams directly pushed to the CDN by the host. - + @@ -25,30 +25,30 @@ abstract setDirectCdnStreamingVideoConfiguration( config: VideoEncoderConfiguration ): number; - Future<void> setDirectCdnStreamingVideoConfiguration( + Future<void> setDirectCdnStreamingVideoConfiguration( VideoEncoderConfiguration config); -

    +

    Details -

    This method only affects video streams captured by cameras or screens, or from custom video capture sources. That is, when you set publishCameraTrack or publishCustomVideoTrack in as to capture videos, you can call this method to set the video profiles.

    -

    If your local camera does not support the video resolution you set,the SDK automatically adjusts the video resolution to a value that is closest to your settings for capture, encoding or streaming, with the same aspect ratio as the resolution you set. You can get the actual resolution of the video streams through the callback.

    +

    This method only affects video streams captured by cameras or screens, or from custom video capture sources. That is, when you set publishCameraTrack or publishCustomVideoTrack in as to capture videos, you can call this method to set the video profiles.

    +

    If your local camera does not support the video resolution you set,the SDK automatically adjusts the video resolution to a value that is closest to your settings for capture, encoding or streaming, with the same aspect ratio as the resolution you set. You can get the actual resolution of the video streams through the callback.

    Parameters config - Video profile. See .During CDN live streaming, Agora only supports setting as or . + Video profile. See .During CDN live streaming, Agora only supports setting as or .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita index 225e2d0604b..370797a19cf 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 178c10d1ff5..466d9367eb6 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. - + @@ -30,9 +30,9 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig& mode: SimulcastStreamMode, streamConfig?: SimulcastStreamConfig ): number;     - Future<void> setDualStreamMode( + Future<void> setDualStreamMode( {required SimulcastStreamMode mode, SimulcastStreamConfig? streamConfig}); -

    +

    Details @@ -42,11 +42,11 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig&
    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.
    @@ -55,22 +55,22 @@ int SetDualStreamMode(ESIMULCAST_STREAM_MODE mode, const FSimulcastStreamConfig& 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 df4437d2b34..563e0ce2a02 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setearmonitoringaudioframeparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="setEarMonitoringAudioFrameParameters"/> + <ph keyref="setEarMonitoringAudioFrameParameters" /> Sets the format of the in-ear monitoring raw audio data. - + @@ -35,32 +35,32 @@ mode: RawAudioFrameOpModeType, samplesPerCall: number ): number;     - Future<void> setEarMonitoringAudioFrameParameters( + Future<void> setEarMonitoringAudioFrameParameters( {required int sampleRate, required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall}); -

    +

    Details -

    This method is used to set the in-ear monitoring audio data format reported by the callback.

    +

    This method is used to set the in-ear monitoring audio data format reported by the callback.

      -
    • Before calling this method, you need to call , and set includeAudioFilters to or .
      • -
    • The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the callback according to the sampling interval.
      • +
    • Before calling this method, you need to call , and set includeAudioFilters to or .
      • +
    • The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the callback according to the sampling interval.
    Parameters sampleRate - The sample rate of the audio data reported in the callback, which can be set as 8,000, 16,000, 32,000, 44,100, or 48,000 Hz. + The sample rate of the audio data reported in the callback, which can be set as 8,000, 16,000, 32,000, 44,100, or 48,000 Hz. channel -

    The number of audio channels reported in the callback.

      +

      The number of audio channels reported in the callback.

      • 1: Mono.
      • 2: Stereo.

      @@ -69,21 +69,21 @@ mode -

      The use mode of the audio frame. See .

      -

      +

      The use mode of the audio frame. See .

      +

      samplesPerCall - The number of data samples reported in the callback, such as 1,024 for the Media Push. + The number of data samples reported in the callback, such as 1,024 for the Media Push.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita index 5e5e8032a67..38da99b0a48 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectposition.dita @@ -19,8 +19,8 @@ abstract setEffectPosition(soundId: number, pos: number): number; public abstract int SetEffectPosition(int soundId, int pos); abstract setEffectPosition(soundId: number, pos: number): number; - Future<void> setEffectPosition({required int soundId, required int pos}); -

    + Future<void> setEffectPosition({required int soundId, required int pos}); +

    Details @@ -39,11 +39,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita index 0295e40a029..257259b1da2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita @@ -22,7 +22,7 @@ public abstract int SetEffectsVolume(int volume); abstract setEffectsVolume(volume: number): number; Future<void> setEffectsVolume(int volume); -

    +

    Details @@ -36,11 +36,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita index a0a51e74f32..79be5e02836 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita @@ -46,11 +46,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita index 2fc09b0977d..9a46286cddd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionmode.dita @@ -20,7 +20,7 @@ public abstract int SetEncryptionMode(string encryptionMode); abstract setEncryptionMode(encryptionMode: string): number; Future<void> setEncryptionMode(String encryptionMode); -

    +

    Details @@ -51,11 +51,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita index 1226a08d566..8b13f0b94c8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setencryptionsecret.dita @@ -20,7 +20,7 @@ public abstract int SetEncryptionSecret(string secret); abstract setEncryptionSecret(secret: string): number; Future<void> setEncryptionSecret(String secret); -

    +

    Details @@ -45,11 +45,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita index 9f47f64271c..69d7f80373b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproperty.dita @@ -46,7 +46,7 @@ int SetExtensionProperty(FString provider, FString extension, FString key, FStri required String key, required String value, MediaSourceType type = MediaSourceType.unknownMediaSource});     -

    +

    Details @@ -77,11 +77,11 @@ int SetExtensionProperty(FString provider, FString extension, FString key, FStri
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita index 834a7489b52..b144e7e6aaf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setextensionproviderproperty.dita @@ -33,7 +33,7 @@ ): number;     Future<void> setExtensionProviderProperty( {required String provider, required String key, required String value}); -

    +

    Details @@ -60,11 +60,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita index 5fa38a8e627..6745c3dac39 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_setheadphoneeqparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita index 4f4b975a374..9b4caa26567 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="setHeadphoneEQParameters"/> + <ph keyref="setHeadphoneEQParameters" /> Sets the low- and high-frequency parameters of the headphone equalizer. - + @@ -19,9 +19,9 @@ abstract setHeadphoneEQParameters(lowGain: number, highGain: number): number; public abstract int SetHeadphoneEQParameters(int lowGain, int highGain); abstract setHeadphoneEQParameters(lowGain: number, highGain: number): number; - Future<void> setHeadphoneEQParameters( + Future<void> setHeadphoneEQParameters( {required int lowGain, required int highGain}); -

    +

    Details @@ -31,7 +31,7 @@
    v4.1.0
    -

    In a spatial audio effect scenario, if the preset headphone equalization effect is not achieved after calling the method, you can further adjust the headphone equalization effect by calling this method.

    +

    In a spatial audio effect scenario, if the preset headphone equalization effect is not achieved after calling the method, you can further adjust the headphone equalization effect by calling this method.

    Parameters @@ -46,8 +46,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        @@ -55,4 +55,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita index 1232cec2d59..7ad126679d5 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 d04fe402fec..d16f8423e55 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setinearmonitoringvolume.dita @@ -20,7 +20,7 @@ public abstract int SetInEarMonitoringVolume(int volume); abstract setInEarMonitoringVolume(volume: number): number; Future<void> setInEarMonitoringVolume(int volume); -

    +

    Details @@ -39,11 +39,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita index 978aeb99429..f83443019d7 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 8e0930be099..41746a73e7c 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 afcba6a383b..3aeaaa5d24d 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 cd5c81be13e..bf762c844b8 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 9fdbe649b2c..1b38006884f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -32,7 +32,7 @@ int SetLocalRenderMode(ERENDER_MODE_TYPE renderMode, EVIDEO_MIRROR_MODE_TYPE mir {required RenderModeType renderMode, VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto});     -

    +

    Details @@ -71,11 +71,11 @@ int SetLocalRenderMode(ERENDER_MODE_TYPE renderMode, EVIDEO_MIRROR_MODE_TYPE mir
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 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 56586316052..d14a2c7a7f4 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_setlocalvoicechanger.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita index 9630382e978..3d068e46920 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita @@ -1,12 +1,12 @@ - <ph keyref="setLocalVoiceChanger"/> + <ph keyref="setLocalVoiceChanger" /> Sets the local voice changer option. - + @@ -16,11 +16,11 @@ public abstract int setLocalVoiceChanger(int voiceChanger); - (int) setLocalVoiceChanger:(AgoraAudioVoiceChanger)voiceChanger; virtual int setLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger) = 0; - + public abstract int SetLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger); - - -

    + + +

    Details @@ -28,9 +28,9 @@
    Deprecated:
    This method is deprecated, please use the following method instead:
      -
    • : Audio effects.
      • -
    • : Voice beautifier effects.
      • -
    • : Voice conversion effects.
      • +
    • : Audio effects.
      • +
    • : Voice beautifier effects.
      • +
    • : Voice conversion effects.
     @@ -41,7 +41,7 @@

      -
    • To achieve better voice effect quality, Agora recommends setting the profile parameter in as (4) or (5).
      • +
    • To achieve better voice effect quality, Agora recommends setting the profile parameter in as (4) or (5).
    • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music and a human voice.
    • You can call this method either before or after joining a channel.
    @@ -51,30 +51,30 @@ voiceChanger -

    The local voice changer option. The default value is , which means the original voice. See . The gender-based beatification effect works best only when assigned a proper gender. Use for male and use and for female. Otherwise, voice distortion might occur.

    +

    The local voice changer option. The default value is , which means the original voice. See . The gender-based beatification effect works best only when assigned a proper gender. Use for male and use and for female. Otherwise, voice distortion might occur.

    The local voice changer option:

      -
    • : +
    • : (Default) Turn off the local voice changer, that is, to use the original voice.
      • -
    • : The voice of an old man.
      • -
    • : The voice of a little boy.
      • -
    • : The voice of a little girl.
      • -
    • : The voice of Zhu Bajie, a character in Journey to the West who has a voice like that of a growling bear.
      • -
    • : The ethereal voice.
      • -
    • : The voice of Hulk.
      • -
    • : A more vigorous voice.
      • -
    • : A deeper voice.
      • -
    • : A mellower voice.
      • -
    • : Falsetto.
      • -
    • : A fuller voice.
      • -
    • : A clearer voice.
      • -
    • : A more resounding voice.
      • -
    • : A more ringing voice.
      • -
    • : A more spatially resonant voice.
      • -
    • : +
    • : The voice of an old man.
      • +
    • : The voice of a little boy.
      • +
    • : The voice of a little girl.
      • +
    • : The voice of Zhu Bajie, a character in Journey to the West who has a voice like that of a growling bear.
      • +
    • : The ethereal voice.
      • +
    • : The voice of Hulk.
      • +
    • : A more vigorous voice.
      • +
    • : A deeper voice.
      • +
    • : A mellower voice.
      • +
    • : Falsetto.
      • +
    • : A fuller voice.
      • +
    • : A clearer voice.
      • +
    • : A more resounding voice.
      • +
    • : A more ringing voice.
      • +
    • : A more spatially resonant voice.
      • +
    • : (For male only) A more magnetic voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. Do not use it when the speaker is a female; otherwise, voice distortion occurs.
      • -
    • : +
    • : (For female only) A fresher voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. Do not use it when the speaker is a male; otherwise, voice distortion occurs.
      • -
    • : +
    • : (For female only) A more vital voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. Do not use it when the speaker is a male; otherwise, voice distortion occurs.

     @@ -84,7 +84,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita index 5913fc12f18..421167fbb08 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceequalization.dita @@ -30,7 +30,7 @@ Future<void> setLocalVoiceEqualization( {required AudioEqualizationBandFrequency bandFrequency, required int bandGain}); -

    +

    Details @@ -49,11 +49,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita index 5e716448e60..07dad1f8b79 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoiceformant.dita @@ -1,12 +1,12 @@ - <ph keyref="setLocalVoiceFormant"/> + <ph keyref="setLocalVoiceFormant" /> Set the formant ratio to change the timbre of human voice. - + @@ -22,7 +22,7 @@ int SetLocalVoiceFormant(FString formantRatio = "0.0");     abstract setLocalVoiceFormant(formantRatio: number): number; public abstract int SetLocalVoiceFormant(double formantRatio); abstract setLocalVoiceFormant(formantRatio: number): number; - Future<void> setLocalVoiceFormant(double formantRatio);

    + Future<void> setLocalVoiceFormant(double formantRatio);

    Details @@ -33,7 +33,7 @@ int SetLocalVoiceFormant(FString formantRatio = "0.0");

    Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper.

    -

    You can call this method to set the formant ratio of local audio to change the timbre of human voice. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with .You can call this method either before or after joining a channel.

    +

    You can call this method to set the formant ratio of local audio to change the timbre of human voice. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with .You can call this method either before or after joining a channel.

    Parameters @@ -44,11 +44,11 @@ int SetLocalVoiceFormant(FString formantRatio = "0.0");
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita index dcbabdc86a8..9a1b6b603d0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicepitch.dita @@ -20,7 +20,7 @@ public abstract int SetLocalVoicePitch(double pitch); abstract setLocalVoicePitch(pitch: number): number; Future<void> setLocalVoicePitch(double pitch); -

    +

    Details @@ -34,11 +34,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita index 53ee63ef020..4c0816bb346 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverb.dita @@ -27,7 +27,7 @@ ): number;     Future<void> setLocalVoiceReverb( {required AudioReverbType reverbKey, required int value}); -

    +

    Details @@ -47,11 +47,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita index 683d3c2c005..56f2f1f347a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita @@ -1,12 +1,12 @@ - <ph keyref="setLocalVoiceReverbPreset"/> + <ph keyref="setLocalVoiceReverbPreset" /> Sets the local voice reverberation option, including the virtual stereo. - + @@ -16,11 +16,11 @@ public abstract int setLocalVoiceReverbPreset(int reverbPreset); - (int) setLocalVoiceReverbPreset:(AgoraAudioReverbPreset)reverbPreset; virtual int setLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset) = 0; - + public abstract int SetLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset); - - -

    + + +

    Details @@ -28,14 +28,14 @@
    Deprecated:
    -
    Use or instead.
    +
    Use or instead.

    This method sets the local voice reverberation for users in a COMMUNICATION channel or hosts in a live boradcasting channel. After successfully calling this method, all users in the channel can hear the voice with reverberation.

      -
    • When using the enumeration value prefixed with AUDIO_REVERB_FX, ensure that you set the profile parameter in to (4) or (5) before calling this method. Otherwise, the method setting is invalid.
      • -
    • When calling the method, Agora recommends setting the profile parameter in as (5).
      • +
    • When using the enumeration value prefixed with AUDIO_REVERB_FX, ensure that you set the profile parameter in to (4) or (5) before calling this method. Otherwise, the method setting is invalid.
      • +
    • When calling the method, Agora recommends setting the profile parameter in as (5).
    • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music and a human voice.
    • You can call this method either before or after joining a channel.
    @@ -46,17 +46,17 @@ reverbPreset preset -

    The local voice reverberation option. The default value is , which means the original voice. See . To achieve better voice effects, Agora recommends the enumeration whose name begins with AUDIO_REVERB_FX.

     +

    The local voice reverberation option. The default value is , which means the original voice. See . To achieve better voice effects, Agora recommends the enumeration whose name begins with AUDIO_REVERB_FX.

    The local voice reverberation option. To achieve better voice effects, Agora recommends the enumeration whose name begins with AUDIO_REVERB_FX.

      -
    • : (Default) Turn off local voice reverberation, that is, to use the original voice.
      • -
    • : The reverberation style typical of a KTV venue (enhanced).
      • -
    • : The reverberation style typical of a concert hall (enhanced).
      • -
    • : The reverberation style typical of an uncle's voice.
      • -
    • : The reverberation style typical of a little sister's voice.
      • -
    • : The reverberation style typical of a recording studio (enhanced).
      • -
    • : The reverberation style typical of popular music (enhanced).
      • -
    • : The reverberation style typical of R&B music (enhanced).
      • -
    • : The reverberation style typical of the vintage phonograph.
      • +
    • : (Default) Turn off local voice reverberation, that is, to use the original voice.
      • +
    • : The reverberation style typical of a KTV venue (enhanced).
      • +
    • : The reverberation style typical of a concert hall (enhanced).
      • +
    • : The reverberation style typical of an uncle's voice.
      • +
    • : The reverberation style typical of a little sister's voice.
      • +
    • : The reverberation style typical of a recording studio (enhanced).
      • +
    • : The reverberation style typical of popular music (enhanced).
      • +
    • : The reverberation style typical of R&B music (enhanced).
      • +
    • : The reverberation style typical of the vintage phonograph.

     @@ -67,7 +67,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita index c4119709719..46c53e92c23 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfile.dita @@ -20,7 +20,7 @@ public abstract int SetLogFile(string filePath); abstract setLogFile(filePath: string): number; Future<void> setLogFile(String filePath); -

    +

    Details @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita index 26179a80252..b72d97aff37 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilesize.dita @@ -20,7 +20,7 @@ public abstract int SetLogFileSize(uint fileSizeInKBytes); abstract setLogFileSize(fileSizeInKBytes: number): number; Future<void> setLogFileSize(int fileSizeInKBytes); -

    +

    Details @@ -57,11 +57,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita index 39dcd8f5bb9..63446c3438e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlogfilter.dita @@ -20,7 +20,7 @@ public abstract int SetLogFilter(uint filter); abstract setLogFilter(filter: LogFilterType): number; Future<void> setLogFilter(LogFilterType filter); -

    +

    Details @@ -51,11 +51,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita index 84d9992dbf3..8f524becda7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setloglevel.dita @@ -21,7 +21,7 @@ public abstract int SetLogLevel(LOG_LEVEL level); abstract setLogLevel(level: LogLevel): number; Future<void> setLogLevel(LogLevel level); -

    +

    Details @@ -42,11 +42,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita index c63c6db3608..2f46060167a 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 9882c9576b3..8b00729f599 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmaxmetadatasize.dita @@ -20,7 +20,7 @@ public abstract int SetMaxMetadataSize(int size); abstract setMaxMetadataSize(size: number): number; Future<void> setMaxMetadataSize(int size); -

    +

    Details @@ -35,11 +35,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita index 360c263c201..50c869f4285 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita @@ -33,7 +33,7 @@ {required int sampleRate, required int channel, required int samplesPerCall});     -

    +

    Parameters @@ -65,11 +65,11 @@

    The SDK triggers the callback according to the sample interval. Sampleinterval (sec) = samplePerCall/(sampleRate × channel) Ensure that the value of sample interval more than or equal to 0.01.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita index bd37f4902e7..ca4f464b539 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita @@ -1,12 +1,12 @@ - <ph keyref="setParameters"/> + <ph keyref="setParameters" /> Provides technical preview functionalities or special customizations by configuring the SDK with JSON options. - + @@ -19,7 +19,7 @@ abstract setParameters(parameters: string): number; public abstract int SetParameters(string key, object value); abstract setParameters(parameters: string): number; - Future<void> setParameters(String parameters);

    + Future<void> setParameters(String parameters);

    @@ -48,11 +48,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita index d61e7eefe03..12829f61d69 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita @@ -26,9 +26,9 @@ sampleRate: number, channel: number ): number;     - Future<void> setPlaybackAudioFrameBeforeMixingParameters( + Future<void> setPlaybackAudioFrameBeforeMixingParameters( {required int sampleRate, required int channel}); -

    +

    Parameters @@ -49,11 +49,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita index ee55c3a4f05..b3c2d994c43 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframeparameters.dita @@ -42,7 +42,7 @@ required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall});     -

    +

    Details @@ -81,11 +81,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita index 6a3ca84dc77..34f7ceafc42 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setrecordingaudioframeparameters.dita @@ -41,7 +41,7 @@ required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall});     -

    +

    Details @@ -89,11 +89,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita index 30cdf90788b..463004ea8c8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita @@ -20,13 +20,13 @@ public abstract int SetRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType); abstract setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number; Future<void> setRemoteDefaultVideoStreamType(VideoStreamType streamType); -

    +

    Details

    Under limited network conditions, if the publisher has not disabled the dual-stream mode using (), the receiver can choose to receive either the high-quality video stream or the low-video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

    By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.

    -

    +

    • Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
      • @@ -40,18 +40,18 @@

      The default video-stream type. See .

      The default video-stream type:

        -
      • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
        • -
      • (1): Low-quality stream, that is, a low-resolution and low-bitrate video stream.
        • +
      • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
        • +
      • (1): Low-quality stream, that is, a low-resolution and low-bitrate video stream.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita index 4fddbdb55c8..38e232e32e1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteRenderMode1"/> + <ph keyref="setRemoteRenderMode1" /> Sets the video display mode of a specified remote user. - + @@ -17,18 +17,18 @@ - (int)setRemoteRenderMode:(NSUInteger)uid mode:(AgoraVideoRenderMode) mode; virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode) = 0; - + public abstract int SetRemoteRenderMode(uint userId, RENDER_MODE_TYPE renderMode); - - -

    + + +

    Details
    Deprecated:
    -
    This method is deprecated. Use instead.
    +
    This method is deprecated. Use instead.

    Call this method to set the video display mode of a specified remote user. This method can be called multiple times during a call to change the display mode.

    @@ -43,10 +43,10 @@ renderMode -

    The rendering mode of the remote user view. For details, see .

    +

    The rendering mode of the remote user view. For details, see .

    The rendering mode of the remote user view.

      -
    • (1): Hidden mode. Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
      • -
    • (2): Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.
      • +
    • (1): Hidden mode. Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
      • +
    • (2): Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.

         @@ -55,7 +55,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita index 8d0a579e5b2..dea7429660f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita @@ -33,7 +33,7 @@ {required int uid, required RenderModeType renderMode, required VideoMirrorModeType mirrorMode});     -

    +

    Details @@ -73,11 +73,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita index 3e17e005425..f6cc67290c7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotesubscribefallbackoption.dita @@ -24,12 +24,12 @@ option: StreamFallbackOptions ): number;     Future<void> setRemoteSubscribeFallbackOption(StreamFallbackOptions option); -

    +

    Details -

    When the network is not ideal, the quality of live audio and video can be degraded. If option is set as or , the SDK automatically switches the video from a high-quality stream to a low-quality stream or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. The SDK monitors the network quality and restores the video stream when the network conditions improve.

    -

    When the remote video stream falls back to audio-only or when the audio-only stream switches back to the video, the SDK triggers the callback.

    +

    When the network is not ideal, the quality of live audio and video can be degraded. If option is set as or , the SDK automatically switches the video from a high-quality stream to a low-quality stream or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. The SDK monitors the network quality and restores the video stream when the network conditions improve.

    +

    When the remote video stream falls back to audio-only or when the audio-only stream switches back to the video, the SDK triggers the callback.

    Ensure that you call this method before joining a channel.
    Parameters @@ -44,11 +44,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita index 80c48e2711a..2146fedc204 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteUserPriority"/> + <ph keyref="setRemoteUserPriority" /> Prioritizes a remote user's stream. - + @@ -14,12 +14,12 @@

    public abstract int setRemoteUserPriority(int uid, int userPriority); - + virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0; - + public abstract int SetRemoteUserPriority(uint uid, PRIORITY_TYPE userPriority); - -

    + +

    Details @@ -39,9 +39,9 @@ userPriority -

    The priority of the remote user. See .

      -
    • : The user's priority is high.
      • -
    • : (Default) The user's priority is normal.
      • +

      The priority of the remote user. See .

        +
      • : The user's priority is high.
        • +
      • : (Default) The user's priority is normal.

      @@ -50,7 +50,7 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita index 0d0483b34b4..b77c10a0c0a 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 b40fba9d8f9..68ec9f7ee75 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita @@ -28,7 +28,7 @@ ): number;     Future<void> setRemoteVideoStreamType( {required int uid, required VideoStreamType streamType}); -

    +

    Details @@ -46,7 +46,7 @@ streamType -

    The video stream type: .

    +

    The video stream type: .

    The video stream type:

    • 0: High-quality video stream.
    • 1: Low-quality video stream.
      • @@ -55,11 +55,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita index 623e0ee28e3..e50ae35d7cd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteVideoSubscriptionOptions"/> + <ph keyref="setRemoteVideoSubscriptionOptions" /> Options for subscribing to remote video streams. - + @@ -26,24 +26,24 @@ uid: number, options: VideoSubscriptionOptions ): number;     - Future<void> setRemoteVideoSubscriptionOptions( + Future<void> setRemoteVideoSubscriptionOptions( {required int uid, required VideoSubscriptionOptions options}); -

    +

    Details

    When a remote user has enabled dual-stream mode, you can call this method to choose the option for subscribing to the video streams sent by the remote user.

      -
    • If you only register one object, the SDK subscribes to the raw video data and encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • -
    • If you only register one object, the SDK only subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • -
    • If you register one object and one object successively, the SDK subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • -
    • If you call this method first with the options parameter set, and then register one or object, you need to call this method again and set the options parameter as described in the above two items to get the desired results.
      • +
    • If you only register one object, the SDK subscribes to the raw video data and encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • +
    • If you only register one object, the SDK only subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • +
    • If you register one object and one object successively, the SDK subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
      • +
    • If you call this method first with the options parameter set, and then register one or object, you need to call this method again and set the options parameter as described in the above two items to get the desired results.

    Agora recommends the following steps:
      -
    1. Set autoSubscribeVideo to when calling to join a channel.
      2. -
    2. Call this method after receiving the callback to set the subscription options for the specified remote user's video stream.
      3. -
    3. Call the method to resume subscribing to the video stream of the specified remote user. If you set encodedFrameOnly to in the previous step, the SDK triggers the callback locally to report the received encoded video frame information.
      4. +
    4. Set autoSubscribeVideo to when calling to join a channel.
      5. +
    5. Call this method after receiving the callback to set the subscription options for the specified remote user's video stream.
      6. +
    6. Call the method to resume subscribing to the video stream of the specified remote user. If you set encodedFrameOnly to in the previous step, the SDK triggers the callback locally to report the received encoded video frame information.
    Parameters @@ -54,15 +54,15 @@ options - The video subscription options. See . + The video subscription options. See .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita index 136b9b989fa..fb5ed98be98 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevoiceposition.dita @@ -29,7 +29,7 @@ ): number;     Future<void> setRemoteVoicePosition( {required int uid, required double pan, required double gain}); -

    +

    Details @@ -62,11 +62,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita index 57100ea4d6f..df909e53f7b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita @@ -1,12 +1,12 @@ - <ph keyref="setRouteInCommunicationMode"/> + <ph keyref="setRouteInCommunicationMode" /> Selects the audio playback route in communication audio mode. - + @@ -14,12 +14,12 @@

    public abstract int setRouteInCommunicationMode(int route); - + virtual int setRouteInCommunicationMode(int route) = 0; - + public abstract int SetRouteInCommunicationMode(int route); abstract setRouteInCommunicationMode(route: number): number; - Future<void> setRouteInCommunicationMode(int route);

    + Future<void> setRouteInCommunicationMode(int route);

    Details @@ -29,9 +29,9 @@
    v4.2.2
    -

    This method is used to switch the audio route from Bluetooth headphones to earpiece, wired headphones or speakers in communication audio mode (). After the method is called successfully, the SDK will trigger the callback to report the modified route.

    - Using this method and the method at the same time may cause conflicts. Agora recommends that you use the method alone. -
    • This method is for Android only.
    • Using this method and the method at the same time may cause conflicts. Agora recommends that you use the method alone.
     +

    This method is used to switch the audio route from Bluetooth headphones to earpiece, wired headphones or speakers in communication audio mode (). After the method is called successfully, the SDK will trigger the callback to report the modified route.

    + Using this method and the method at the same time may cause conflicts. Agora recommends that you use the method alone. +
    • This method is for Android only.
    • Using this method and the method at the same time may cause conflicts. Agora recommends that you use the method alone.
    Parameters @@ -52,7 +52,7 @@
    - <ph keyref="return-section-title"/> + <ph keyref="return-section-title" />

    Without practical meaning.

    -     + \ 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 b99529a9ade..a06dda8fd9a 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 f267c25f43f..41204555ade 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturescenario.dita @@ -23,7 +23,7 @@ public abstract int SetScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario); abstract setScreenCaptureScenario(screenScenario: ScreenScenarioType): number; Future<void> setScreenCaptureScenario(ScreenScenarioType screenScenario); -

      +

    Details @@ -40,11 +40,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita index c50b70f43c8..3350473ac3e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioallowlist.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeAudioAllowlist"/> + <ph keyref="setSubscribeAudioAllowlist" /> Sets the allowlist of subscriptions for audio streams. - + @@ -25,19 +25,19 @@ uidList: number[], uidNumber: number ): number;     - Future<void> setSubscribeAudioAllowlist( - {required List<int> uidList, required int uidNumber}); -

    + Future<void> setSubscribeAudioAllowlist( + {required List<int> uidList, required int uidNumber}); +

    Details

    You can call this method to specify the audio streams of a user that you want to subscribe to.

      -
    • -
    • The allowlist is not affected by the setting in , and autoSubscribeAudio in .
      • +
    • +
    • The allowlist is not affected by the setting in , and autoSubscribeAudio in .
    • Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
      • -
    • +
    Parameters @@ -47,7 +47,7 @@ allowlist

    The user ID list of users that you want to subscribe to.

    -

    If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

    +

    If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

     @@ -56,12 +56,12 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita index 8e33122b642..ec317fb6e8c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribeaudioblocklist.dita @@ -25,9 +25,9 @@ uidList: number[], uidNumber: number ): number;     - Future<void> setSubscribeAudioBlocklist( - {required List<int> uidList, required int uidNumber}); -

    + Future<void> setSubscribeAudioBlocklist( + {required List<int> uidList, required int uidNumber}); +

    Details @@ -56,11 +56,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita index 42b017560e3..c26557ea680 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoallowlist.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeVideoAllowlist"/> + <ph keyref="setSubscribeVideoAllowlist" /> Set the allowlist of subscriptions for video streams. - + @@ -25,19 +25,19 @@ uidList: number[], uidNumber: number ): number;     - Future<void> setSubscribeVideoAllowlist( - {required List<int> uidList, required int uidNumber}); -

    + Future<void> setSubscribeVideoAllowlist( + {required List<int> uidList, required int uidNumber}); +

    Details

    You can call this method to specify the video streams of a user that you want to subscribe to.

      -
    • -
    • The allowlist is not affected by the setting in , and autoSubscribeAudio in .
      • -
    • -
    • +
    • +
    • The allowlist is not affected by the setting in , and autoSubscribeAudio in .
      • +
    • +
    Parameters @@ -46,21 +46,21 @@ uidList

    The user ID list of users that you want to subscribe to.

    -

    If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

    +

    If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.

     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita index 3607e36e19d..ff03ba055a4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setsubscribevideoblocklist.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeVideoBlocklist"/> + <ph keyref="setSubscribeVideoBlocklist" /> Set the blocklist of subscriptions for video streams. - + @@ -25,19 +25,19 @@ uidList: number[], uidNumber: number ): number;     - Future<void> setSubscribeVideoBlocklist( - {required List<int> uidList, required int uidNumber}); -

    + Future<void> setSubscribeVideoBlocklist( + {required List<int> uidList, required int uidNumber}); +

    Details

    You can call this method to specify the video streams of a user that you do not want to subscribe to.

      -
    • -
    • The blocklist is not affected by the setting in , and autoSubscribeAudio in .
      • -
    • -
    • +
    • +
    • The blocklist is not affected by the setting in , and autoSubscribeAudio in .
      • +
    • +
    Parameters @@ -47,21 +47,21 @@ blocklist

    The user ID list of users that you do not want to subscribe to.

    -

    If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.

    +

    If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.

     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 5bf8e06bdff..4af88ebf4d2 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 c8aeed39682..cd570ca3358 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 e946888a80b..b25fdadc094 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 eabd88e2777..462aa59652f 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 c9f03296c76..58f194a6524 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_setvideoscenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita index f978018b92f..2e4c7d21bfc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita @@ -1,12 +1,12 @@ - <ph keyref="setVideoScenario"/> + <ph keyref="setVideoScenario" /> Sets video application scenarios. - + @@ -19,7 +19,7 @@ abstract setVideoScenario(scenarioType: VideoApplicationScenarioType): number; public abstract int SetVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType); abstract setVideoScenario(scenarioType: VideoApplicationScenarioType): number; - Future<void> setVideoScenario(VideoApplicationScenarioType scenarioType);

    + Future<void> setVideoScenario(VideoApplicationScenarioType scenarioType);

    Details @@ -37,11 +37,11 @@ scenarioType - The type of video application scenario. See .

    If set to (1), the SDK automatically enables the following strategies:

      + The type of video application scenario. See .

      If set to (1), the SDK automatically enables the following strategies:

      • In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
      • The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
        • If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
          • -
        • If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the configuration used in the most recent calling of . If no configuration has been set by the user previously, the following values are used:
            +
          • If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the configuration used in the most recent calling of . If no configuration has been set by the user previously, the following values are used:
            • Resolution: (Windows and macOS) 1280 × 720; (Android and iOS) 960 × 540
            • Frame rate: 15 fps
            • Bitrate: (Windows and macOS) 1600 Kbps; (Android and iOS) 1000 Kbps
              • @@ -58,9 +58,9 @@
          • -
        • The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers.If the user has called to set that never send low-quality video stream (), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
            +
          • The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers.If the user has called to set that never send low-quality video stream (), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
            • If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth.
              • -
            • If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the configuration used in the most recent calling of . If no configuration has been set by the user previously, the following values are used:
                +
              • If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the configuration used in the most recent calling of . If no configuration has been set by the user previously, the following values are used:
                • Resolution: 480 × 272
                • Frame rate: 15 fps
                • Bitrate: 500 Kbps
                  • @@ -74,12 +74,12 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita index 270c14c2014..793d3654b96 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierparameters.dita @@ -27,7 +27,7 @@ {required VoiceBeautifierPreset preset, required int param1, required int param2});     -

    +

    Details @@ -74,11 +74,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita index 9519a9c7ff1..b8ea31b56d8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoicebeautifierpreset.dita @@ -20,7 +20,7 @@ public abstract int SetVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset); abstract setVoiceBeautifierPreset(preset: VoiceBeautifierPreset): number; Future<void> setVoiceBeautifierPreset(VoiceBeautifierPreset preset); -

    +

    Details @@ -40,7 +40,7 @@
    • -
  • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters @@ -75,11 +75,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita index c37e7684064..3a0ce585c25 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvoiceconversionpreset.dita @@ -1,12 +1,12 @@ - <ph keyref="setVoiceConversionPreset"/> + <ph keyref="setVoiceConversionPreset" /> Sets a preset voice beautifier effect. - + @@ -20,28 +20,28 @@ public abstract int SetVoiceConversionPreset(VOICE_CONVERSION_PRESET preset); abstract setVoiceConversionPreset(preset: VoiceConversionPreset): number; Future<void> setVoiceConversionPreset(VoiceConversionPreset preset); -

    +

    Details

    Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting an audio effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios. For the applicable scenarios of each voice beautifier effect, refer to Set the Voice Effect.

    -

    To achieve better audio effect quality, Agora recommends that you call and set the profile to (4) or (5) and scenario to (3) before calling this method.

    +

    To achieve better audio effect quality, Agora recommends that you call and set the profile to (4) or (5) and scenario to (3) before calling this method.

    • You can call this method either before or after joining a channel.
      • -
    • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
      • +
    • Do not set the profile parameter in to (1) or (6), or the method does not take effect.
    • This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
      • -
    • After calling , Agora does not recommend you to call the following methods, otherwise the effect set by will be overwritten:
        -
        • -
        • -
        • -
        • -
        • -
        • -
        • -
        • +
      • After calling , Agora does not recommend you to call the following methods, otherwise the effect set by will be overwritten:
          +
          • +
          • +
          • +
          • +
          • +
          • +
          • +
        • -
      • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
        • +
      • This method relies on the voice beautifier dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    Parameters @@ -49,23 +49,23 @@ preset -

    The options for the preset voice beautifier effects: .

    +

    The options for the preset voice beautifier effects: .

    The options for SDK preset voice conversion effects.

      -
    • : Turn off voice conversion effects and use the original voice.
      • -
    • : A gender-neutral voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      • -
    • : A sweet voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      • -
    • : A steady voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
      • -
    • : A deep voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
      • +
    • : Turn off voice conversion effects and use the original voice.
      • +
    • : A gender-neutral voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      • +
    • : A sweet voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      • +
    • : A steady voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
      • +
    • : A deep voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita index 7716f6d5c03..a8fe7a1a293 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita @@ -23,7 +23,7 @@ public abstract int SetVolumeOfEffect(int soundId, int volume); abstract setVolumeOfEffect(soundId: number, volume: number): number; Future<void> setVolumeOfEffect({required int soundId, required int volume}); -

    +

    Parameters @@ -38,11 +38,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita index c3d52d01160..43dbf7471bf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita @@ -26,12 +26,12 @@ cycle: number, startPos?: number ): number;     - Future<void> startAudioMixing( + Future<void> startAudioMixing( {required String filePath, required bool loopback, required int cycle, int startPos = 0}); -

    +

    Details @@ -85,11 +85,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita index 8d522aaa50d..497a85bedaa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita @@ -31,7 +31,7 @@ int StartAudioMixing(FString filePath, bool loopback, int cycle, int startPos = cycle: number, startPos?: number ): number;     - Future<void> startAudioMixing( + Future<void> startAudioMixing( {required String filePath, required bool loopback, required int cycle, @@ -44,10 +44,10 @@ int StartAudioMixing(FString filePath, bool loopback, int cycle, int startPos =

    This method supports playing URI files starting with content://.

      -
    • You can call this method either before or after joining a channel. If you need to call multiple times, ensure that the time interval between calling this method is more than 500 ms.
      • +
    • You can call this method either before or after joining a channel. If you need to call multiple times, ensure that the time interval between calling this method is more than 500 ms.
    • If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports 701.
    • -
    • +
    • On Android, there are following considerations:
      • To use this method, ensure that the Android device is v4.2 or later, and the API version is v16 or later.
      • If you need to play an online music file, Agora does not recommend using the redirected URL address. Some Android devices may fail to open a redirected URL address.
        • @@ -85,8 +85,8 @@ int StartAudioMixing(FString filePath, bool loopback, int cycle, int startPos =
        - <ph keyref="return-section-title"/> -

        When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

        + <ph keyref="return-section-title" /> +

        When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

        • 0: Success.
        • < 0: Failure.
            @@ -95,11 +95,11 @@ int StartAudioMixing(FString filePath, bool loopback, int cycle, int startPos =
          • -3: The SDK is not ready.
            • The audio module is disabled.
            • The program is not complete.
              • -
            • The initialization of fails. Reinitialize the .
              • +
            • The initialization of fails. Reinitialize the .
        - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita index b0d9f5a939b..c27e39439a3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita @@ -1,12 +1,12 @@ - <ph keyref="startAudioRecording1"/> + <ph keyref="startAudioRecording1" /> Starts audio recording on the client. - + @@ -17,11 +17,11 @@ - (int)startAudioRecording:(NSString * _Nonnull)filePath quality:(AgoraAudioRecordingQuality)quality; virtual int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; - + public abstract int StartAudioRecording(string filePath, AUDIO_RECORDING_QUALITY_TYPE quality); - - -

        + + +

        Details @@ -30,18 +30,18 @@
      • .wav: Large file size with high fidelity.
      • .aac: Small file size with low fidelity.

      -

      Ensure that the directory for the recording file exists and is writable. This method should be called after the method. The recording automatically stops when you call the method.

      +

      Ensure that the directory for the recording file exists and is writable. This method should be called after the method. The recording automatically stops when you call the method.

      Parameters - - + + quality - Audio recording quality. See .
        + Audio recording quality. See .
        • 0: Low quality. The sample rate is 32 kHz, and the file size is around 1.2 MB after 10 minutes of recording.
        • 1: Medium quality. The sample rate is 32 kHz, and the file size is around 2 MB after 10 minutes of recording.
        • 2: High quality. The sample rate is 32 kHz, and the file size is around 3.75 MB after 10 minutes of recording.
          • @@ -52,7 +52,7 @@ Returns
          • 0: Success.
            • -
          • < 0: Failure. See for details and resolution suggestions.
            • +
          • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita index 640df5ca50b..d471711c4d7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita @@ -1,28 +1,28 @@ - <ph keyref="startAudioRecording2"/> + <ph keyref="startAudioRecording2" /> Starts audio recording on the client and sets the sample rate of recording. - +

      - - + + virtual int startAudioRecording(const char* filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; - + public abstract int StartAudioRecording(string filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality); - - -

      + + +

      Details @@ -33,15 +33,15 @@
      • Ensure that the directory you use to save the recording file exists and is writable.
        • -
      • This method should be called after the method. The recording automatically stops when you call the method.
        • -
      • For better recording effects, set quality to or when sampleRate is 44.1 kHz or 48 kHz.
        • +
      • This method should be called after the method. The recording automatically stops when you call the method.
        • +
      • For better recording effects, set quality to or when sampleRate is 44.1 kHz or 48 kHz.
      Parameters - - + + sampleRate @@ -56,14 +56,14 @@ quality - Recording quality. See . + Recording quality. See .
      Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
       -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita index 86b843aefe1..99fb3b32661 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita @@ -22,7 +22,7 @@ int StartAudioRecording(const FAudioRecordingConfiguration& config);public abstract int StartAudioRecording(AudioRecordingConfiguration config); abstract startAudioRecording(config: AudioRecordingConfiguration): number; Future<void> startAudioRecording(AudioRecordingConfiguration config); -

      +

      Details @@ -41,11 +41,11 @@ int StartAudioRecording(const FAudioRecordingConfiguration& config);
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 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 de1c333a593..a4b991aac51 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 6b527607b7d..d735a4cd557 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 147adcff2f0..efe95d2de62 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 032c9a9c0cf..a3b3fc7fc78 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest2.dita @@ -22,14 +22,14 @@ public abstract int StartEchoTest(int intervalInSeconds); abstract startEchoTest(intervalInSeconds?: number): number; Future<void> startEchoTest({int intervalInSeconds = 10}); -

    +

    Details
    Deprecated:
    -
    This method is deprecated as of v4.0.1. Use instead.
    +
    This method is deprecated as of v4.0.1. Use instead.

    This method starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly. To conduct the test, let the user speak for a while, and the recording is played back within the set interval. If the user can hear the recording within the interval, the audio devices and network connection are working properly.

    @@ -53,11 +53,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita index 8c3f8f9d6d0..ad5d359f5f3 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. - + @@ -21,8 +21,8 @@ int StartEchoTest(const FEchoTestConfiguration& config);     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 @@ -30,7 +30,7 @@ int StartEchoTest(const FEchoTestConfiguration& config);

    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.

    @@ -39,14 +39,14 @@ int StartEchoTest(const FEchoTestConfiguration& config);     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_startlastmileprobetest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita index ec4a5954e71..dbd8db1f7e4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita @@ -20,7 +20,7 @@ public abstract int StartLastmileProbeTest(LastmileProbeConfig config); abstract startLastmileProbeTest(config: LastmileProbeConfig): number; Future<void> startLastmileProbeTest(LastmileProbeConfig config); -

    +

    Details @@ -47,11 +47,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita index 8d459a06dbc..ccdc379c4d2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita @@ -25,7 +25,7 @@ config: LocalTranscoderConfiguration ): number;     Future<void> startLocalVideoTranscoder(LocalTranscoderConfiguration config); -

    +

    Details @@ -39,16 +39,16 @@
  • On Android and iOS platforms, it supports video streams captured by up to 2 cameras (the device itself needs to support dual cameras or supports external cameras) + 1 screen sharing stream.
  • On the Android platform, it supports up to 2 video streams captured by cameras (the device itself needs to support dual cameras or support external cameras) + 1 screen sharing stream.
  • On the iOS platform, it supports up to 2 video streams captured by cameras (the device itself needs to support dual cameras or support external cameras) + 1 screen sharing stream.
    • -
  • If you need to mix the locally collected video streams, you need to call this method after or .
    • -
  • If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in to when calling or .
    • +
  • If you need to mix the locally collected video streams, you need to call this method after or .
    • +
  • If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in to when calling or .
    • Applicable scenarios

    You can enable the local video mixing function in scenarios such as remote conferences, live streaming, and online education, which allows users to view and manage multiple videos more conveniently, and supports portrait-in-picture effect and other functions.

    The following is a typical use case for implementing the portrait-in-picture effect:

      -
    1. Call , and set the custom background image to , that is, separate the portrait and the background in the video captured by the camera.
      2. -
    2. Call to start capturing the screen sharing video stream.
      3. +
    3. Call , and set the custom background image to , that is, separate the portrait and the background in the video captured by the camera.
      4. +
    4. Call to start capturing the screen sharing video stream.
    5. Call this method and set the video source for capturing portraits as one of the video sources participating in the local video mixing, and the portrait picture-invideo mixing can be added in the mixed image video.When configuring the local video mixing, it is necessary to ensure that the layer number of the video stream capturing the portrait is greater than the layer number of the screen sharing stream. Otherwise, the portrait will be covered by the screen sharing and will not be displayed in the final mixed video stream.

    @@ -63,11 +63,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita index 60f11790b07..2c352947bff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startmediarenderingtracing.dita @@ -1,12 +1,12 @@ - <ph keyref="startMediaRenderingTracing"/> + <ph keyref="startMediaRenderingTracing" /> Enables tracing the video frame rendering process. - + @@ -19,7 +19,7 @@ abstract startMediaRenderingTracing(): number; public abstract int StartMediaRenderingTracing(); abstract startMediaRenderingTracing(): number; - Future<void> startMediaRenderingTracing();

    + Future<void> startMediaRenderingTracing();

    Details @@ -29,7 +29,7 @@
    v4.1.1
    -

    The SDK starts tracing the rendering status of the video frames in the channel from the moment this method is successfully called and reports information about the event through the callback.

    +

    The SDK starts tracing the rendering status of the video frames in the channel from the moment this method is successfully called and reports information about the event through the callback.

    • By default, the SDK starts tracing the video rendering event automatically when the local user successfully joins the channel. You can call this method at an appropriate time according to the actual application scenario to customize the tracing process.
      • @@ -37,16 +37,16 @@
    Applicable scenarios -

    Agora recommends that you use this method in conjunction with the UI settings (such as buttons and sliders) in your app to improve the user experience. For example, call this method when the user clicks the Join Channel button, and then get the indicators in the video frame rendering process through the callback, so as to optimize the indicators accordingly.

    +

    Agora recommends that you use this method in conjunction with the UI settings (such as buttons and sliders) in your app to improve the user experience. For example, call this method when the user clicks the Join Channel button, and then get the indicators in the video frame rendering process through the callback, so as to optimize the indicators accordingly.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        -
      • -7: The method is called before is initialized.
        • +
      • < 0: Failure. See for details and resolution suggestions.
          +
        • -7: The method is called before is initialized.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita index 327c9dd1138..0d8b3f40838 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_startpreview.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita index faa592999fb..4ad57b524ab 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita @@ -37,7 +37,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita index 9d6c920cabe..21696b2f81d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview2.dita @@ -24,7 +24,7 @@ abstract startPreview(sourceType?: VideoSourceType): number; Future<void> startPreview( {VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary}); -

    +

    Details @@ -50,11 +50,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index e2029a20c4c..47d45b307db 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 33c5ab38a7b..c57b62d481f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita @@ -1,12 +1,12 @@ - <ph keyref="startRtmpStreamWithTranscoding"/> + <ph keyref="startRtmpStreamWithTranscoding" /> Starts Media Push and sets the transcoding configuration. - + @@ -27,19 +27,19 @@ ): number;     Future<void> startRtmpStreamWithTranscoding( {required String url, required LiveTranscoding transcoding}); -

    +

    Details

    Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

    You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.

    -

    Under one Agora project, the maximum number of concurrent tasks to push media streams is 200 by default. If you need a higher quota, contact .

    -

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    +

    Under one Agora project, the maximum number of concurrent tasks to push media streams is 200 by default. If you need a higher quota, contact .

    +

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    • Call this method after joining a channel.
    • Only hosts in the LIVE_BROADCASTING profile can call this method.
      • -
    • If you want to retry pushing streams after a failed push, make sure to call first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
      • +
    • If you want to retry pushing streams after a failed push, make sure to call first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
    Parameters @@ -51,13 +51,13 @@ transcoding -

    The transcoding configuration for Media Push. See .

    +

    The transcoding configuration for Media Push. See .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        @@ -67,4 +67,4 @@
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index b5c50c68666..b76fd21f7ba 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. - + @@ -24,32 +24,32 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);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 @@ -58,12 +58,12 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);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.
        @@ -71,4 +71,4 @@ int StartScreenCapture(const FScreenCaptureParameters2& captureParams);
    - + \ 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 475d6fceba8..e1ca2efb141 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita @@ -24,11 +24,11 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC 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 @@ -38,15 +38,15 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
    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 @@ -54,10 +54,10 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC 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).
    •      @@ -66,13 +66,13 @@ int StartScreenCaptureBySourceType(EVIDEO_SOURCE_TYPE sourceType, const FScreenC
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 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 2be6a7e3e8e..47529e1f485 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 561c678ed90..4f726ace1f2 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 66437db7cbb..870b6788d9e 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 43b61fef975..6d476aac046 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopalleffects.dita @@ -22,14 +22,14 @@ public abstract int StopAllEffects(); abstract stopAllEffects(): number; Future<void> stopAllEffects(); -

      +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita index b5ba93cad0c..52bada10f80 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiomixing.dita @@ -20,18 +20,18 @@ public abstract int StopAudioMixing(); abstract stopAudioMixing(): number; Future<void> stopAudioMixing(); -

    +

    Details

    This method stops the audio mixing. Call this method when you are in a channel.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita index dc0def1d2f8..a5cde9c4c7b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita @@ -20,14 +20,14 @@ public abstract int StopAudioRecording(); abstract stopAudioRecording(): number; Future<void> stopAudioRecording(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita index 5a0b4d1d315..ff302b73aa8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopcameracapture.dita @@ -19,8 +19,8 @@ abstract stopCameraCapture(sourceType: VideoSourceType): number; public abstract int StopCameraCapture(VIDEO_SOURCE_TYPE sourceType); abstract stopCameraCapture(sourceType: VideoSourceType): number; - Future<void> stopCameraCapture(VideoSourceType sourceType); -

    + Future<void> stopCameraCapture(VideoSourceType sourceType); +

    Details @@ -31,7 +31,7 @@

    After calling to start capturing video through one or more cameras, you can call this method and set the sourceType parameter to stop the capture from the specified cameras.

    - On the iOS platform, if you want to disable multi-camera capture, you need to call after calling this method and set enabled to . + On the iOS platform, if you want to disable multi-camera capture, you need to call after calling this method and set enabled to . If you are using the local video mixing function, calling this method can cause the local video mixing to be interrupted.
    @@ -39,16 +39,16 @@ sourceType - The type of the video source. See . + The type of the video source. See .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita index d555c9abfef..81b81cebe60 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopchannelmediarelay.dita @@ -20,18 +20,18 @@ public abstract int StopChannelMediaRelay(); abstract stopChannelMediaRelay(): number; Future<void> stopChannelMediaRelay(); -

    +

    Details

    After a successful method call, the SDK triggers the callback. If the callback reports (0) and (0), the host successfully stops the relay.

    If the method call fails, the SDK triggers the callback with the (2) or (8) status code. You can call the method to leave the channel, and the media stream relay automatically stops.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita index d836051cba0..2a158a4ffe8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopdirectcdnstreaming.dita @@ -20,11 +20,11 @@ abstract stopDirectCdnStreaming(): number; Future<void> stopDirectCdnStreaming();
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita index 2da5565d943..1f0e7cf2425 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopechotest.dita @@ -20,11 +20,11 @@ public abstract int StopEchoTest(); abstract stopEchoTest(): number; Future<void> stopEchoTest(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita index c5183d5565b..5f8f88f6bf1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita @@ -22,7 +22,7 @@ public abstract int StopEffect(int soundId); abstract stopEffect(soundId: number): number; Future<void> stopEffect(int soundId); -

      +

    Parameters @@ -33,11 +33,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita index 6b2e62a71e0..26d6fb21b12 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoplastmileprobetest.dita @@ -20,14 +20,14 @@ public abstract int StopLastmileProbeTest(); abstract stopLastmileProbeTest(): number; Future<void> stopLastmileProbeTest(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita index a5794e4536c..e2fa9d09bee 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoplocalvideotranscoder.dita @@ -21,20 +21,20 @@ public abstract int StopLocalVideoTranscoder(); abstract stopLocalVideoTranscoder(): number; Future<void> stopLocalVideoTranscoder(); -

    +

    Details

    After calling , call this method if you want to stop the local video mixing.

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview.dita index 6dd46a81b4a..6f741700de0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview.dita @@ -30,7 +30,7 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita index 3648859eccc..9191c04f838 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoppreview2.dita @@ -24,7 +24,7 @@ int StopPreview(EVIDEO_SOURCE_TYPE sourceType = EVIDEO_SOURCE_TYPE::VIDEO_SOURC abstract stopPreview(sourceType?: VideoSourceType): number; Future<void> stopPreview( {VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary}); -

    +

    Details @@ -46,12 +46,12 @@ int StopPreview(EVIDEO_SOURCE_TYPE sourceType = EVIDEO_SOURCE_TYPE::VIDEO_SOURC
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita index fef98eab471..cc374d5ff54 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoprhythmplayer.dita @@ -20,18 +20,18 @@ public abstract int StopRhythmPlayer(); abstract stopRhythmPlayer(): number; Future<void> stopRhythmPlayer(); -

    +

    Details

    After calling , you can call this method to disable the virtual metronome.

    This method is for Android and iOS only.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita index bc68ca1bad3..d9d728892cd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stoprtmpstream.dita @@ -1,12 +1,12 @@ - <ph keyref="stopRtmpStream"/> + <ph keyref="stopRtmpStream" /> Stops pushing media streams to a CDN. - + @@ -20,28 +20,28 @@ public abstract int StopRtmpStream(string url); abstract stopRtmpStream(url: string): number; Future<void> stopRtmpStream(String url); -

    +

    Details

    Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

    You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times.

    -

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    +

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    Parameters - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita index a096be04047..a966750da53 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita @@ -25,14 +25,14 @@ int StopScreenCapture();     public abstract int StopScreenCapture(); abstract stopScreenCapture(): number; Future<void> stopScreenCapture(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita index 1f744618688..35a76cd069d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture2.dita @@ -21,9 +21,9 @@ int StopScreenCapture(EVIDEO_SOURCE_TYPE sourceType);     abstract stopScreenCaptureBySourceType(sourceType: VideoSourceType): number; public abstract int StopScreenCapture(VIDEO_SOURCE_TYPE sourceType); - - Future<void> stopScreenCaptureBySourceType(VideoSourceType sourceType); -

    + + Future<void> stopScreenCaptureBySourceType(VideoSourceType sourceType); +

    Details @@ -33,26 +33,26 @@ int StopScreenCapture(EVIDEO_SOURCE_TYPE sourceType);
    v4.2.0
    -

    After calling to start capturing video from one or more screens, you can call this method and set the sourceType parameter to stop capturing from the specified screens.

    +

    After calling to start capturing video from one or more screens, you can call this method and set the sourceType parameter to stop capturing from the specified screens.

    • This method applies to the macOS and Windows only.
      • -
    • If you call , , or to start screen capure, Agora recommends that you call instead to stop the capture.
      • -
    • If you call or to start screen capture, Agora recommends that you call to stop the capture and do not use this one.
     +
  • If you call , , or to start screen capure, Agora recommends that you call instead to stop the capture.
    • +
  • If you call or to start screen capture, Agora recommends that you call to stop the capture and do not use this one.
    • Parameters sourceType - The type of the video source. See . + The type of the video source. See .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita index c94996cd9ef..e79666bbc03 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchcamera.dita @@ -20,20 +20,20 @@ public abstract int SwitchCamera(); abstract switchCamera(): number; Future<void> switchCamera(); -

    +

    Details
    • This method is for Android and iOS only.
      • -
    • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
     +
  • This method must be called after the camera is successfully enabled, that is, after the SDK triggers the callback and returns the local video state as (1).
    • - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita index 58b99d92491..7be44f7dd63 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita @@ -1,12 +1,12 @@ - <ph keyref="switchChannel1"/> + <ph keyref="switchChannel1" /> Switches to a different channel. - + @@ -16,16 +16,16 @@ public abstract int switchChannel(String token, String channelName); -(int)switchChannel:(NSString* _Nonnull)token channelName:(NSString* _Nonnull)channelName; virtual int switchChannel(const char* token, const char* channel) = 0; - - - - -

    + + + + +

    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.

    @@ -35,10 +35,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 used for creating the token is the same App ID used by the method for initializing the RTC engine.

    + Ensure that the App ID used for creating the token is the same App ID used by the method for initializing the RTC engine.

    @@ -49,7 +49,7 @@
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
    • -
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    • +
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    •  @@ -58,7 +58,7 @@ 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.
          • @@ -68,4 +68,4 @@
    -     + \ No newline at end of file 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 e007a0ce2d5..62ab2d0500d 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_takesnapshot.dita b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita index 1affbe77df2..9dacaf5e938 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita @@ -19,8 +19,8 @@ abstract takeSnapshot(uid: number, filePath: string): number; public abstract int TakeSnapshot(uint uid, string filePath); abstract takeSnapshot(uid: number, filePath: string): number; - Future<void> takeSnapshot({required int uid, required String filePath}); -

    + Future<void> takeSnapshot({required int uid, required String filePath}); +

    Details @@ -30,7 +30,7 @@
    • Call this method after joining a channel.
      • -
    • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
      • +
    • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
    • If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
    @@ -44,20 +44,20 @@ filePath

    The local path (including filename extensions) of the snapshot. For example:

      -
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg
      • +
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpg
    • iOS: /App Sandbox/Library/Caches/example.jpg
    • macOS: ～/Library/Logs/example.jpg
      • -
    • Android: /storage/emulated/0/Android/data/<package name>/files/example.jpg
      • +
    • Android: /storage/emulated/0/Android/data/<package name>/files/example.jpg
    Ensure that the path you specify exists and is writable.
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita index dbaa9b750ed..27f3c056839 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unloadalleffects.dita @@ -21,14 +21,14 @@ public abstract int UnloadAllEffects(); abstract unloadAllEffects(): number; Future<void> unloadAllEffects(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita index 9d0791e7e75..02038fb2a0e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unloadeffect.dita @@ -22,7 +22,7 @@ public abstract int UnloadEffect(int soundId); abstract unloadEffect(soundId: number): number; Future<void> unloadEffect(int soundId); -

    +

    Parameters @@ -33,11 +33,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita index b86c48404a1..a8a993c6cb4 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 b551f626400..552f83d5e4f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita @@ -1,34 +1,34 @@ - <ph keyref="unregisterAudioFrameObserver"/> + <ph keyref="unregisterAudioFrameObserver" /> Unregisters an audio frame observer. - +

    - - - - + + + + public abstract int UnRegisterAudioFrameObserver(); - - -

    + + +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita index 3450e0ecff0..6a0ea649384 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudiospectrumobserver.dita @@ -24,7 +24,7 @@ observer: IAudioSpectrumObserver ): number;     void unregisterAudioSpectrumObserver(AudioSpectrumObserver observer); -

    +

    Details @@ -40,11 +40,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita index 16676e7dc56..e0265c74919 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregistermediametadataobserver.dita @@ -27,7 +27,7 @@ ): number;     void unregisterMediaMetadataObserver( {required MetadataObserver observer, required MetadataType type}); -

    +

    Parameters @@ -43,11 +43,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita index eb990775d65..dc14bea9785 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita @@ -20,7 +20,7 @@ public abstract int UpdateChannelMediaOptions(ChannelMediaOptions options); abstract updateChannelMediaOptions(options: ChannelMediaOptions): number; Future<void> updateChannelMediaOptions(ChannelMediaOptions options); -

    +

    Parameters @@ -32,8 +32,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita index 6eeb917eed7..be50c5d2e4f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediarelay.dita @@ -26,7 +26,7 @@ ): number; Future<void> updateChannelMediaRelay( ChannelMediaRelayConfiguration configuration); -

        +

    Details @@ -50,11 +50,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita index 851d8756aa9..ac1fa0fe6a7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatelocaltranscoderconfiguration.dita @@ -26,12 +26,12 @@ ): number;     Future<void> updateLocalTranscoderConfiguration( LocalTranscoderConfiguration config); -

    +

    Details

    After calling , call this method if you want to update the local video mixing configuration.

    - If you want to update the video source type used for local video mixing, such as adding a second camera or screen to capture video, you need to call this method after or . + If you want to update the video source type used for local video mixing, such as adding a second camera or screen to capture video, you need to call this method after or .
    Parameters @@ -42,11 +42,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita index 48123e26824..da95b8212ab 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatepreloadchanneltoken.dita @@ -1,12 +1,12 @@ - <ph keyref="updatePreloadChannelToken"/> + <ph keyref="updatePreloadChannelToken" /> Updates the wildcard token for preloading channels. - + @@ -19,7 +19,7 @@ abstract updatePreloadChannelToken(token: string): number; public abstract int UpdatePreloadChannelToken(string token); abstract updatePreloadChannelToken(token: string): number; - Future<void> updatePreloadChannelToken(String token);

    + Future<void> updatePreloadChannelToken(String token);

    Details @@ -44,13 +44,13 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    • -2: The parameter is invalid. For example, the token is invalid. You need to pass in a valid parameter and join the channel again.
    • -7: The object has not been initialized. You need to initialize the object before calling this method.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita index cade12cd0bf..b3fae7fe41f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatertmptranscoding.dita @@ -1,12 +1,12 @@ - <ph keyref="updateRtmpTranscoding"/> + <ph keyref="updateRtmpTranscoding" /> Updates the transcoding configuration. - + @@ -20,27 +20,27 @@ public abstract int UpdateRtmpTranscoding(LiveTranscoding transcoding); abstract updateRtmpTranscoding(transcoding: LiveTranscoding): number; Future<void> updateRtmpTranscoding(LiveTranscoding transcoding); -

    +

    Details

    Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

    -

    After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the callback after the transcoding configuration is updated.

    +

    After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the callback after the transcoding configuration is updated.

    Parameters - - + +
    -
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    +
    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita index c7f30817964..bed5ccfe2d9 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. -
    2. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.
      3. +
    3. Call this method, and set captureAudio to .
      4. +
    4. 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 1c4876dc376..3560362e7fc 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 6007640f121..05a7d6d7c28 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 7c91dda583c..b472c22b521 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 6a9182ee8bd..94f18606eb7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_uploadlogfile.dita @@ -20,7 +20,7 @@ public abstract string UploadLogFile(); Future<void> uploadLogFile(String requestId); -

    +

    Details @@ -42,8 +42,8 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita index 3ed8f1fae47..d52376c1fc9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_addpublishstreamurlex.dita @@ -30,7 +30,7 @@ {required String url, required bool transcodingEnabled, required RtcConnection connection}); -

        +

    Details @@ -60,11 +60,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
        +
      • < 0: Failure. See for details and resolution suggestions.
        • -2: Invalid parameter, usually an empty URL or a string with a length of 0.
        • -7: The engine is not initialized when streaming.
        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita index 6c1861782bf..ab23b96b7fd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_addvideowatermarkex.dita @@ -36,7 +36,7 @@ {required String watermarkUrl, required WatermarkOptions options, required RtcConnection connection}); -

        +

    Details @@ -71,11 +71,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita index c7a9fe70cc4..d6fcbc3dab9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita @@ -1,12 +1,12 @@ - <ph keyref="adjustUserPlaybackSignalVolumeEx"/> + <ph keyref="adjustUserPlaybackSignalVolumeEx" /> Adjusts the playback signal volume of a specified remote user. - + @@ -30,11 +30,11 @@ volume: number, connection: RtcConnection ): number;     - Future<void> adjustUserPlaybackSignalVolumeEx( + Future<void> adjustUserPlaybackSignalVolumeEx( {required int uid, required int volume, required RtcConnection connection}); -

    +

    Details @@ -54,24 +54,24 @@ Parameters - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita index dd4a7f9e94b..d2bd699b5d3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_clearvideowatermarkex.dita @@ -20,7 +20,7 @@ public abstract int ClearVideoWatermarkEx(RtcConnection connection); abstract clearVideoWatermarkEx(connection: RtcConnection): number; Future<void> clearVideoWatermarkEx(RtcConnection connection); -

    +

    Parameters @@ -31,11 +31,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index d1acd0bda22..6f090bef4b4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -32,7 +32,7 @@ ): number;     Future<int> createDataStreamEx( {required DataStreamConfig config, required RtcConnection connection}); -

    +

    Details @@ -60,7 +60,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_enableaudiovolumeindicationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita index 66b3f50b966..59d57a642c7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita @@ -1,12 +1,12 @@ - <ph keyref="enableAudioVolumeIndicationEx"/> - + <ph keyref="enableAudioVolumeIndicationEx" /> + - + @@ -33,43 +33,43 @@ reportVad: boolean, connection: RtcConnection ): number;     - Future<void> enableAudioVolumeIndicationEx( + Future<void> enableAudioVolumeIndicationEx( {required int interval, required int smooth, required bool reportVad, required RtcConnection connection}); -

    +

    Details -

    This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Once you call this method and users send streams in the channel, the SDK triggers the callback at the time interval set in this method.

    +

    This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Once you call this method and users send streams in the channel, the SDK triggers the callback at the time interval set in this method.

    Parameters - - + + - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita index 061ab37d51d..8b12d6d92b1 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enablecontentinspectex.dita @@ -1,12 +1,12 @@ - <ph keyref="enableContentInspectEx"/> + <ph keyref="enableContentInspectEx" /> Enables or disables video screenshot and upload. - + @@ -17,8 +17,8 @@ boolean enabled, ContentInspectConfig config, RtcConnection connection);     - (int)enableContentInspectEx:(BOOL)enabled config:(AgoraContentInspectConfig* _Nonnull)config connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(enableContentInspectEx(_:config:connection:)); virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &config, const RtcConnection& connection) = 0; - - + + abstract enableContentInspectEx( enabled: boolean, config: ContentInspectConfig, @@ -37,31 +37,31 @@
    v4.2.3
    -

    This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

    - Before calling this method, ensure that you have contacted to activate the video screenshot upload service. +

    This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in . After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.

    + Before calling this method, ensure that you have contacted to activate the video screenshot upload service.
    Parameters - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita index b041d0f73ce..99f9e75e4a4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enabledualstreammodeex.dita @@ -1,12 +1,12 @@ - <ph keyref="enableDualStreamModeEx"/> + <ph keyref="enableDualStreamModeEx" /> Enables or disables dual-stream mode on the sender side. - + @@ -31,11 +31,11 @@ streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number;     - Future<void> enableDualStreamModeEx( + Future<void> enableDualStreamModeEx( {required bool enabled, required SimulcastStreamConfig streamConfig, required RtcConnection connection}); -

    +

    Details @@ -45,31 +45,31 @@
    v4.0.1
    -

    -

    +

    +

    This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.

    Parameters - - + + - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita index 9093cae5790..e3c29fc85e2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_enableloopbackrecordingex.dita @@ -1,19 +1,19 @@ - <ph keyref="enableLoopbackRecordingEx"/> + <ph keyref="enableLoopbackRecordingEx" /> Enables loopback audio capturing. - +

    - + - (int)enableLoopbackRecordingEx:(BOOL)enabled deviceName:(NSString* _Nullable)deviceName connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(enableLoopbackRecordingEx(_:deviceName:connection:)); @@ -33,7 +33,7 @@ {required RtcConnection connection, required bool enabled, String? deviceName}); -

    +

    Details @@ -48,27 +48,27 @@ Parameters - - + + enabled Sets whether to enable loopback audio capture:
      -
    • : Enable loopback audio capturing.
      • -
    • : (Default) Disable loopback audio capturing.
      • +
    • : Enable loopback audio capturing.
      • +
    • : (Default) Disable loopback audio capturing.
         - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index a66de42b538..4d296e36cdb 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_leavechannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita index 3067f364702..f690d1d4c6e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex.dita @@ -1,12 +1,12 @@ - <ph keyref="leaveChannelEx"/> + <ph keyref="leaveChannelEx" /> Leaves a channel. - + @@ -22,40 +22,40 @@ options?: LeaveChannelOptions ): number; public abstract int LeaveChannelEx(RtcConnection connection); - - -

    + + +

    Details

    This method lets the user leave the channel, for example, by hanging up or exiting the call.

    -

    After calling to join the channel, this method must be called to end the call before starting the next call.

    +

    After calling to join the channel, this method must be called to end the call before starting the next call.

    This method can be called whether or not a call is currently in progress. This method releases all resources related to the session.

    -

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    +

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    +

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    +

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

      -
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • -
    • If you want to leave the channels that you joined by calling and , call the method.
      • +
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • +
    • If you want to leave the channels that you joined by calling and , call the method.
    Parameters - - + + - - + +
    Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita index 96ad933e92b..d399f84729d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita @@ -1,12 +1,12 @@ - <ph keyref="leaveChannelEx2"/> + <ph keyref="leaveChannelEx2" /> Sets channel options and leaves the channel. - + @@ -29,29 +29,29 @@ int LeaveChannelEx(const FRtcConnection& connection, const FLeaveChannelOpti connection: RtcConnection, options?: LeaveChannelOptions ): number; - Future<void> leaveChannelEx( + Future<void> leaveChannelEx( {required RtcConnection connection, LeaveChannelOptions? options}); -

    +

    Details

    This method lets the user leave the channel, for example, by hanging up or exiting the call.

    -

    After calling to join the channel, this method must be called to end the call before starting the next call.

    +

    After calling to join the channel, this method must be called to end the call before starting the next call.

    This method can be called whether or not a call is currently in progress. This method releases all resources related to the session.

    -

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    -

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

    +

    This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    +

    Calling this method does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the callback.

    +

    After actually leaving the channel, the local user triggers the callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the callback.

      -
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • -
    • If you want to leave the channels that you joined by calling and , call the method.
      • +
    • If you call immediately after calling this method, the SDK does not trigger the callback.
      • +
    • If you want to leave the channels that you joined by calling and , call the method.
    Parameters - - + + options @@ -62,20 +62,20 @@ int LeaveChannelEx(const FRtcConnection& connection, const FLeaveChannelOpti
    v4.1.0
    -

    The options for leaving the channel. See .

    - This parameter only supports the stopMicrophoneRecording member in the settings; setting other members does not take effect. +

    The options for leaving the channel. See .

    + This parameter only supports the stopMicrophoneRecording member in the settings; setting other members does not take effect.     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita index 9b6a96a577f..1ed9636a37f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteAllRemoteAudioStreamsEx"/> + <ph keyref="muteAllRemoteAudioStreamsEx" /> Stops or resumes subscribing to the audio streams of all remote users. - + @@ -26,9 +26,9 @@ mute: boolean, connection: RtcConnection ): number;     - Future<void> muteAllRemoteAudioStreamsEx( + Future<void> muteAllRemoteAudioStreamsEx( {required bool mute, required RtcConnection connection}); -

    +

    Details @@ -36,7 +36,7 @@
    • Call this method after joining a channel.
      • -
    • If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
      • +
    • If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
    • See recommended settings in Set the Subscribing State.
    @@ -47,22 +47,22 @@ mute

    Whether to stop subscribing to the audio streams of all remote users:

      -
    • : Stops subscribing to the audio streams of all remote users.
      • -
    • : (Default) Subscribes to the audio streams of all remote users by default.
      • +
    • : Stops subscribing to the audio streams of all remote users.
      • +
    • : (Default) Subscribes to the audio streams of all remote users by default.

     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita index 64c4bb3a1b6..3e52b315d82 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteAllRemoteVideoStreamsEx"/> + <ph keyref="muteAllRemoteVideoStreamsEx" /> Stops or resumes subscribing to the video streams of all remote users. - + @@ -26,7 +26,7 @@ mute: boolean, connection: RtcConnection ): number;     - Future<void> muteAllRemoteVideoStreamsEx( + Future<void> muteAllRemoteVideoStreamsEx( {required bool mute, required RtcConnection connection});

    @@ -37,27 +37,27 @@
    v4.1.0
    -

    +

    Parameters - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita index d264fb56abb..052d211a70d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteLocalAudioStreamEx"/> + <ph keyref="muteLocalAudioStreamEx" /> Stops or resumes publishing the local audio stream. - + @@ -25,14 +25,14 @@ mute: boolean, connection: RtcConnection ): number;     - Future<void> muteLocalAudioStreamEx( + Future<void> muteLocalAudioStreamEx( {required bool mute, required RtcConnection connection}); -

    +

    Details This method does not affect any ongoing audio recording, because it does not disable the audio capture device. -

    A successful call of this method triggers the and callbacks on the remote client.

    +

    A successful call of this method triggers the and callbacks on the remote client.

    Parameters @@ -41,22 +41,22 @@ mute

    Whether to stop publishing the local audio stream:

      -
    • : Stops publishing the local audio stream.
      • -
    • : (Default) Resumes publishing the local audio stream.
      • +
    • : Stops publishing the local audio stream.
      • +
    • : (Default) Resumes publishing the local audio stream.

     - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita index 49576c9a38e..240089932b3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita @@ -1,12 +1,12 @@ - <ph keyref="muteLocalVideoStreamEx"/> + <ph keyref="muteLocalVideoStreamEx" /> Stops or resumes publishing the local video stream. - + @@ -25,7 +25,7 @@ mute: boolean, connection: RtcConnection ): number;     - Future<void> muteLocalVideoStreamEx( + Future<void> muteLocalVideoStreamEx( {required bool mute, required RtcConnection connection});

    @@ -46,21 +46,21 @@ Parameters - - + + - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita index 2fb250268e8..a988a16b36c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita @@ -33,7 +33,7 @@ {required int uid, required bool mute, required RtcConnection connection});     -

    +

    DetailsThis method is used to stops or resumes receiving the audio stream of a specified user. You can call this method before or after joining a channel. If a user leaves a channel, the settings in this method become invalid.
    @@ -60,11 +60,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita index cbc7998c8ca..3e8a17f3272 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita @@ -33,7 +33,7 @@ {required int uid, required bool mute, required RtcConnection connection});     -

    +

    Details @@ -64,11 +64,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita index f95eb614c88..42dba0088d5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_pauseallchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="pauseAllChannelMediaRelayEx"/> + <ph keyref="pauseAllChannelMediaRelayEx" /> Pauses the media stream relay to all target channels. - + @@ -19,27 +19,27 @@ abstract pauseAllChannelMediaRelayEx(connection: RtcConnection): number; public abstract int PauseAllChannelMediaRelayEx(RtcConnection connection); abstract pauseAllChannelMediaRelayEx(connection: RtcConnection): number; - Future<void> pauseAllChannelMediaRelayEx(RtcConnection connection); -

    + Future<void> pauseAllChannelMediaRelayEx(RtcConnection connection); +

    Details -

    After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call .

    - Call this method after .
    +

    After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call .

    + Call this method after .
    Parameters - - + +
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita index 333405d15ee..8f978ca81c0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_resumeallchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="resumeAllChannelMediaRelayEx"/> + <ph keyref="resumeAllChannelMediaRelayEx" /> Resumes the media stream relay to all target channels. - + @@ -19,13 +19,13 @@ abstract resumeAllChannelMediaRelayEx(connection: RtcConnection): number; public abstract int ResumeAllChannelMediaRelayEx(RtcConnection connection); abstract resumeAllChannelMediaRelayEx(connection: RtcConnection): number; - Future<void> resumeAllChannelMediaRelayEx(RtcConnection connection); -

    + Future<void> resumeAllChannelMediaRelayEx(RtcConnection connection); +

    Details -

    After calling the method, you can call this method to resume relaying media streams to all destination channels.

    - Call this method after . +

    After calling the method, you can call this method to resume relaying media streams to all destination channels.

    + Call this method after .
    Parameters @@ -36,11 +36,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita index 9fbd334ec47..1cc1821e513 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita @@ -29,7 +29,7 @@ required Uint8List data, required int length, required RtcConnection connection});     -

    +

    Details @@ -68,11 +68,11 @@ A failed method call triggers the callbac
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 38bf89e1b44..d2c637bb7fe 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 a492558fe86..10ea9cc99a5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita @@ -34,7 +34,7 @@ mirrorMode: VideoMirrorModeType, connection: RtcConnection ): number;     - Future<void> setRemoteRenderModeEx( + Future<void> setRemoteRenderModeEx( {required int uid, required RenderModeType renderMode, required VideoMirrorModeType mirrorMode, @@ -45,7 +45,7 @@

    After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees.

    • Call this method after initializing the remote view by calling the method.
      • -
    • Call this method after rendering the or component corresponding to the remote user ID.
      • +
    • Call this method after rendering the or component corresponding to the remote user ID.
    • During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user.

    @@ -80,11 +80,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita index 300af049069..bd3c193f7d6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteVideoStreamTypeEx"/> + <ph keyref="setRemoteVideoStreamTypeEx" /> Sets the stream type of the remote video. - + @@ -29,15 +29,15 @@ streamType: VideoStreamType, connection: RtcConnection ): number;     - Future<void> setRemoteVideoStreamTypeEx( + Future<void> setRemoteVideoStreamTypeEx( {required int uid, required VideoStreamType streamType, required RtcConnection connection}); -

    +

    Details -

    Under limited network conditions, if the publisher has not disabled the dual-stream mode using (), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

    +

    Under limited network conditions, if the publisher has not disabled the dual-stream mode using (), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.

    By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.

    The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.

    @@ -51,7 +51,7 @@ streamType -

    The video stream type: .

    +

    The video stream type: .

    The video stream type:

    • 0: High-quality video stream.
    • 1: Low-quality video stream.
      • @@ -59,16 +59,16 @@ - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita index c689a377900..832b782c763 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevoicepositionex.dita @@ -38,7 +38,7 @@ required double pan, required double gain, required RtcConnection connection}); -

      +

      Details @@ -74,11 +74,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita index e1f9bf80d3b..9f1b3baf402 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioallowlistex.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeAudioAllowlistEx"/> - + <ph keyref="setSubscribeAudioAllowlistEx" /> + - + @@ -27,36 +27,36 @@ uidNumber: number, connection: RtcConnection ): number;       - Future<void> setSubscribeAudioAllowlistEx( - {required List<int> uidList, + Future<void> setSubscribeAudioAllowlistEx( + {required List<int> uidList, required int uidNumber, required RtcConnection connection}); -

      +

      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita index f6810d29968..efd6a951cea 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribeaudioblocklistex.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeAudioBlocklistEx"/> - + <ph keyref="setSubscribeAudioBlocklistEx" /> + - + @@ -27,38 +27,38 @@ uidNumber: number, connection: RtcConnection ): number;       - Future<void> setSubscribeAudioBlocklistEx( - {required List<int> uidList, + Future<void> setSubscribeAudioBlocklistEx( + {required List<int> uidList, required int uidNumber, required RtcConnection connection}); -

      +

      -

      +

      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita index 0e6001d64b8..563865e1df0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoallowlistex.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeVideoAllowlistEx"/> - + <ph keyref="setSubscribeVideoAllowlistEx" /> + - + @@ -27,36 +27,36 @@ uidNumber: number, connection: RtcConnection ): number;       - Future<void> setSubscribeVideoAllowlistEx( - {required List<int> uidList, + Future<void> setSubscribeVideoAllowlistEx( + {required List<int> uidList, required int uidNumber, required RtcConnection connection}); -

      +

      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita index 55a2abd97ec..1ad1b57b8d0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setsubscribevideoblocklistex.dita @@ -1,12 +1,12 @@ - <ph keyref="setSubscribeVideoBlocklistEx"/> - + <ph keyref="setSubscribeVideoBlocklistEx" /> + - + @@ -27,36 +27,36 @@ uidNumber: number, connection: RtcConnection ): number;       - Future<void> setSubscribeVideoBlocklistEx( - {required List<int> uidList, + Future<void> setSubscribeVideoBlocklistEx( + {required List<int> uidList, required int uidNumber, required RtcConnection connection}); -

      +

      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index 2d0b34ac505..ccdf5c88e90 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 7ce1640594a..261604bf069 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 77f8a433630..607f44a70c4 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 aee8343048b..8276bc23466 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startmediarenderingtracingex.dita @@ -1,12 +1,12 @@ - <ph keyref="startMediaRenderingTracingEx"/> + <ph keyref="startMediaRenderingTracingEx" /> Enables tracing the video frame rendering process. - + @@ -19,7 +19,7 @@ abstract startMediaRenderingTracingEx(connection: RtcConnection): number; public abstract int StartMediaRenderingTracingEx(RtcConnection connection); abstract startMediaRenderingTracingEx(connection: RtcConnection): number; - Future<void> startMediaRenderingTracingEx(RtcConnection connection);

      + Future<void> startMediaRenderingTracingEx(RtcConnection connection);

      Details @@ -29,8 +29,8 @@
      v4.1.1
      -

      - +

      +

      @@ -39,17 +39,17 @@ Parameters - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index 2c84d59ad01..db1f538852e 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 6361174c581..175405fbc35 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithtranscodingex.dita @@ -1,12 +1,12 @@ - <ph keyref="startRtmpStreamWithTranscodingEx"/> + <ph keyref="startRtmpStreamWithTranscodingEx" /> Starts Media Push and sets the transcoding configuration. - + @@ -30,7 +30,7 @@ transcoding: LiveTranscoding, connection: RtcConnection ): number;       - Future<void> startRtmpStreamWithTranscodingEx( + Future<void> startRtmpStreamWithTranscodingEx( {required String url, required LiveTranscoding transcoding, required RtcConnection connection});

      @@ -45,33 +45,33 @@

      Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

      You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.

      -

      After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

      +

      After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

      • Ensure that you enable the Media Push service before using this function. For details, see the prerequisites in Media Push.
      • Call this method after joining a channel.
      • Only hosts in the LIVE_BROADCASTING profile can call this method.
        • -
      • If you want to retry pushing streams after a failed push, make sure to call first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
        • +
      • If you want to retry pushing streams after a failed push, make sure to call first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
      • < 0: Failure.
          @@ -81,4 +81,4 @@
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita index 37fa55ed39f..ffb2645ce2b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_stopchannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="stopChannelMediaRelayEx"/> + <ph keyref="stopChannelMediaRelayEx" /> Stops the media stream relay. Once the relay stops, the host quits all the target channels. - + @@ -19,7 +19,7 @@ abstract stopChannelMediaRelayEx(connection: RtcConnection): number; public abstract int StopChannelMediaRelayEx(RtcConnection connection); abstract stopChannelMediaRelayEx(connection: RtcConnection): number; - Future<void> stopChannelMediaRelayEx(RtcConnection connection);

      + Future<void> stopChannelMediaRelayEx(RtcConnection connection);

      @@ -28,23 +28,23 @@
      v4.1.0
      -

      +

      Parameters - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita index f8ea19feaca..689af605a81 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_stoprtmpstreamex.dita @@ -1,12 +1,12 @@ - <ph keyref="stopRtmpStreamEx"/> + <ph keyref="stopRtmpStreamEx" /> Stops pushing media streams to a CDN. - + @@ -20,30 +20,30 @@ abstract stopRtmpStreamEx(url: string, connection: RtcConnection): number; public abstract int StopRtmpStreamEx(string url, RtcConnection connection); abstract stopRtmpStreamEx(url: string, connection: RtcConnection): number; - Future<void> stopRtmpStreamEx( + Future<void> stopRtmpStreamEx( {required String url, required RtcConnection connection}); -

      +

      Details

      Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

      You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times.

      -

      After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

      +

      After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

      Parameters - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      -       + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita index 1405b773b72..91d04641703 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita @@ -1,12 +1,12 @@ - <ph keyref="takeSnapshotEx"/> + <ph keyref="takeSnapshotEx" /> Takes a snapshot of a video stream. - + @@ -27,45 +27,45 @@ uid: number, filePath: string ): number;       - Future<void> takeSnapshotEx( + Future<void> takeSnapshotEx( {required RtcConnection connection, required int uid, required String filePath}); -

      +

      Details -

      -

      +

      +

      The SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.

        -
      • Call this method after the method.
        • -
      • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
        • +
      • Call this method after the method.
        • +
      • When used for local video snapshots, this method takes a snapshot for the video streams specified in .
      • If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
      Parameters - - + + - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita index 3b41518c6a2..2e936e062b2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediarelayex.dita @@ -1,12 +1,12 @@ - <ph keyref="updateChannelMediaRelayEx"/> + <ph keyref="updateChannelMediaRelayEx" /> Updates the channels for media stream relay. - + @@ -26,10 +26,10 @@ configuration: ChannelMediaRelayConfiguration, connection: RtcConnection ): number;       - Future<void> updateChannelMediaRelayEx( + Future<void> updateChannelMediaRelayEx( {required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}); -

      +

      Details @@ -40,8 +40,8 @@

      After the media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method.

      -

      After a successful method call, the SDK triggers the callback with the (7) state code.

      - Call the method after successfully calling the method and receiving (, ); otherwise, the method call fails.
      +

      After a successful method call, the SDK triggers the callback with the (7) state code.

      + Call the method after successfully calling the method and receiving (, ); otherwise, the method call fails.
      Parameters @@ -49,19 +49,19 @@ channelMediaRelayConfiguration config configuration - The configuration of the media stream relay. See . + The configuration of the media stream relay. See . - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita index 194decbc946..44cff6ac1de 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_updatertmptranscodingex.dita @@ -1,12 +1,12 @@ - <ph keyref="updateRtmpTranscodingEx"/> + <ph keyref="updateRtmpTranscodingEx" /> Updates the transcoding configuration. - + @@ -27,34 +27,34 @@ transcoding: LiveTranscoding, connection: RtcConnection ): number;       - Future<void> updateRtmpTranscodingEx( + Future<void> updateRtmpTranscodingEx( {required LiveTranscoding transcoding, required RtcConnection connection}); -

      +

      Details

      Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

      -

      After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the callback after the transcoding configuration is updated.

      +

      After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the callback after the transcoding configuration is updated.

      Parameters - - + + - - + +
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_getdevice.dita b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_getdevice.dita index 1a4222a06a4..9a027766eef 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_getdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_getdevice.dita @@ -22,7 +22,7 @@ public abstract string GetDevice(); Future<String> getDevice(); -

      +

      Parameters @@ -44,7 +44,7 @@ Returns
      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.

      The information of the video capturing device.

      diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita index 922ba7635c3..d137d4473a5 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicecollection_setdevice.dita @@ -20,7 +20,7 @@ public abstract int SetDevice(string deviceIdUTF8); Future<void> setDevice(String deviceIdUTF8); -

      +

      Parameters @@ -37,11 +37,11 @@
      - <ph keyref="return-section-title"/> -

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      + <ph keyref="return-section-title" /> +

      When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      • 0: Success.
        • -
      • < 0: Failure. See for details and resolution suggestions.
        • +
      • < 0: Failure. See for details and resolution suggestions.
      - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita index 81449afcc8a..0311a7e0b68 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_getdevice.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getdevice.dita index 19dd99d9adc..efa6f080745 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getdevice.dita @@ -20,7 +20,7 @@ public abstract int GetDevice(ref string deviceIdUTF8); abstract getDevice(): string; Future<String> getDevice(); -

    +

    Details @@ -38,9 +38,9 @@ Returns
    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.

    The video capture device.

    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita index a04b328d8d5..13d6e155b03 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_numberofcapabilities.dita @@ -21,7 +21,7 @@ public abstract int NumberOfCapabilities(string deviceIdUTF8); abstract numberOfCapabilities(deviceIdUTF8: string): number; Future<void> numberOfCapabilities(String deviceIdUTF8); -

    +

    Details @@ -38,11 +38,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

      -
    • > 0: Success. Returns the number of video formats supported by this device. For example: If the specified camera supports 10 different video formats, the return value is 10.
      • -
    • ≤ 0: Failure. See for details and resolution suggestions.
      • +
    • > 0: Success. Returns the number of video formats supported by this device. For example: If the specified camera supports 10 different video formats, the return value is 10.
      • +
    • ≤ 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita index 6ab64fe1a6a..9c0b7e33bc5 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="setDevice_IVideoDeviceManager"/> + <ph keyref="setDevice_IVideoDeviceManager" /> Specifies the video capture device with the device ID. - +

    - - + + virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract setDevice(deviceIdUTF8: string): number; public abstract int SetDevice(string deviceIdUTF8); abstract setDevice(deviceIdUTF8: string): number; Future<void> setDevice(String deviceIdUTF8); -

    +

    Details @@ -33,17 +33,17 @@ deviceId deviceIdUTF8 -

    The device ID. You can get the device ID by calling .

    -

    The maximum length is .

    +

    The device ID. You can get the device ID by calling .

    +

    The maximum length is .
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
     -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita index 98c579e5c1b..62924f120cb 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_startdevicetest.dita @@ -20,7 +20,7 @@ public abstract int StartDeviceTest(view_t hwnd); abstract startDeviceTest(hwnd: any): number; Future<void> startDeviceTest(int hwnd); -

    +

    Details @@ -35,11 +35,11 @@
    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita index 1a4bd476155..a562e862da0 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_stopdevicetest.dita @@ -20,14 +20,14 @@ public abstract int StopDeviceTest(); abstract stopDeviceTest(): number; Future<void> stopDeviceTest(); -

    +

    - <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    + <ph keyref="return-section-title" /> +

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    • 0: Success.
      • -
    • < 0: Failure. See for details and resolution suggestions.
      • +
    • < 0: Failure. See for details and resolution suggestions.
    \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_monitordevicechange.dita b/en-US/dita/RTC-NG/API/api_monitordevicechange.dita index f47dd41d52b..8095e9e500f 100644 --- a/en-US/dita/RTC-NG/API/api_monitordevicechange.dita +++ b/en-US/dita/RTC-NG/API/api_monitordevicechange.dita @@ -1,26 +1,26 @@ - <ph keyref="monitorDeviceChange"/> + <ph keyref="monitorDeviceChange" /> Monitors the change of the device state. - +

    - + - (void)monitorDeviceChange:(BOOL)enabled; virtual int enableLoopbackRecording(bool enabled) = 0; - - - - -

    + + + + +

    Details @@ -34,10 +34,10 @@ enabled Whether to monitor the change of the device state:
      -
    • : Enable device state monitoring.
      • -
    • : Disable device state monitoring.
      • +
    • : Enable device state monitoring.
      • +
    • : Disable device state monitoring.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita index ad4b9b7a5e9..f30f5800980 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 e9ab1ee61bf..ec0bc49e668 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_audioframe.dita b/en-US/dita/RTC-NG/API/class_audioframe.dita index b2d55603007..22c1bf63049 100644 --- a/en-US/dita/RTC-NG/API/class_audioframe.dita +++ b/en-US/dita/RTC-NG/API/class_audioframe.dita @@ -149,7 +149,7 @@ this.buffer, this.renderTimeMs, this.avsyncType});     -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita index c553ee129d3..6e8e8f04f3c 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 3872b3cdcb8..5d4b04700a1 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 85858015949..92258cb0e41 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_channelmediainfo.dita b/en-US/dita/RTC-NG/API/class_channelmediainfo.dita index 7774cb12d30..fc9ff476778 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediainfo.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediainfo.dita @@ -1,7 +1,7 @@ - <ph keyref="ChannelMediaInfo"/> + <ph keyref="ChannelMediaInfo" /> Channel media information.
    @@ -68,10 +68,10 @@ _$ChannelMediaInfoFromJson(json); Map<String, dynamic> toJson() => _$ChannelMediaInfoToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> channelName @@ -87,4 +87,4 @@
    -     + \ 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 ece2fa32756..ada52515a71 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 1fbcf2850e8..88e2a2d6cc8 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_clientroleoptions.dita b/en-US/dita/RTC-NG/API/class_clientroleoptions.dita index 72182e04711..12359638457 100644 --- a/en-US/dita/RTC-NG/API/class_clientroleoptions.dita +++ b/en-US/dita/RTC-NG/API/class_clientroleoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="ClientRoleOptions"/> + <ph keyref="ClientRoleOptions" /> Setting of user role properties.
    @@ -50,18 +50,18 @@ _$ClientRoleOptionsFromJson(json); Map<String, dynamic> toJson() => _$ClientRoleOptionsToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> audienceLatencyLevel - The latency level of an audience member in interactive live streaming. See .
      -
    • (1): Low latency.
      • -
    • (2): (Default) Ultra low latency.
      • + The latency level of an audience member in interactive live streaming. See .
        +
      • (1): Low latency.
        • +
      • (2): (Default) Ultra low latency.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_cloudspatialaudioconfig.dita b/en-US/dita/RTC-NG/API/class_cloudspatialaudioconfig.dita index b65a3f47cc9..0eec693af9c 100644 --- a/en-US/dita/RTC-NG/API/class_cloudspatialaudioconfig.dita +++ b/en-US/dita/RTC-NG/API/class_cloudspatialaudioconfig.dita @@ -68,7 +68,7 @@ deployRegion?: number; } There are no corresponding names available -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita index 0b92b456460..71e0ebb7e66 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 29f19a46b6c..d06435fd763 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 24f02965f50..730f6a237f9 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.
    @@ -93,16 +93,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) => @@ -110,7 +110,7 @@ class ContentInspectConfig { Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this); } -

    +

    Parameters @@ -141,20 +141,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 19be6259fd0..140c40eb9b9 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,25 +56,25 @@ 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.
      • -
    • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
      • -
    • (2): Video screenshot and upload via Agora self-developed extension. SDK takes screenshots of the video stream in the channel and uploads them.
      • -
    • (3): Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them.
      • +
    • (0): (Default) This module has no actual function. Do not set to this value.
      • +
    • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
      • +
    • (2): Video screenshot and upload via Agora self-developed extension. SDK takes screenshots of the video stream in the channel and uploads them.
      • +
    • (3): Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them.

         @@ -84,4 +84,4 @@
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_directcdnstreamingmediaoptions.dita b/en-US/dita/RTC-NG/API/class_directcdnstreamingmediaoptions.dita index 40f3588fcf6..59c13143758 100644 --- a/en-US/dita/RTC-NG/API/class_directcdnstreamingmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/class_directcdnstreamingmediaoptions.dita @@ -1,7 +1,7 @@ - <ph keyref="DirectCdnStreamingMediaOptions"/> + <ph keyref="DirectCdnStreamingMediaOptions" /> The media setting options for the host.
    @@ -101,49 +101,49 @@ @JsonKey(name: 'customVideoTrackId') final int? customVideoTrackId; - factory DirectCdnStreamingMediaOptions.fromJson(Map<String, dynamic> json) => + factory DirectCdnStreamingMediaOptions.fromJson(Map<String, dynamic> json) => _$DirectCdnStreamingMediaOptionsFromJson(json); - Map<String, dynamic> toJson() => _$DirectCdnStreamingMediaOptionsToJson(this); + Map<String, dynamic> toJson() => _$DirectCdnStreamingMediaOptionsToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> publishCameraTrack Sets whether to publish the video captured by the camera:
      -
    • : Publish the video captured by the camera.
      • -
    • : (Default) Do not publish the video captured by the camera.
      • +
    • : Publish the video captured by the camera.
      • +
    • : (Default) Do not publish the video captured by the camera.
         publishMicrophoneTrack Sets whether to publish the audio captured by the microphone:
      -
    • : Publish the audio captured by the microphone.
      • -
    • : (Default) Do not publish the audio captured by the microphone.
      • +
    • : Publish the audio captured by the microphone.
      • +
    • : (Default) Do not publish the audio captured by the microphone.
         publishCustomAudioTrack Sets whether to publish the captured audio from a custom source:
      -
    • : Publish the captured audio from a custom source.
      • -
    • : (Default) Do not publish the captured audio from the custom source.
      • +
    • : Publish the captured audio from a custom source.
      • +
    • : (Default) Do not publish the captured audio from the custom source.
         publishMediaPlayerAudioTrack Sets whether to publish the audio from the media player:
      -
    • : Publish the audio from the media player.
      • -
    • : (Default) Do not publish the audio from the media player.
      • +
    • : Publish the audio from the media player.
      • +
    • : (Default) Do not publish the audio from the media player.
         publishCustomVideoTrack Sets whether to publish the captured video from a custom source:
      -
    • : Publish the captured video from a custom source.
      • -
    • : (Default) Do not publish the captured video from the custom source.
      • +
    • : Publish the captured video from a custom source.
      • +
    • : (Default) Do not publish the captured video from the custom source.
         @@ -152,8 +152,8 @@ 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.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_encodedaudioframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedaudioframeinfo.dita index dacef7ec0ff..188eb2a8b5c 100644 --- a/en-US/dita/RTC-NG/API/class_encodedaudioframeinfo.dita +++ b/en-US/dita/RTC-NG/API/class_encodedaudioframeinfo.dita @@ -119,10 +119,10 @@ @JsonKey(name: 'captureTimeMs') final int? captureTimeMs; - factory EncodedAudioFrameInfo.fromJson(Map<String, dynamic> json) => + factory EncodedAudioFrameInfo.fromJson(Map<String, dynamic> json) => _$EncodedAudioFrameInfoFromJson(json); - Map<String, dynamic> toJson() => _$EncodedAudioFrameInfoToJson(this); + Map<String, dynamic> toJson() => _$EncodedAudioFrameInfoToJson(this); }

    diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita index 5ccadbe5aa4..de51f58194c 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 78099ed1555..eaaad3657dd 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,8 +236,7 @@ class ExternalVideoFrame { Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this); }     -

    - +

    @@ -415,4 +414,4 @@ class ExternalVideoFrame {
    - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_iaudiodevicemanager.dita b/en-US/dita/RTC-NG/API/class_iaudiodevicemanager.dita index 0682d035092..b9e094a6d19 100644 --- a/en-US/dita/RTC-NG/API/class_iaudiodevicemanager.dita +++ b/en-US/dita/RTC-NG/API/class_iaudiodevicemanager.dita @@ -5,7 +5,7 @@ Audio device management methods.
    -

    provides methods for audio device testing. You can call the method to get the interface.

    +

    provides methods for audio device testing. You can call the method to get the interface.

     \ 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 fc70daee84d..3155ea39a73 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 93da02453da..f0015ba006e 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_localspatialaudioconfig.dita b/en-US/dita/RTC-NG/API/class_localspatialaudioconfig.dita index 2abcb6d4c6d..c7766c64300 100644 --- a/en-US/dita/RTC-NG/API/class_localspatialaudioconfig.dita +++ b/en-US/dita/RTC-NG/API/class_localspatialaudioconfig.dita @@ -36,7 +36,7 @@ rtcEngine?: IRtcEngine; }     There are no corresponding names available -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -48,4 +48,4 @@
    - + \ 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 8b715da6ff4..08dea2cba91 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 d12919e56c3..eb327156492 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_logconfig.dita b/en-US/dita/RTC-NG/API/class_logconfig.dita index a8b9b44f53d..8aa9bbd25c2 100644 --- a/en-US/dita/RTC-NG/API/class_logconfig.dita +++ b/en-US/dita/RTC-NG/API/class_logconfig.dita @@ -81,18 +81,18 @@

    The complete path of the log files. Ensure that the path for the log file exists and is writable. You can use this parameter to rename the log files.

    The default path is:

      -
    • Android：/storage/emulated/0/Android/data/<packagename>/files/agorasdk.log.
      • +
    • Android：/storage/emulated/0/Android/data/<packagename>/files/agorasdk.log.
    • iOS：App Sandbox/Library/caches/agorasdk.log.
    • macOS:
        -
      • If Sandbox is enabled: App Sandbox/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.
        • +
      • If Sandbox is enabled: App Sandbox/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.
      • If Sandbox is disabled: ~/Library/Logs/agorasdk.log
      • -
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log.
      • +
    • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log.

    -

    The default path is /storage/emulated/0/Android/data/<packagename>/files/agorasdk.log.

    +

    The default path is /storage/emulated/0/Android/data/<packagename>/files/agorasdk.log.

    The default path is AppSandbox/Library/caches/agorasdk.log.

    The default path is:

      -
    • If Sandbox is enabled: AppSandbox/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.
      • +
    • If Sandbox is enabled: AppSandbox/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.
    • If Sandbox is disabled: ~/Library/Logs/agorasdk.log.

     diff --git a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita index fc624f4f4f9..2c97d0962a9 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 263f15fd6fb..4ec014d350d 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 ed11668cb54..7458b43e214 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_remotevideostats.dita b/en-US/dita/RTC-NG/API/class_remotevideostats.dita index cef5d89e9d1..74ebd28506f 100644 --- a/en-US/dita/RTC-NG/API/class_remotevideostats.dita +++ b/en-US/dita/RTC-NG/API/class_remotevideostats.dita @@ -1,7 +1,7 @@ - <ph keyref="RemoteVideoStats"/> + <ph keyref="RemoteVideoStats" /> Statistics of the remote video stream.
    @@ -225,15 +225,15 @@ class RemoteVideoStats { @JsonKey(name: 'rxVideoBytes') final int? rxVideoBytes; - factory RemoteVideoStats.fromJson(Map<String, dynamic> json) => + factory RemoteVideoStats.fromJson(Map<String, dynamic> json) => _$RemoteVideoStatsFromJson(json); - Map<String, dynamic> toJson() => _$RemoteVideoStatsToJson(this); + Map<String, dynamic> toJson() => _$RemoteVideoStatsToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> uid @@ -245,7 +245,7 @@ class RemoteVideoStats {
    Deprecated:
    -
    In scenarios where audio and video are synchronized, you can get the video delay data from networkTransportDelay and jitterBufferDelay in .
    +
    In scenarios where audio and video are synchronized, you can get the video delay data from networkTransportDelay and jitterBufferDelay in .

    The video delay (ms).

    @@ -289,10 +289,10 @@ class RemoteVideoStats {     rxStreamType - The type of the video stream. See .

    + The type of the video stream. See .

      -
    • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
      • -
    • (1): Low-quality stream, that is, a low-resolution and low-bitrate video stream.
      • +
    • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
      • +
    • (1): Low-quality stream, that is, a low-resolution and low-bitrate video stream.

         @@ -323,4 +323,4 @@ class RemoteVideoStats {
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita index b9a6b03d108..ab51e60901e 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_screenaudioparameters.dita b/en-US/dita/RTC-NG/API/class_screenaudioparameters.dita index fecf04939ea..03a4d9d6fbb 100644 --- a/en-US/dita/RTC-NG/API/class_screenaudioparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screenaudioparameters.dita @@ -86,12 +86,12 @@ @JsonKey(name: 'captureSignalVolume') final int? captureSignalVolume; - factory ScreenAudioParameters.fromJson(Map<String, dynamic> json) => + factory ScreenAudioParameters.fromJson(Map<String, dynamic> json) => _$ScreenAudioParametersFromJson(json); - Map<String, dynamic> toJson() => _$ScreenAudioParametersToJson(this); + Map<String, dynamic> toJson() => _$ScreenAudioParametersToJson(this); }     -

    +

    Only available where captureAudio is .

    diff --git a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita index 6ccd550fdc9..f01c7b2938c 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_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita index 4a86e5cbd24..a18bcc92859 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 5dfd04d7014..01631aaff64 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_screenvideoparameters.dita b/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita index a40782f6b47..33d540370fd 100644 --- a/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita @@ -1,7 +1,7 @@ - <ph keyref="ScreenVideoParameters"/> + <ph keyref="ScreenVideoParameters" /> The video configuration for the shared screen stream.
    @@ -112,17 +112,17 @@ final int? bitrate; @JsonKey(name: 'contentHint') final VideoContentHint? contentHint; - factory ScreenVideoParameters.fromJson(Map<String, dynamic> json) => + factory ScreenVideoParameters.fromJson(Map<String, dynamic> json) => _$ScreenVideoParametersFromJson(json); - Map<String, dynamic> toJson() => _$ScreenVideoParametersToJson(this); + Map<String, dynamic> toJson() => _$ScreenVideoParametersToJson(this); } -

    +

    -

    Only available for scenarios where captureVideo is .

    +

    Only available for scenarios where captureVideo is .

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> dimensions @@ -133,8 +133,8 @@
      -
    • The billing for the screen sharing stream is based on the value of dimensions. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass in a value, Agora bills you at that value. For billing details, see .
      • -
    • The value of this parameter does not indicate the orientation mode of the output video. For how to set the video orientation, see .
      • +
    • The billing for the screen sharing stream is based on the value of dimensions. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass in a value, Agora bills you at that value. For billing details, see .
      • +
    • The value of this parameter does not indicate the orientation mode of the output video. For how to set the video orientation, see .
    • Whether the 720p resolution or above can be supported depends on the device. If the device cannot support 720p, the frame rate will be lower than the set value.
         @@ -146,8 +146,8 @@
      -
    • The billing for the screen sharing stream is based on the value of dimensions. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass in a value, Agora bills you at that value. For billing details, see .
      • -
    • The value of this parameter does not indicate the orientation mode of the output video. For how to set the video orientation, see .
      • +
    • The billing for the screen sharing stream is based on the value of dimensions. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass in a value, Agora bills you at that value. For billing details, see .
      • +
    • The value of this parameter does not indicate the orientation mode of the output video. For how to set the video orientation, see .
    • Whether the 720p resolution or above can be supported depends on the device. If the device cannot support 720p, the frame rate will be lower than the set value.
     @@ -159,8 +159,8 @@
      -
    • The billing for the screen sharing stream is based on the value of dimensions. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass in a value, Agora bills you at that value. For billing details, see .
      • -
    • The value of this parameter does not indicate the orientation mode of the output video. For how to set the video orientation, see .
      • +
    • The billing for the screen sharing stream is based on the value of dimensions. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass in a value, Agora bills you at that value. For billing details, see .
      • +
    • The value of this parameter does not indicate the orientation mode of the output video. For how to set the video orientation, see .
    • Whether the 720p resolution or above can be supported depends on the device. If the device cannot support 720p, the frame rate will be lower than the set value.
     @@ -175,12 +175,12 @@ contentHint - The content hint for screen sharing. See .
      -
    • (0): (Default) No content hint.
      • -
    • (1): Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game.
      • -
    • (2): Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slides, or texts.
      • + The content hint for screen sharing. See .
        +
      • (0): (Default) No content hint.
        • +
      • (1): Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game.
        • +
      • (2): Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slides, or texts.
    -     + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_segmentationproperty.dita b/en-US/dita/RTC-NG/API/class_segmentationproperty.dita index d280095e1ba..e4eb0c354f9 100644 --- a/en-US/dita/RTC-NG/API/class_segmentationproperty.dita +++ b/en-US/dita/RTC-NG/API/class_segmentationproperty.dita @@ -2,7 +2,7 @@ <ph keyref="SegmentationProperty" /> - Processing properties for background images. + Processing properties for background images.

    @@ -68,12 +68,12 @@ @JsonKey(name: 'greenCapacity') final double? greenCapacity; - factory SegmentationProperty.fromJson(Map<String, dynamic> json) => + factory SegmentationProperty.fromJson(Map<String, dynamic> json) => _$SegmentationPropertyFromJson(json); - Map<String, dynamic> toJson() => _$SegmentationPropertyToJson(this); + Map<String, dynamic> toJson() => _$SegmentationPropertyToJson(this); } -

    +

    @@ -104,4 +104,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 d1aef3abb2a..365d0624ba1 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 80c9c612fb6..19abac79ec2 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 2b0fe9185f2..2c4c0b2f244 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 8648761dd4d..139eceb013e 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 bf7432a5660..57f7c9cb49c 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 a0243b3aebd..7f737d56534 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_virtualbackgroundsource.dita b/en-US/dita/RTC-NG/API/class_virtualbackgroundsource.dita index 386be8f9358..426fb8378c3 100644 --- a/en-US/dita/RTC-NG/API/class_virtualbackgroundsource.dita +++ b/en-US/dita/RTC-NG/API/class_virtualbackgroundsource.dita @@ -110,7 +110,7 @@ _$VirtualBackgroundSourceFromJson(json); Map<String, dynamic> toJson() => _$VirtualBackgroundSourceToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -119,7 +119,7 @@ backgroundSourceType background_source_type The custom background. See .
      -
    • (0): Process the background as alpha information without replacement, only separating the portrait and the background. After setting this value, you can call to implement the picture-in-picture effect.
      • +
    • (0): Process the background as alpha information without replacement, only separating the portrait and the background. After setting this value, you can call to implement the picture-in-picture effect.
    • (1): (Default) The background image is a solid color.
    • (2): The background image is a file in PNG or JPG format.
    • (3): The background is a blurred version of the original background.
      • diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita index 7cbc3b7b40b..266d766b6b0 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