From 881bfc107a18f56146f0a713c696ad47439774c4 Mon Sep 17 00:00:00 2001 From: jinyu Date: Wed, 21 Aug 2024 22:24:17 +0800 Subject: [PATCH 01/20] add proto --- .../API/api_imediaengine_pushvideoframe.dita | 2 +- ...ediaengine_registeraudioframeobserver.dita | 2 +- ...ediaengine_registervideoframeobserver.dita | 2 +- .../api_imediaplayer_adjustplayoutvolume.dita | 2 +- ...mediaplayer_adjustpublishsignalvolume.dita | 2 +- .../API/api_imediaplayer_getduration.dita | 2 +- .../api_imediaplayer_getmediaplayerid.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_getmute.dita | 2 +- .../api_imediaplayer_getplayoutvolume.dita | 2 +- .../API/api_imediaplayer_getplayposition.dita | 2 +- .../API/api_imediaplayer_getplaysrc.dita | 2 +- ...i_imediaplayer_getpublishsignalvolume.dita | 2 +- .../RTC-NG/API/api_imediaplayer_getstate.dita | 2 +- .../API/api_imediaplayer_getstreamcount.dita | 2 +- .../API/api_imediaplayer_getstreaminfo.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_mute.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_open.dita | 2 +- .../api_imediaplayer_openwithmediasource.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_pause.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_play.dita | 2 +- .../api_imediaplayer_playpreloadedsrc.dita | 2 +- .../API/api_imediaplayer_preloadsrc.dita | 2 +- ...diaplayer_registeraudioframeobserver2.dita | 2 +- ...iaplayer_registerplayersourceobserver.dita | 2 +- ...ediaplayer_registervideoframeobserver.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_resume.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_seek.dita | 2 +- .../api_imediaplayer_selectaudiotrack.dita | 2 +- ...pi_imediaplayer_selectmultiaudiotrack.dita | 2 +- ...api_imediaplayer_setaudiodualmonomode.dita | 2 +- .../API/api_imediaplayer_setaudiopitch.dita | 2 +- .../API/api_imediaplayer_setloopcount.dita | 2 +- .../api_imediaplayer_setplaybackspeed.dita | 2 +- .../API/api_imediaplayer_setplayeroption.dita | 2 +- .../api_imediaplayer_setplayeroption2.dita | 2 +- .../API/api_imediaplayer_setrendermode.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_setview.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_stop.dita | 2 +- .../API/api_imediaplayer_switchsrc.dita | 2 +- .../API/api_imediaplayer_unloadsrc.dita | 2 +- ...player_unregisterplayersourceobserver.dita | 2 +- ...imusiccontentcenter_createmusicplayer.dita | 2 +- .../API/api_imusiccontentcenter_destroy.dita | 5 +- .../api_imusiccontentcenter_getcaches.dita | 2 +- ...usiccontentcenter_getinternalsongcode.dita | 2 +- .../API/api_imusiccontentcenter_getlyric.dita | 2 +- ...pi_imusiccontentcenter_getmusiccharts.dita | 2 +- ...ter_getmusiccollectionbymusicchartid2.dita | 2 +- ...imusiccontentcenter_getsongsimpleinfo.dita | 2 +- .../api_imusiccontentcenter_initialize.dita | 2 +- .../api_imusiccontentcenter_ispreloaded.dita | 2 +- ...siccontentcenter_registereventhandler.dita | 2 +- .../api_imusiccontentcenter_removecache.dita | 2 +- .../api_imusiccontentcenter_renewtoken.dita | 2 +- .../api_imusiccontentcenter_searchmusic2.dita | 2 +- ...ccontentcenter_unregistereventhandler.dita | 2 +- .../API/api_imusicontentcenter_preload2.dita | 2 +- .../api_irtcengine_clearvideowatermarks.dita | 2 +- .../API/api_irtcengine_createmediaplayer.dita | 2 +- .../api_irtcengine_destroymediaplayer.dita | 2 +- .../api_irtcengine_enablecontentinspect.dita | 2 +- .../API/api_irtcengine_enableextension.dita | 2 +- ...rtcengine_getaudiomixingplayoutvolume.dita | 2 +- ...rtcengine_getaudiomixingpublishvolume.dita | 2 +- ...api_irtcengine_getcameramaxzoomfactor.dita | 2 +- .../api_irtcengine_geterrordescription.dita | 4 +- .../RTC-NG/API/api_irtcengine_getversion.dita | 4 +- ...ne_iscameraautofocusfacemodesupported.dita | 2 +- ...ine_iscameraexposurepositionsupported.dita | 2 +- ..._irtcengine_iscameraexposuresupported.dita | 2 +- ...rtcengine_iscamerafacedetectsupported.dita | 2 +- .../api_irtcengine_iscamerazoomsupported.dita | 2 +- ...rtcengine_setaudiomixingplaybackspeed.dita | 2 +- ...ine_setcameraautofocusfacemodeenabled.dita | 2 +- ...pi_irtcengine_setcameraexposurefactor.dita | 2 +- ..._irtcengine_setcameraexposureposition.dita | 2 +- .../API/api_irtcengine_setcameratorchon.dita | 2 +- .../api_irtcengine_setcamerazoomfactor.dita | 2 +- .../api_irtcengine_setenablespeakerphone.dita | 2 +- ...ybackaudioframebeforemixingparameters.dita | 2 +- .../API/api_irtcengine_startaudiomixing2.dita | 2 +- .../api_irtcengine_startaudiorecording.dita | 2 +- ...ine_startrtmpstreamwithouttranscoding.dita | 2 +- .../api_irtcengine_startscreencapture.dita | 2 +- .../api_irtcengine_stopaudiorecording.dita | 2 +- .../RTC-NG/API/api_irtcengine_stopeffect.dita | 2 +- ...cengine_updatescreencaptureparameters.dita | 2 +- ...neex_adjustuserplaybacksignalvolumeex.dita | 2 +- ...ngineex_enableaudiovolumeindicationex.dita | 2 +- ..._irtcengineex_muteremoteaudiostreamex.dita | 2 +- ..._irtcengineex_muteremotevideostreamex.dita | 2 +- .../api_irtcengineex_sendstreammessageex.dita | 2 +- ...pi_irtcengineex_setremoterendermodeex.dita | 2 +- ...tcengineex_setremotevideostreamtypeex.dita | 2 +- .../API/api_irtcengineex_takesnapshotex.dita | 2 +- ...cengineex_updatechannelmediaoptionsex.dita | 2 +- ...spectrumobserver_onlocalaudiospectrum.dita | 2 +- ...pectrumobserver_onremoteaudiospectrum.dita | 2 +- ...ourceobserver_onaudiovolumeindication.dita | 2 +- ...imediaplayersourceobserver_onmetadata.dita | 2 +- ...ayersourceobserver_onplayercachestats.dita | 2 +- ...diaplayersourceobserver_onplayerevent.dita | 2 +- ...yersourceobserver_onplayerinfoupdated.dita | 2 +- ...rsourceobserver_onplayerplaybackstats.dita | 2 +- ...ceobserver_onplayersourcestatechanged.dita | 2 +- ...sourceobserver_onplayersrcinfochanged.dita | 2 +- ...layersourceobserver_onpositionchanged.dita | 2 +- ...iaplayersourceobserver_onpreloadevent.dita | 2 +- ...ntentcentereventhandler_onlyricresult.dita | 2 +- ...entereventhandler_onmusicchartsresult.dita | 2 +- ...reventhandler_onmusiccollectionresult.dita | 2 +- ...tentcentereventhandler_onpreloadevent.dita | 2 +- ...ereventhandler_onsongsimpleinforesult.dita | 2 +- ...venthandler_onaudiomixingstatechanged.dita | 2 +- ...enthandler_onaudiopublishstatechanged.dita | 2 +- ...thandler_onaudiosubscribestatechanged.dita | 2 +- ...ndler_onchannelmediarelaystatechanged.dita | 2 +- ...llback_irtcengineeventhandler_onerror.dita | 2 +- ...neeventhandler_onfirstlocalvideoframe.dita | 2 +- ...eeventhandler_onfirstremotevideoframe.dita | 2 +- ...enthandler_ontokenprivilegewillexpire.dita | 2 +- ...rtcengineeventhandler_onusermuteaudio.dita | 2 +- ...rtcengineeventhandler_onusermutevideo.dita | 2 +- ...thandler_onvideosubscribestatechanged.dita | 2 +- dita/RTC-NG/API/class_advanceoptions.dita | 10 +- dita/RTC-NG/API/class_audiospectrumdata.dita | 5 +- dita/RTC-NG/API/class_cachestatistics.dita | 10 +- .../RTC-NG/API/class_channelmediaoptions.dita | 120 +++++++++--------- dita/RTC-NG/API/class_climaxsegment.dita | 6 +- .../API/class_contentinspectconfig.dita | 12 +- .../API/class_contentinspectmodule.dita | 7 +- dita/RTC-NG/API/class_logconfig.dita | 9 +- dita/RTC-NG/API/class_mediasource.dita | 20 ++- dita/RTC-NG/API/class_music.dita | 26 +++- dita/RTC-NG/API/class_musiccacheinfo.dita | 8 +- dita/RTC-NG/API/class_musicchartinfo.dita | 8 +- ...class_musiccontentcenterconfiguration.dita | 16 ++- .../RTC-NG/API/class_playerplaybackstats.dita | 12 +- dita/RTC-NG/API/class_playerstreaminfo.dita | 17 ++- dita/RTC-NG/API/class_playerupdatedinfo.dita | 18 ++- dita/RTC-NG/API/class_rtcengineconfig.dita | 1 + .../API/class_segmentationproperty.dita | 4 +- dita/RTC-NG/API/class_srcinfo.dita | 8 +- dita/RTC-NG/API/class_videocanvas.dita | 1 + .../API/class_virtualbackgroundsource.dita | 22 +++- 145 files changed, 387 insertions(+), 208 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index 142aa1dcad9..79e1ab56064 100644 --- a/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -14,7 +14,7 @@

public abstract int pushExternalVideoFrameById(AgoraVideoFrame frame, int videoTrackId); - + public abstract pushExternalVideoFrameById(frame: VideoFrame, videoTrackId: number): number; - (BOOL)pushExternalVideoFrame:(AgoraVideoFrame * _Nonnull)frame videoTrackId:(NSUInteger)videoTrackId NS_SWIFT_NAME(pushExternalVideoFrame(_:videoTrackId:)); virtual int pushVideoFrame(base::ExternalVideoFrame* frame, unsigned int videoTrackId = 0) = 0; abstract pushVideoFrame( diff --git a/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index 69c5203841b..7c21b37c9c7 100644 --- a/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita @@ -14,7 +14,7 @@

public abstract int registerAudioFrameObserver(IAudioFrameObserver observer); - public abstract registerAudioFrameObserver(observer:IAudioFrameObserver):number; + - (BOOL)setAudioFrameDelegate:(id<AgoraAudioFrameDelegate> _Nullable)delegate; virtual int registerAudioFrameObserver(IAudioFrameObserver* observer) = 0; abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number; diff --git a/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita b/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index d766b25831d..a0b66e478f1 100644 --- a/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita @@ -14,7 +14,7 @@

public abstract int registerVideoFrameObserver(IVideoFrameObserver observer); - public abstract registerVideoFrameObserver(observer:IVideoFrameObserver):number; + - (BOOL)setVideoFrameDelegate:(id<AgoraVideoFrameDelegate> _Nullable)delegate; virtual int registerVideoFrameObserver(IVideoFrameObserver* observer) = 0; abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number; diff --git a/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita b/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita index 392dce45ff9..326a3ff31a6 100644 --- a/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita +++ b/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita @@ -14,7 +14,7 @@

int adjustPlayoutVolume(int volume); - + public abstract adjustPlayoutVolume(vol: number): number; - (int)adjustPlayoutVolume:(int)volume; virtual int adjustPlayoutVolume(int volume) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita b/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita index 3ff415f1dde..50863ab0041 100644 --- a/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita +++ b/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita @@ -14,7 +14,7 @@

int adjustPublishSignalVolume(int volume); - + public abstract adjustPublishSignalVolume(volume:number):number; - (int)adjustPublishSignalVolume:(int)volume; virtual int adjustPublishSignalVolume(int volume) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getduration.dita b/dita/RTC-NG/API/api_imediaplayer_getduration.dita index 4692dcc6233..f2e51170786 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getduration.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getduration.dita @@ -14,7 +14,7 @@

long getDuration(); - + public abstract getDuration():number; - (NSInteger)getDuration; virtual int getDuration(int64_t& duration) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getmediaplayerid.dita b/dita/RTC-NG/API/api_imediaplayer_getmediaplayerid.dita index 53912509d32..c20acfe0ad2 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getmediaplayerid.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getmediaplayerid.dita @@ -14,7 +14,7 @@

int getMediaPlayerId(); - + public abstract getMediaPlayerId():number; - (int)getMediaPlayerId; virtual int getMediaPlayerId() const = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getmute.dita b/dita/RTC-NG/API/api_imediaplayer_getmute.dita index ffe3fe2ad55..279c9d8f8e3 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getmute.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getmute.dita @@ -14,7 +14,7 @@

boolean getMute(); - + public abstract getMute(): boolean; - (bool)getMute; virtual int getMute(bool& mute) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita b/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita index 339a2f8b5c3..c6fe39f2dd3 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita @@ -14,7 +14,7 @@

int getPlayoutVolume(); - + public abstract getPlayoutVolume():number - (int)getPlayoutVolume; virtual int getPlayoutVolume(int& volume) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita b/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita index d1e754673d5..97dc7a627a2 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita @@ -14,7 +14,7 @@

long getPlayPosition(); - + public abstract getPlayPosition():number; - (NSInteger)getPosition; virtual int getPlayPosition(int64_t& pos) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita b/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita index 924d943a74a..f9945f24803 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita @@ -14,7 +14,7 @@

String getPlaySrc(); - + public abstract getPlaySrc():string; - (NSString *)getPlaySrc; virtual const char* getPlaySrc() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita b/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita index 2f004afa92f..09d08ade0a6 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita @@ -14,7 +14,7 @@

int getPublishSignalVolume(); - + public abstract getPublishSignalVolume():number; - (int)getPublishSignalVolume; virtual int getPublishSignalVolume(int& volume) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getstate.dita b/dita/RTC-NG/API/api_imediaplayer_getstate.dita index 6d9e175ec56..c9929dfd417 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getstate.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getstate.dita @@ -14,7 +14,7 @@

Constants.MediaPlayerState getState(); - + public abstract getState():Constants.MediaPlayerState; - (AgoraMediaPlayerState)getPlayerState; virtual media::base::MEDIA_PLAYER_STATE getState() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita b/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita index d681d146d07..0ee7fc721e2 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita @@ -14,7 +14,7 @@

int getStreamCount(); - + public abstract getStreamCount():number; - (NSInteger)getStreamCount; virtual int getStreamCount(int64_t& count) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita b/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita index 026242bf007..26908348228 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita @@ -14,7 +14,7 @@

MediaStreamInfo getStreamInfo(int index); - + public abstract getStreamInfo(index:number):MediaStreamInfo|undefined; - (AgoraMediaStreamInfo *_Nullable)getStreamByIndex:(int)index; virtual int getStreamInfo(int64_t index, media::base::PlayerStreamInfo* info) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_mute.dita b/dita/RTC-NG/API/api_imediaplayer_mute.dita index 3b6531dde04..16a3f8175db 100644 --- a/dita/RTC-NG/API/api_imediaplayer_mute.dita +++ b/dita/RTC-NG/API/api_imediaplayer_mute.dita @@ -14,7 +14,7 @@

int mute(boolean muted); - + public abstract mute(muted:boolean) : number; - (int)mute:(bool)isMute NS_SWIFT_NAME(mute(_:)); virtual int mute(bool muted) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_open.dita b/dita/RTC-NG/API/api_imediaplayer_open.dita index fc790258acc..01ceff4d33d 100644 --- a/dita/RTC-NG/API/api_imediaplayer_open.dita +++ b/dita/RTC-NG/API/api_imediaplayer_open.dita @@ -15,7 +15,7 @@

int open(String url, long startPos); - + public abstract open(url:string, startPos:number):number; - (int)open:(NSString *)url startPos:(NSInteger)startPos; virtual int open(const char* url, int64_t startPos) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita b/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita index 35fdd9cc7bc..cb6d28b7458 100644 --- a/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita +++ b/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita @@ -14,7 +14,7 @@

int openWithMediaSource(MediaPlayerSource source); - + public abstract openWithMediaSource(source: MediaPlayerSource) :number ; - (int)openWithMediaSource:(AgoraMediaSource *)source; virtual int openWithMediaSource(const media::base::MediaSource &source) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_pause.dita b/dita/RTC-NG/API/api_imediaplayer_pause.dita index d02b4ea84cd..fa93aa84865 100644 --- a/dita/RTC-NG/API/api_imediaplayer_pause.dita +++ b/dita/RTC-NG/API/api_imediaplayer_pause.dita @@ -15,7 +15,7 @@

int pause(); - + public abstract pause(): number; - (int)pause; virtual int pause() = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_play.dita b/dita/RTC-NG/API/api_imediaplayer_play.dita index 0446ed0effb..ed45a7089f3 100644 --- a/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/dita/RTC-NG/API/api_imediaplayer_play.dita @@ -14,7 +14,7 @@

int play(); - + public abstract play(): number; - (int)play; virtual int play() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita b/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita index 839c6be2ee9..91539a874a6 100644 --- a/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita +++ b/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita @@ -15,7 +15,7 @@

int playPreloadedSrc(String src); - + public abstract playPreloadedSrc(src:string):number; - (int)playPreloadedSrc:(NSString *)src; virtual int playPreloadedSrc(const char* src) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita b/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita index 4c4958f073b..875f9e91ac4 100644 --- a/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita +++ b/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita @@ -15,7 +15,7 @@

int preloadSrc(String src, long startPos); - + public abstract preloadSrc(src:string, startPos:number):number; - (int)preloadSrc:(NSString *)src startPos:(int)startPos; virtual int preloadSrc(const char* src, int64_t startPos) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita b/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita index ac5e4972586..d2f59fa1d1f 100644 --- a/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita +++ b/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita @@ -15,7 +15,7 @@

int registerAudioFrameObserver(IMediaPlayerAudioFrameObserver audioFrameObserver, int mode); - public abstract registerAudioFrameObserver(observer:IAudioFrameObserver):number; + virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink* observer, RAW_AUDIO_FRAME_OP_MODE_TYPE mode) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita b/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita index 9a41cbda07d..be91392024b 100644 --- a/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita +++ b/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita @@ -15,7 +15,7 @@

int registerPlayerObserver(IMediaPlayerObserver playerObserver); - + public abstract registerPlayerObserver(playerObserver:IMediaPlayerObserver); virtual int registerPlayerSourceObserver(IMediaPlayerSourceObserver* observer) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita b/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita index 9a35ed36cb5..ab29f1f97b9 100644 --- a/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita +++ b/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita @@ -14,7 +14,7 @@

int registerVideoFrameObserver(IMediaPlayerVideoFrameObserver videoFrameObserver); - public abstract registerVideoFrameObserver(observer:IVideoFrameObserver):number; + virtual int registerVideoFrameObserver(media::base::IVideoFrameObserver* observer) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_resume.dita b/dita/RTC-NG/API/api_imediaplayer_resume.dita index fb514f6c4a9..81dac38a8df 100644 --- a/dita/RTC-NG/API/api_imediaplayer_resume.dita +++ b/dita/RTC-NG/API/api_imediaplayer_resume.dita @@ -14,7 +14,7 @@

int resume(); - + public abstract resume(): number; - (int)resume; virtual int resume() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_seek.dita b/dita/RTC-NG/API/api_imediaplayer_seek.dita index dbff9f728e5..e2ce0898f7a 100644 --- a/dita/RTC-NG/API/api_imediaplayer_seek.dita +++ b/dita/RTC-NG/API/api_imediaplayer_seek.dita @@ -15,7 +15,7 @@

int seek(long newPos); - + public abstract seek(newPos: number): number; - (void)seekToPosition:(NSInteger)position; virtual int seek(int64_t newPos) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita b/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita index 6867a6c9dab..a0a36448e2e 100644 --- a/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita +++ b/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita @@ -14,7 +14,7 @@

int selectAudioTrack(int index); - + public abstract selectAudioTrack(index: number): number; - (int)selectAudioTrack:(int)index; virtual int selectAudioTrack(int index) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita b/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita index 87968cbcb2d..456a4c779ff 100644 --- a/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita +++ b/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita @@ -14,7 +14,7 @@

int selectMultiAudioTrack(int playoutTrackIndex, int publishTrackIndex); - + public abstract selectMultiAudioTrack(playoutTrackIndex:number, publishTrackIndex: number): number; - (int)selectMultiAudioTrack:(NSInteger)playoutTrackIndex publishTrackIndex:(NSInteger)publishTrackIndex NS_SWIFT_NAME(selectMultiAudioTrack(_:publishTrackIndex:)); virtual int selectMultiAudioTrack(int playoutTrackIndex, int publishTrackIndex) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita b/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita index d8a9cfc22ef..370be1d2a19 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita @@ -14,7 +14,7 @@

int setAudioDualMonoMode(int mode); - + public abstract setAudioDualMonoMode(mode:Constants.AudioDualMonoMode):number; - (int)setAudioDualMonoMode:(AgoraAudioDualMonoMode)mode; virtual int setAudioDualMonoMode(agora::media::base::AUDIO_DUAL_MONO_MODE mode) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita b/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita index 5825f796399..a02da6918df 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita @@ -14,7 +14,7 @@

int setAudioPitch(int pitch); - + public abstract setAudioPitch(pitch:number): number; - (int)setAudioPitch:(NSInteger)pitch; virtual int setAudioPitch(int pitch) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita b/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita index 9f53cc3f609..aa9b775a676 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita @@ -15,7 +15,7 @@

int setLoopCount(int loopCount); - + public abstract setLoopCount(loopCount:number):number; - (void)setLoopCount:(NSInteger)loopCount; virtual int setLoopCount(int loopCount) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita b/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita index ad733dc6497..e8ec504264b 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita @@ -14,7 +14,7 @@

int setPlaybackSpeed(int speed); - + public abstract setPlaybackSpeed(speed: number) : number; - (int)setPlaybackSpeed:(int)speed; virtual int setPlaybackSpeed(int speed) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita b/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita index 3205fc9b717..abf88b3496a 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita @@ -14,7 +14,7 @@

int setPlayerOption(String key, int value); - + public abstract setPlayerOption(key:string, value:number); - (int)setPlayerOption:(NSString *)key value:(NSInteger)value NS_SWIFT_NAME(setPlayerOption(_:value:)); virtual int setPlayerOption(const char* key, int64_t value) = 0; abstract setPlayerOptionInInt(key: string, value: number): number; diff --git a/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita b/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita index 55d5c9dd8a8..70b4122c5a1 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita @@ -14,7 +14,7 @@

int setPlayerOptionString(String key, String value); - + public abstract setPlayerOptionString(key:string, value:string): number; - (int)setPlayerOptionString:(NSString *)key value:(NSString *)value NS_SWIFT_NAME(setPlayerOptionString(_:value:)); virtual int setPlayerOption(const char* key, const char* value) = 0; abstract setPlayerOptionInString(key: string, value: string): number; diff --git a/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index ca0a751f4cb..f95b8f3125e 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita @@ -15,7 +15,7 @@

int setRenderMode(int mode); - + public abstract setRenderMode(mode:number):number; - (void)setRenderMode:(AgoraMediaPlayerRenderMode)mode; virtual int setRenderMode(media::base::RENDER_MODE_TYPE renderMode) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_setview.dita b/dita/RTC-NG/API/api_imediaplayer_setview.dita index aa7c2dc49ee..2b752c3977f 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setview.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setview.dita @@ -15,7 +15,7 @@

int setView(View videoView); - + public abstract setView(view:string):number; - (void)setView:(View *_Nullable)view; virtual int setView(media::base::view_t view) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_stop.dita b/dita/RTC-NG/API/api_imediaplayer_stop.dita index 74c3413c9ee..7356ee11a2a 100644 --- a/dita/RTC-NG/API/api_imediaplayer_stop.dita +++ b/dita/RTC-NG/API/api_imediaplayer_stop.dita @@ -15,7 +15,7 @@

int stop(); - + public abstract stop(): number; - (void)stop; virtual int stop() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita b/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita index 9b467487e2e..2cf928e62bd 100644 --- a/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita +++ b/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita @@ -15,7 +15,7 @@

int switchSrc(String src, boolean syncPts); - + public abstract switchSrc(src:string, syncPts:boolean):number; - (int)switchSrc:(NSString *)src syncPts:(BOOL)sync; virtual int switchSrc(const char* src, bool syncPts) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita b/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita index 80fd556c127..f7de7de4748 100644 --- a/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita +++ b/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita @@ -15,7 +15,7 @@

int unloadSrc(String src); - + public abstract unloadSrc(src:string):number; - (int)unloadSrc:(NSString *)src; virtual int unloadSrc(const char* src) = 0; diff --git a/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita b/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita index e9f497f2607..7fd11c75ff3 100644 --- a/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita +++ b/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita @@ -14,7 +14,7 @@

int unRegisterPlayerObserver(IMediaPlayerObserver playerObserver); - + public abstract unRegisterPlayerObserver(); virtual int unregisterPlayerSourceObserver(IMediaPlayerSourceObserver* observer) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer") diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita b/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita index 4a7a1b6cdda..e450d22d8ab 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita @@ -14,7 +14,7 @@

public abstract IAgoraMusicPlayer createMusicPlayer(); - + public abstract createMusicPlayer():IAgoraMusicPlayer (id<AgoraMusicPlayerProtocol> _Nullable)createMusicPlayerWithDelegate:(id<AgoraRtcMediaPlayerDelegate> _Nullable)delegate NS_SWIFT_NAME(createMusicPlayer(delegate:)); virtual agora_refptr<IMusicPlayer> createMusicPlayer() = 0; abstract createMusicPlayer(): IMusicPlayer; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita b/dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita index 10af7dc5218..ddbe78af275 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita @@ -19,7 +19,10 @@ mInstance.release(); mInstance = null; } - + public static destroy():void +{ + RtcNapi.destroyMusicContentCenter() +} + (void)destroy; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita index 0893c89fe19..452bfade7eb 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita @@ -14,7 +14,7 @@

public abstract MusicCacheInfo[] getCaches(); - + public abstract getCaches():MusicCacheInfo[] - (NSArray *)getCaches NS_SWIFT_NAME(getCaches()); virtual int getCaches(MusicCacheInfo *cacheInfo, int32_t* cacheInfoSize) = 0; abstract getCaches(): { cacheInfo: MusicCacheInfo[]; cacheInfoSize: number }; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita index a1cb4b2fd20..c00c16ff267 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita @@ -14,7 +14,7 @@

public abstract long getInternalSongCode(long songCode, String jsonOption); - + public abstract getInternalSongCode(songCode:bigint,jsonOption:string):bigint - (NSInteger)getInternalSongCode:(NSInteger)songCode jsonOption:(NSString * _Nullable)jsonOption NS_SWIFT_NAME(getInternalSongCode(songCode:jsonOption:)); virtual int getInternalSongCode(int64_t songCode, const char* jsonOption, int64_t& internalSongCode) = 0; abstract getInternalSongCode(songCode: number, jsonOption: string): number; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita index c8abd239217..0fc375bf663 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita @@ -14,7 +14,7 @@

public abstract String getLyric(long songCode, int lyricType); - + public abstract getLyric(songCode:bigint,lyricType:number):string - (NSString *)getLyricWithSongCode:(NSInteger)songCode lyricType:(NSInteger)lyricType NS_SWIFT_NAME(getLyric(songCode:lyricType:)); virtual int getLyric(agora::util::AString& requestId, int64_t songCode, int32_t LyricType = 0) = 0; abstract getLyric(songCode: number, lyricType?: number): string; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccharts.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccharts.dita index 969030db483..c9f9bb42e5c 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccharts.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccharts.dita @@ -14,7 +14,7 @@

public abstract String getMusicCharts(); - + public abstract getMusicCharts():string - (NSString *)getMusicCharts; virtual int getMusicCharts(agora::util::AString& requestId) = 0; abstract getMusicCharts(): string; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccollectionbymusicchartid2.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccollectionbymusicchartid2.dita index 193aab0725e..d8acdaea6a7 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccollectionbymusicchartid2.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccollectionbymusicchartid2.dita @@ -15,7 +15,7 @@

public abstract String getMusicCollectionByMusicChartId( int musicChartId, int page, int pageSize, String jsonOption); - + public abstract getMusicCollectionByMusicChartId(musicChartId:number,page:number,pageSize:number,jsonOption?:string):string diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getsongsimpleinfo.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getsongsimpleinfo.dita index fcb603b2efd..ee6aef2321c 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_getsongsimpleinfo.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_getsongsimpleinfo.dita @@ -14,7 +14,7 @@

public abstract String getSongSimpleInfo(long songCode); - + public abstract getSongSimpleInfo(songCode:bigint):string - (NSString *)getSongSimpleInfoWithSongCode:(NSInteger)songCode NS_SWIFT_NAME(getSongSimpleInfo(songCode:)); virtual int getSongSimpleInfo(agora::util::AString& requestId, int64_t songCode) = 0; abstract getSongSimpleInfo(songCode: number): string; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_initialize.dita b/dita/RTC-NG/API/api_imusiccontentcenter_initialize.dita index 535aacc6d21..9139e5ac79a 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_initialize.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_initialize.dita @@ -14,7 +14,7 @@

public abstract int initialize(MusicContentCenterConfiguration configuration); - + public abstract initialize(configuration:MusicContentCenterConfiguration):number + (instancetype)sharedContentCenterWithConfig:(AgoraMusicContentCenterConfig *)config NS_SWIFT_NAME(sharedContentCenter(config:)); virtual int initialize(const MusicContentCenterConfiguration & configuration) = 0; abstract initialize(configuration: MusicContentCenterConfiguration): number; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_ispreloaded.dita b/dita/RTC-NG/API/api_imusiccontentcenter_ispreloaded.dita index 6a4a2650068..c892e972f0c 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_ispreloaded.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_ispreloaded.dita @@ -14,7 +14,7 @@

public abstract int isPreloaded(long songCode); - + public abstract isPreloaded(songCode:bigint):number - (NSInteger)isPreloadedWithSongCode:(NSInteger)songCode NS_SWIFT_NAME(isPreloaded(songCode:)); virtual int isPreloaded(int64_t songCode) = 0; abstract isPreloaded(songCode: number): number; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_registereventhandler.dita b/dita/RTC-NG/API/api_imusiccontentcenter_registereventhandler.dita index 06ad56df417..3be7a4ee377 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_registereventhandler.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_registereventhandler.dita @@ -14,7 +14,7 @@

public abstract int registerEventHandler(IMusicContentCenterEventHandler eventHandler); - + public abstract registerEventHandler(eventHandler:IMusicContentCenterEventHandler):number - (NSInteger)registerEventDelegate:(id<AgoraMusicContentCenterEventDelegate> _Nullable)eventDelegate; virtual int registerEventHandler(IMusicContentCenterEventHandler* eventHandler) = 0; abstract registerEventHandler( diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_removecache.dita b/dita/RTC-NG/API/api_imusiccontentcenter_removecache.dita index c36d68d3e1a..4ff836a3693 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_removecache.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_removecache.dita @@ -14,7 +14,7 @@

public abstract int removeCache(long songCode); - + public abstract removeCache(songCode:bigint):number - (NSInteger)removeCacheWithSongCode:(NSInteger)songCode NS_SWIFT_NAME(removeCache(songCode:)); virtual int removeCache(int64_t songCode) = 0; abstract removeCache(songCode: number): number; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_renewtoken.dita b/dita/RTC-NG/API/api_imusiccontentcenter_renewtoken.dita index 9fc4eaf5d1c..5a06914a3e2 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_renewtoken.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_renewtoken.dita @@ -14,7 +14,7 @@

public abstract int renewToken(String token); - + public abstract renewToken(token:string):number - (NSInteger)renewToken:(NSString * _Nonnull)token; virtual int renewToken(const char* token) = 0; abstract renewToken(token: string): number; diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_searchmusic2.dita b/dita/RTC-NG/API/api_imusiccontentcenter_searchmusic2.dita index 3a514965f52..c0fb1e4dd3f 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_searchmusic2.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_searchmusic2.dita @@ -14,7 +14,7 @@

public abstract String searchMusic(String keyword, int page, int pageSize, String jsonOption); - + public abstract searchMusic(keyword:string,page:number,pageSize:number,jsonOption?:string):string diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_unregistereventhandler.dita b/dita/RTC-NG/API/api_imusiccontentcenter_unregistereventhandler.dita index a083ebab7e5..ab46e0226b6 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_unregistereventhandler.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_unregistereventhandler.dita @@ -14,7 +14,7 @@

public abstract int unregisterEventHandler(); - + public abstract unregisterEventHandler():number virtual int unregisterEventHandler() = 0; abstract unregisterEventHandler(): number; diff --git a/dita/RTC-NG/API/api_imusicontentcenter_preload2.dita b/dita/RTC-NG/API/api_imusicontentcenter_preload2.dita index 590efe8c4d5..dc5a80db438 100644 --- a/dita/RTC-NG/API/api_imusicontentcenter_preload2.dita +++ b/dita/RTC-NG/API/api_imusicontentcenter_preload2.dita @@ -14,7 +14,7 @@

public abstract String preload(long songCode); - + public abstract preload(songCode:bigint):string - (NSString *)preloadWithSongCode:(NSInteger)songCode NS_SWIFT_NAME(preload(songCode:)); virtual int preload(agora::util::AString& requestId, int64_t songCode) = 0; abstract preload(songCode: number): string; diff --git a/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita b/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita index 2cfb4a7879b..9361f0a6eaa 100644 --- a/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita +++ b/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita @@ -14,7 +14,7 @@

public abstract int clearVideoWatermarks(); - public abstract clearVideoWatermarks(): number; + - (int)clearVideoWatermarks; virtual int clearVideoWatermarks() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita b/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita index 02a77b82f5c..c532f413875 100644 --- a/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita +++ b/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita @@ -14,7 +14,7 @@

public abstract IMediaPlayer createMediaPlayer(); - + public abstract createMediaPlayer():IMediaPlayer|undefined; - (id<AgoraRtcMediaPlayerProtocol>_Nullable)createMediaPlayerWithDelegate: (id<AgoraRtcMediaPlayerDelegate>_Nullable)delegate; virtual agora_refptr <IMediaPlayer> createMediaPlayer() = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita b/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita index 4c5bf4c97e8..dc0737e0a36 100644 --- a/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita +++ b/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita @@ -15,7 +15,7 @@

int destroy(); - + public abstract destroy():number; - (int)destroyMediaPlayer:(id<AgoraRtcMediaPlayerProtocol>_Nullable)mediaPlayer; virtual int destroyMediaPlayer(agora_refptr<IMediaPlayer> media_player) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index 53117ae0557..6baa01097c9 100644 --- a/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita @@ -14,7 +14,7 @@

public abstract int enableContentInspect(boolean enabled, ContentInspectConfig config); - + public abstract enableContentInspect(enabled:boolean,config:ContentInspectConfig):number; - (int)enableContentInspect:(BOOL)enabled config:(AgoraContentInspectConfig* _Nonnull)config; virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_enableextension.dita b/dita/RTC-NG/API/api_irtcengine_enableextension.dita index c70ae669b50..b8b07ef16b4 100644 --- a/dita/RTC-NG/API/api_irtcengine_enableextension.dita +++ b/dita/RTC-NG/API/api_irtcengine_enableextension.dita @@ -15,7 +15,7 @@

public abstract int enableExtension( String provider, String extension, boolean enable, Constants.MediaSourceType sourceType); - public abstract enableExtension(provider:string,extension:string,enable:boolean,extensionInfo:ExtensionInfo):number; + - (int)enableExtensionWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension enabled:(BOOL)enabled diff --git a/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita b/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita index 635090956a5..b1f194c062a 100644 --- a/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita +++ b/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita @@ -14,7 +14,7 @@

public abstract int getAudioMixingPlayoutVolume(); - + public abstract getAudioMixingPlayoutVolume():number; - (int)getAudioMixingPlayoutVolume; virtual int getAudioMixingPlayoutVolume() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita b/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita index 73e3d5fe224..1b0aa54bab4 100644 --- a/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita +++ b/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita @@ -14,7 +14,7 @@

public abstract int getAudioMixingPublishVolume(); - + public abstract getAudioMixingPublishVolume():number; - (int)getAudioMixingPublishVolume; virtual int getAudioMixingPublishVolume() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita b/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita index 10609744549..7e2afe6980f 100644 --- a/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita +++ b/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita @@ -14,7 +14,7 @@

public abstract float getCameraMaxZoomFactor(); - public abstract getCameraMaxZoomFactor():number; + public abstract getCameraMaxZoomFactor(): number; - (CGFloat)cameraMaxZoomFactor; virtual float getCameraMaxZoomFactor() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita b/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita index fe58c5fc353..e4443a198dd 100644 --- a/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita +++ b/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita @@ -14,7 +14,9 @@

public static String getErrorDescription(int error) - + public static getErrorDescription(error: number): string { + return RtcEngineImpl.getErrorDescriptionInternal(error); +} + (NSString* _Nonnull)getErrorDescription: (NSInteger)error; virtual const char* getErrorDescription(int code) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_getversion.dita b/dita/RTC-NG/API/api_irtcengine_getversion.dita index 8ca609d24f7..243b4798b46 100644 --- a/dita/RTC-NG/API/api_irtcengine_getversion.dita +++ b/dita/RTC-NG/API/api_irtcengine_getversion.dita @@ -14,7 +14,9 @@

public static String getSdkVersion() - + public static getSdkVersion(): string { + return RtcEngineImpl.getRtcSdkVersion(); +} + (NSString * _Nonnull)getSdkVersion; virtual const char* getVersion(int* build) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita b/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita index f96dcef1619..fbf967b73af 100644 --- a/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita +++ b/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita @@ -14,7 +14,7 @@

public abstract boolean isCameraAutoFocusFaceModeSupported(); - + public abstract isCameraAutoFocusFaceModeSupported(): boolean; - (BOOL)isCameraAutoFocusFaceModeSupported; virtual bool isCameraAutoFocusFaceModeSupported() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita b/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita index 4bfda68d675..e83fb1d6e38 100644 --- a/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita +++ b/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita @@ -14,7 +14,7 @@

public abstract boolean isCameraExposurePositionSupported(); - + public abstract isCameraExposurePositionSupported(): boolean; - (BOOL)isCameraExposurePositionSupported; virtual bool isCameraExposurePositionSupported() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita b/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita index d9f9d1f89ba..4dbb4883bbf 100644 --- a/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita +++ b/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita @@ -14,7 +14,7 @@

public abstract boolean isCameraExposureSupported(); - + public abstract isCameraExposureSupported(): boolean; - (BOOL)isCameraExposureSupported NS_SWIFT_NAME(isCameraExposureSupported()); virtual bool isCameraExposureSupported() = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita b/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita index a82f401a21e..3d886314c02 100644 --- a/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita +++ b/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita @@ -14,7 +14,7 @@

public abstract boolean isCameraFaceDetectSupported(); - + public abstract isCameraFaceDetectSupported(): boolean; virtual bool isCameraFaceDetectSupported() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita b/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita index 8fa8808e4c9..287a3617fe3 100644 --- a/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita +++ b/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita @@ -14,7 +14,7 @@

public abstract boolean isCameraZoomSupported(); - + public abstract isCameraZoomSupported(): boolean; - (BOOL)isCameraZoomSupported; virtual bool isCameraZoomSupported() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_setaudiomixingplaybackspeed.dita b/dita/RTC-NG/API/api_irtcengine_setaudiomixingplaybackspeed.dita index 7cdc4a64adc..934f1f06251 100644 --- a/dita/RTC-NG/API/api_irtcengine_setaudiomixingplaybackspeed.dita +++ b/dita/RTC-NG/API/api_irtcengine_setaudiomixingplaybackspeed.dita @@ -14,7 +14,7 @@

public abstract int setAudioMixingPlaybackSpeed(int speed); - + public abstract setAudioMixingPlaybackSpeed(speed: number): number - (int)setAudioMixingPlaybackSpeed:(NSInteger)speed NS_SWIFT_NAME(setAudioMixingPlaybackSpeed(_:)); virtual int setAudioMixingPlaybackSpeed(int speed) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita b/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita index 2dfff7d1c8f..fe04aefe582 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita @@ -14,7 +14,7 @@

public abstract int setCameraAutoFocusFaceModeEnabled(boolean enabled); - + public abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number; - (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable; virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita b/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita index 8fc92f7119a..cb6dbdf6d34 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita @@ -14,7 +14,7 @@

public abstract int setCameraExposureFactor(int factor); - + public abstract setCameraExposureFactor(factor: number): number; - (CGFloat)setCameraExposureFactor:(CGFloat)exposureFactor NS_SWIFT_NAME(setCameraExposureFactor(_:)); virtual int setCameraExposureFactor(float factor) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita b/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita index 8f95b56af60..8ce4aee5aab 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita @@ -14,7 +14,7 @@

public abstract int setCameraExposurePosition(float positionXinView, float positionYinView); - + public abstract setCameraExposurePosition(positionXinView: number, positionYinView: number): number; - (BOOL)setCameraExposurePosition:(CGPoint)positionInView; virtual int setCameraExposurePosition(float positionXinView, float positionYinView) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita b/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita index a4f8abed7de..178f0947e62 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita @@ -14,7 +14,7 @@

public abstract int setCameraTorchOn(boolean isOn); - public abstract setCameraTorchOn(isOn:boolean):number; + - (BOOL)setCameraTorchOn:(BOOL)isOn NS_SWIFT_NAME(setCameraTorchOn(_:)); virtual int setCameraTorchOn(bool isOn) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita b/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita index 5006c43d6f7..a2c089c6030 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita @@ -14,7 +14,7 @@

public abstract int setCameraZoomFactor(float factor); - public abstract setCameraZoomFactor(factor:number):number; + public abstract setCameraZoomFactor(factor: number): number; - (CGFloat)setCameraZoomFactor:(CGFloat)zoomFactor; virtual int setCameraZoomFactor(float factor) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita index 385deb44f24..12f83e7c774 100644 --- a/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita @@ -14,7 +14,7 @@

public abstract int setEnableSpeakerphone(boolean enabled); - public abstract setEnableSpeakerphone(enabled: boolean): number; + - (int)setEnableSpeakerphone:(BOOL)enableSpeaker; virtual int setEnableSpeakerphone(bool speakerOn) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita b/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita index 8d5a9a79a4d..d43db8a5ee3 100644 --- a/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita +++ b/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita @@ -14,7 +14,7 @@

public abstract int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel); - public abstract setPlaybackAudioFrameBeforeMixingParameters(sampleRate:number,channel:number):number; + public abstract setPlaybackAudioFrameBeforeMixingParameters(sampleRate:number,channel:number):number; - (int)setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:(NSInteger)sampleRate channel:(NSInteger)channel; virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita b/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita index acaf43045ab..9e69c8cbe98 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita @@ -14,7 +14,7 @@

public abstract int startAudioMixing(String filePath, boolean loopback, int cycle, int startPos); - public abstract startAudioMixing(filepath: string, loopback: boolean, cycle: number): number; + public abstract startAudioMixing(filepath: string, loopback: boolean, cycle: number, startpos?:number): number; - (int)startAudioMixing:(NSString* _Nonnull)filePath loopback:(BOOL)loopback cycle:(NSInteger)cycle startPos:(NSInteger)startPos; virtual int startAudioMixing(const char* filePath, bool loopback, int cycle, int startPos) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita b/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita index 76450a9476f..eb3f209ff98 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita @@ -14,7 +14,7 @@

public abstract int startAudioRecording(String filePath, int quality); - public abstract startAudioRecording(filePath: string, quality: Constants.AudioRecordingQualityType): number; + public abstract startAudioRecording(filePath: string, quality: Constants.AudioRecordingQualityType): number;; - (int)startAudioRecording:(NSString * _Nonnull)filePath quality:(AgoraAudioRecordingQuality)quality; virtual int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita b/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita index f9126d754b9..33bb37b78f5 100644 --- a/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita +++ b/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita @@ -14,7 +14,7 @@

public abstract int startRtmpStreamWithoutTranscoding(String url); - + public abstract startRtmpStreamWithoutTranscoding(url:string): number; - (int)startRtmpStreamWithoutTranscoding:(NSString* _Nonnull)url; virtual int startRtmpStreamWithoutTranscoding(const char* url) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index a828da7bf24..991132ce848 100644 --- a/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -15,7 +15,7 @@

public abstract int startScreenCapture(ScreenCaptureParameters screenCaptureParameters); - public abstract startScreenCapture(parameter: ScreenCaptureParameters): number; + public abstract startScreenCapture(screenCaptureParameters: ScreenCaptureParameters): number; - (int)startScreenCapture:(AgoraScreenCaptureParameters2* _Nullable)parameters NS_SWIFT_NAME(startScreenCapture(_:)); #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) virtual int startScreenCapture(const ScreenCaptureParameters2& captureParams) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita b/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita index 709974600b4..8618186f689 100644 --- a/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita +++ b/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita @@ -14,7 +14,7 @@

public abstract int stopAudioRecording(); - public abstract stopAudioRecording(): number; + public abstract stopAudioRecording(): number;; - (int)stopAudioRecording; virtual int stopAudioRecording() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_stopeffect.dita b/dita/RTC-NG/API/api_irtcengine_stopeffect.dita index 046853754b9..10135cb332a 100644 --- a/dita/RTC-NG/API/api_irtcengine_stopeffect.dita +++ b/dita/RTC-NG/API/api_irtcengine_stopeffect.dita @@ -15,7 +15,7 @@

public abstract int stopEffect(int soundId); - + public abstract stopEffect(soundId:number):number; - (int)stopEffect:(int)soundId; virtual int stopEffect(int soundId) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita b/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index f7d4f0adf90..84028bf0c22 100644 --- a/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -16,7 +16,7 @@ public abstract int updateScreenCaptureParameters( ScreenCaptureParameters screenCaptureParameters); - + public abstract updateScreenCaptureParameters(screenCaptureParameters: ScreenCaptureParameters): number; - (int)updateScreenCaptureParameters:(AgoraScreenCaptureParameters * _Nonnull)captureParams; virtual int updateScreenCaptureParameters(const ScreenCaptureParameters& captureParams) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita b/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita index 63b9d01276a..ef9d59005fa 100644 --- a/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita @@ -15,7 +15,7 @@

public abstract int adjustUserPlaybackSignalVolumeEx( int uid, int volume, RtcConnection connection); - + public abstract adjustUserPlaybackSignalVolumeEx(uid:number,volume:number,connection:RtcConnection):number; - (int)adjustUserPlaybackSignalVolumeEx:(NSUInteger)uid volume:(NSInteger)volume connection:(AgoraRtcConnection* _Nonnull)connection; diff --git a/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita b/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita index 96324efecfe..1b92382ab54 100644 --- a/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita @@ -15,7 +15,7 @@

public abstract int enableAudioVolumeIndicationEx( int interval, int smooth, boolean reportVad, RtcConnection connection); - + public abstract enableAudioVolumeIndicationEx(interval:number,smooth:number,reportVad:boolean,connection:RtcConnection):number; - (int)enableAudioVolumeIndicationEx:(NSInteger)interval smooth:(NSInteger)smooth reportVad:(BOOL)reportVad diff --git a/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita b/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita index 75e8eec9116..1780ab555b9 100644 --- a/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita @@ -14,7 +14,7 @@

public abstract int muteRemoteAudioStreamEx(int uid, boolean muted, RtcConnection connection); - + public abstract muteRemoteAudioStreamEx(uid:number,muted:boolean,connection:RtcConnection):number; - (int)muteRemoteAudioStreamEx:(NSUInteger)uid mute:(BOOL)mute connection:(AgoraRtcConnection * _Nonnull)connection; diff --git a/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita b/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita index 9e8ddb4bf2a..dcf6d72d986 100644 --- a/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita @@ -14,7 +14,7 @@

public abstract int muteRemoteVideoStreamEx(int uid, boolean muted, RtcConnection connection); - + public abstract muteRemoteVideoStreamEx(uid:number,muted:boolean,connection:RtcConnection):number; - (int)muteRemoteVideoStreamEx:(NSUInteger)uid mute:(BOOL)mute connection:(AgoraRtcConnection * _Nonnull)connection; diff --git a/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita b/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita index 037910c5096..56d9d8bc80b 100644 --- a/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita @@ -14,7 +14,7 @@

public abstract int sendStreamMessageEx(int streamId, byte[] message, RtcConnection connection); - + public abstract sendStreamMessageEx(streamId:number,message:ArrayBuffer,connection:RtcConnection):number; virtual int sendStreamMessageEx(int streamId, const char* data, size_t length, const RtcConnection& connection) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita b/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita index 41e016f0084..de42d534e09 100644 --- a/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita @@ -15,7 +15,7 @@

public abstract int setRemoteRenderModeEx( int uid, int renderMode, int mirrorMode, RtcConnection connection); - + public abstract setRemoteRenderModeEx(uid:number,renderMode:number,mirrorMode:number,connection:RtcConnection):number; - (int)setRemoteRenderModeEx:(NSUInteger)uid mode:(AgoraVideoRenderMode)mode mirror:(AgoraVideoMirrorMode)mirror diff --git a/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita b/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita index 05d7c22bfa9..6a2e7ecd8e3 100644 --- a/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita @@ -14,7 +14,7 @@

public abstract int setRemoteVideoStreamTypeEx(int uid, int streamType, RtcConnection connection); - + public abstract setRemoteVideoStreamTypeEx(uid:number,streamType:number,connection:RtcConnection):number; - (int)setRemoteVideoStreamEx:(NSUInteger)uid type:(AgoraVideoStreamType)streamType connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(setRemoteVideoStreamEx(_:type:connection:)); diff --git a/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita b/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita index 093f7d085ce..ecd77382cd7 100644 --- a/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita @@ -14,7 +14,7 @@

public abstract int takeSnapshotEx(RtcConnection connection, int uid, String filePath); - + public abstract takeSnapshotEx(connection:RtcConnection,uid:number,filePath:string):number; - (NSInteger)takeSnapshotEx:(AgoraRtcConnection * _Nonnull)connection uid:(NSInteger)uid filePath:(NSString* _Nonnull)filePath; virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const char* filePath) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita b/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita index 87086cb94bd..7d083f8b9f5 100644 --- a/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita @@ -15,7 +15,7 @@

public abstract int updateChannelMediaOptionsEx( ChannelMediaOptions options, RtcConnection connection); - + public abstract updateChannelMediaOptionsEx(options:ChannelMediaOptions,connection:RtcConnection):number; - (int)updateChannelExWithMediaOptions:(AgoraRtcChannelMediaOptions* _Nonnull)mediaOptions connection:(AgoraRtcConnection * _Nonnull)connection; virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions& options, const RtcConnection& connection) = 0; diff --git a/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita b/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita index 2d9be2d80e3..f7dae57b848 100644 --- a/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita +++ b/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita @@ -15,7 +15,7 @@

boolean onLocalAudioSpectrum(AudioSpectrumInfo data); - + onLocalAudioSpectrum?:(data:AudioSpectrumData) => boolean ; - (BOOL)onLocalAudioSpectrum:(NSArray<NSNumber *> * _Nullable)audioSpectrumData; virtual bool onLocalAudioSpectrum(const AudioSpectrumData& data) = 0; DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnLocalAudioSpectrum, const FAudioSpectrumData&, data); diff --git a/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita b/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita index b2582f27ecf..db6d6fcd2cb 100644 --- a/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita +++ b/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita @@ -15,7 +15,7 @@

boolean onRemoteAudioSpectrum(UserAudioSpectrumInfo[] userAudioSpectrumInfos, int spectrumNumber); - + onRemoteAudioSpectrum?:(data:Array<AudioSpectrumInfo>) => boolean ; - (BOOL)onRemoteAudioSpectrum:(NSArray<AgoraAudioSpectrumInfo *> * _Nullable)AudioSpectrumInfo; virtual bool onRemoteAudioSpectrum(const UserAudioSpectrumInfo * spectrums, unsigned int spectrumNumber) = 0; diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onaudiovolumeindication.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onaudiovolumeindication.dita index 8f98d0acf3f..e45e379dcb6 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onaudiovolumeindication.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onaudiovolumeindication.dita @@ -14,7 +14,7 @@

void onAudioVolumeIndication(int volume); - onAudioVolumeIndication?:( speakers:Array<AudioVolumeInfo>, totalVolume:number) => void + onAudioVolumeIndication?:(volume:number) => void - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit volumeIndicationDidReceive:(NSInteger)volume; diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita index 7ef736bb02d..58b3bf5a5ed 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita @@ -15,7 +15,7 @@

void onMetaData(Constants.MediaPlayerMetadataType type, byte[] data); - + onMetaData?:(type:Constants.MediaPlayerMetadataType,data:ArrayBuffer) => void - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didReceiveData:(NSString *_Nullable)data length:(NSInteger)length; diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayercachestats.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayercachestats.dita index 715614747a3..77a870ee51f 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayercachestats.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayercachestats.dita @@ -14,7 +14,7 @@

void onPlayerCacheStats(CacheStatistics stats); - + onPlayerCacheStats?:(stats:CacheStatistics) => void (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit cacheStats:(AgoraMediaPlayerCacheStatistics *_Nonnull)info NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:cacheStats:)); virtual void onPlayerCacheStats(const media::base::CacheStatistics& stats) { (void)stats; diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita index 236bcb188d7..69390eeeff0 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita @@ -15,7 +15,7 @@

void onPlayerEvent(Constants.MediaPlayerEvent eventCode, long elapsedTime, String message); - + onPlayerEvent?:(eventCode:Constants.MediaPlayerEvent,elapsedTime:bigint,message:string) => void (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didOccurEvent:(AgoraMediaPlayerEvent)eventCode elapsedTime:(NSInteger)elapsedTime diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerinfoupdated.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerinfoupdated.dita index af260db1115..475e3827697 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerinfoupdated.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerinfoupdated.dita @@ -15,7 +15,7 @@

void onPlayerInfoUpdated(PlayerUpdatedInfo info); - + onPlayerInfoUpdated?:(info:PlayerUpdatedInfo) => void - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit infoUpdated:(AgoraMediaPlayerUpdatedInfo *_Nonnull)info; virtual void onPlayerInfoUpdated(const media::base::PlayerUpdatedInfo& info) = 0; diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita index 441abfe434c..d3f841c7a78 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita @@ -14,7 +14,7 @@

void onPlayerPlaybackStats(PlayerPlaybackStats stats); - + onPlayerPlaybackStats?:(stats:PlayerPlaybackStats) => void (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit playbackStats:(AgoraMediaPlayerPlaybackStats *_Nonnull)info NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:playbackStats:)); virtual void onPlayerPlaybackStats(const media::base::PlayerPlaybackStats& stats) { (void)stats; diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita index 2303078c688..6423a11e682 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita @@ -15,7 +15,7 @@

void onPlayerStateChanged(Constants.MediaPlayerState state, Constants.MediaPlayerReason reason); - + onPlayerStateChanged?:(state:Constants.MediaPlayerState,reason:Constants.MediaPlayerReason) => void - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didChangedToState:(AgoraMediaPlayerState)state reason:(AgoraMediaPlayerReason)reason NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:didChangedTo:reason:)); diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersrcinfochanged.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersrcinfochanged.dita index 127cbed8e7f..92a80ff27eb 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersrcinfochanged.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersrcinfochanged.dita @@ -15,7 +15,7 @@

void onPlayerSrcInfoChanged(SrcInfo from, SrcInfo to); - + onPlayerSrcInfoChanged?:(from:SrcInfo,to:SrcInfo) => void - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit playerSrcInfoDidChange:(AgoraMediaPlayerSrcInfo *_Nonnull)to from:(AgoraMediaPlayerSrcInfo *_Nonnull)from; virtual void onPlayerSrcInfoChanged(const media::base::SrcInfo& from, const media::base::SrcInfo& to) = 0; diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita index 4dab43866db..a1fbd4deeaf 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita @@ -14,7 +14,7 @@

void onPositionChanged(long positionMs, long timestampMs); - + onPositionChanged?:(positionMs:bigint,timestampMs:bigint) => void - (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit didChangedToPosition:(NSInteger)positionMs atTimestamp:(NSTimeInterval)timestampMs NS_SWIFT_NAME(AgoraMediaPlayer(_:didChangedToPosition:atTimestamp:)); diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita index c6eb44e2d34..a2a5604888e 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita @@ -15,7 +15,7 @@

void onPreloadEvent(String src, Constants.MediaPlayerPreloadEvent event); - + onPreloadEvent?:(src:string,event:Constants.MediaPlayerPreloadEvent) => void - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didPreloadEvent:(AgoraMediaPlayerPreloadEvent)event; diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onlyricresult.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onlyricresult.dita index 5402dea8617..0942220f233 100644 --- a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onlyricresult.dita +++ b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onlyricresult.dita @@ -14,7 +14,7 @@

void onLyricResult(String requestId, long songCode, String lyricUrl, int reason); - + onLyricResult?:(requestId:string,songCode:bigint,lyricUrl:string,reason:Constants.MusicContentCenterStateReason) => void - (void)onLyricResult:(NSString*)requestId songCode:(NSInteger)songCode lyricUrl:(NSString* _Nullable)lyricUrl reason:(AgoraMusicContentCenterStateReason)reason; virtual void onLyricResult(const char* requestId, int64_t songCode, const char* lyricUrl, MusicContentCenterStateReason reason) = 0; onLyricResult?( diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita index b543aab632e..ce1b0a5e72c 100644 --- a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita +++ b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita @@ -14,7 +14,7 @@

void onMusicChartsResult(String requestId, MusicChartInfo[] list, int reason); - + onMusicChartsResult?:(requestId:string,list:MusicChartInfo[],reason:Constants.MusicContentCenterStateReason) => void - (void)onMusicChartsResult:(NSString *)requestId result:(NSArray<AgoraMusicChartInfo*> *)result reason:(AgoraMusicContentCenterStateReason)reason; virtual void onMusicChartsResult(const char* requestId, agora_refptr<MusicChartCollection> result, MusicContentCenterStateReason reason) = 0; onMusicChartsResult?( diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita index 232818807fc..14122214595 100644 --- a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita +++ b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita @@ -15,7 +15,7 @@

void onMusicCollectionResult( String requestId, int page, int pageSize, int total, Music[] list, int reason); - + onMusicCollectionResult?:(requestId:string,page:number,pageSize:number,total:number,list:Music[],reason:Constants.MusicContentCenterStateReason) => void - (void)onMusicCollectionResult:(NSString *)requestId result:(AgoraMusicCollection *)result reason:(AgoraMusicContentCenterStateReason)reason; virtual void onMusicCollectionResult(const char* requestId, agora_refptr<MusicCollection> result, MusicContentCenterStateReason reason) = 0; onMusicCollectionResult?( diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita index 079432c4729..c2fa0c2a2d2 100644 --- a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita +++ b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita @@ -15,7 +15,7 @@

void onPreLoadEvent( String requestId, long songCode, int percent, String lyricUrl, int state, int reason); - + onPreLoadEvent?:(requestId:string,songCode:bigint,percent:number,lyricUrl:string,state:number,reason:Constants.MusicContentCenterStateReason) => void - (void)onPreLoadEvent:(NSString*)requestId songCode:(NSInteger)songCode percent:(NSInteger)percent lyricUrl:(NSString * _Nullable)lyricUrl state:(AgoraMusicContentCenterPreloadState)state reason:(AgoraMusicContentCenterStateReason)reason; virtual void onPreLoadEvent(const char* requestId, int64_t songCode, int percent, const char* lyricUrl, PreloadState state, MusicContentCenterStateReason reason) = 0; onPreLoadEvent?( diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onsongsimpleinforesult.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onsongsimpleinforesult.dita index a72ba0e102c..78c74c90d16 100644 --- a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onsongsimpleinforesult.dita +++ b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onsongsimpleinforesult.dita @@ -14,7 +14,7 @@

void onSongSimpleInfoResult(String requestId, long songCode, String simpleInfo, int reason); - + onSongSimpleInfoResult?:(requestId:string,songCode:bigint,simpleInfo:string,reason:Constants.MusicContentCenterStateReason) => void - (void)onSongSimpleInfoResult:(NSString*)requestId songCode:(NSInteger)songCode simpleInfo:(NSString* _Nullable)simpleInfo reason:(AgoraMusicContentCenterStateReason)reason; virtual void onSongSimpleInfoResult(const char* requestId, int64_t songCode, const char* simpleInfo, MusicContentCenterStateReason reason) = 0; onSongSimpleInfoResult?( diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita index c39f8a9ce20..f6d0827cce1 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita @@ -14,7 +14,7 @@

public void onAudioMixingStateChanged(int state, int reasonCode); - onAudioMixingStateChanged?:(state:number,reason:number) => void + onAudioMixingStateChanged?:(state:Constants.AudioMixingState,reason:Constants.AudioMixingReason) => void - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine audioMixingStateChanged:(AgoraAudioMixingStateType)state reasonCode:(AgoraAudioMixingReasonCode)reasonCode; virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) { diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita index 224eeb4da45..fdedd820270 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita @@ -15,7 +15,7 @@

public void onAudioPublishStateChanged(String channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) {} - + onAudioPublishStateChanged?:(channel:string, oldState:Constants.StreamPublishState, newState:Constants.StreamPublishState, elapseSinceLastState:number) => void; - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine didAudioPublishStateChange:(NSString * _Nonnull)channelId oldState:(AgoraStreamPublishState)oldState diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita index 2805937bb3a..a871d5ffc78 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita @@ -15,7 +15,7 @@

public void onAudioSubscribeStateChanged( String channel, int uid, int oldState, int newState, int elapseSinceLastState) {} - + onAudioSubscribeStateChanged?:(channel:string,uid:number,oldState:Constants.StreamSubscribeState,newState:Constants.StreamSubscribeState,elapseSinceLastState:number) =>void; - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine didAudioSubscribeStateChange:(NSString * _Nonnull)channelId uid:(unsigned int)uid diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita index 30e9e558f3c..8d9d0978fe6 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita @@ -14,7 +14,7 @@

public void onChannelMediaRelayStateChanged(int state, int code) {} - + onChannelMediaRelayStateChanged?:(state:Constants.ChannelMediaRelayState,code:Constants.ChannelMediaRelayError) =>void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state error:(AgoraChannelMediaRelayError)error; diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita index 1d66fae9583..ed2e4c08aba 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita @@ -15,7 +15,7 @@

public void onError(int err) {} - onError?:(err:number,message:string) => void + onError?:(err:Constants.ErrorCode,message:string) => void - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurError:(AgoraErrorCode)errorCode; virtual void onError(int err, const char* msg) { diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita index 31ec85bd6b1..3f12bccb3e8 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita @@ -16,7 +16,7 @@ public void onFirstLocalVideoFrame( Constants.VideoSourceType source, int width, int height, int elapsed) {} - + onFirstLocalVideoFrame?:(source:Constants.VideoSourceType,width:number,height:number,elapsed:number) =>void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalVideoFrameWithSize:(CGSize)size elapsed:(NSInteger)elapsed diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita index 76df41ef904..aa7f889270e 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita @@ -14,7 +14,7 @@

public void onFirstRemoteVideoFrame(int uid, int width, int height, int elapsed) {} - + onFirstRemoteVideoFrame?:(uid:number,width:number,height:number,elapsed:number) =>void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstRemoteVideoFrameOfUid:(NSUInteger)uid size:(CGSize)size elapsed:(NSInteger)elapsed; virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed) { diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita index 3a11969fb0b..1f4db2c4697 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita @@ -14,7 +14,7 @@

public void onTokenPrivilegeWillExpire(String token) {} - + onTokenPrivilegeWillExpire?: (token:string) => void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine tokenPrivilegeWillExpire:(NSString *_Nonnull)token; virtual void onTokenPrivilegeWillExpire(const char* token) { diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita index 6b7895b5b7c..c6174206da6 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita @@ -14,7 +14,7 @@

public void onUserMuteAudio(int uid, boolean muted) {} - + onUserMuteAudio?:(uid:number,muted:boolean) =>void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didAudioMuted:(BOOL)muted byUid:(NSUInteger)uid; virtual void onUserMuteAudio(uid_t uid, bool muted) { (void)uid; diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita index aba321dbe96..0b0aff840ab 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita @@ -14,7 +14,7 @@

public void onUserMuteVideo(int uid, boolean muted) {} - + onUserMuteVideo?:(uid:number,muted:boolean) =>void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didVideoMuted:(BOOL)muted byUid:(NSUInteger)uid virtual void onUserMuteVideo(uid_t uid, bool muted) { (void)uid; diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita index 3a94fd31033..f4ff60f98be 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita @@ -15,7 +15,7 @@

public void onVideoSubscribeStateChanged( String channel, int uid, int oldState, int newState, int elapseSinceLastState) {} - + onVideoSubscribeStateChanged?:(channel:string,uid:number,oldState:Constants.StreamSubscribeState,newState:Constants.StreamSubscribeState,elapseSinceLastState:number) =>void; - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine didVideoSubscribeStateChange:(NSString * _Nonnull)channelId uid:(unsigned int)uid diff --git a/dita/RTC-NG/API/class_advanceoptions.dita b/dita/RTC-NG/API/class_advanceoptions.dita index 82aa0a26f7d..95698d192d6 100644 --- a/dita/RTC-NG/API/class_advanceoptions.dita +++ b/dita/RTC-NG/API/class_advanceoptions.dita @@ -23,11 +23,11 @@ } } export class AdvanceOptions { - public encodingPreference:EncodingPrefence = EncodingPrefence.PREFER_AUTO; - public compressionPreference:CompressionPrefence = CompressionPrefence.PREFER_LOW_LATENCY; - constructor() { - } - } + public encodingPreference:EncodingPrefence = EncodingPrefence.PREFER_AUTO; + public compressionPreference:CompressionPrefence = CompressionPrefence.PREFER_LOW_LATENCY; + constructor() { + } +} __attribute__((visibility("default"))) @interface AgoraAdvancedVideoOptions : NSObject @property(assign, nonatomic) AgoraEncodingPreference encodingPreference; @property(assign, nonatomic) AgoraCompressionPreference compressionPreference; diff --git a/dita/RTC-NG/API/class_audiospectrumdata.dita b/dita/RTC-NG/API/class_audiospectrumdata.dita index 126297193f2..da3718f45dd 100644 --- a/dita/RTC-NG/API/class_audiospectrumdata.dita +++ b/dita/RTC-NG/API/class_audiospectrumdata.dita @@ -10,7 +10,10 @@ private float[] audioSpectrumData; private int dataLength; } - + export class AudioSpectrumInfo { + public uid:number = 0 ; + public audioSpectrumData = new AudioSpectrumData(); +} struct AudioSpectrumData { const float *audioSpectrumData; diff --git a/dita/RTC-NG/API/class_cachestatistics.dita b/dita/RTC-NG/API/class_cachestatistics.dita index 9e615b81e04..2f86755c324 100644 --- a/dita/RTC-NG/API/class_cachestatistics.dita +++ b/dita/RTC-NG/API/class_cachestatistics.dita @@ -17,7 +17,15 @@ private long cacheSize; private long downloadSize; } - + export class CacheStatistics +{ + + public fileSize:number = 0 + + public cacheSize:number = 0 + + public downloadSize:number = 0 +} __attribute__((visibility("default"))) @interface AgoraMediaPlayerCacheStatistics : NSObject @property(assign, nonatomic) NSInteger fileSize; @property(assign, nonatomic) NSInteger cacheSize; diff --git a/dita/RTC-NG/API/class_channelmediaoptions.dita b/dita/RTC-NG/API/class_channelmediaoptions.dita index 4660733227d..e4b7016168b 100644 --- a/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -664,67 +664,67 @@ class ChannelMediaOptions { public Boolean isAudioFilterable; } export class ChannelMediaOptions { + + public publishCameraTrack?:boolean; + + public publishSecondaryCameraTrack?:boolean; + + public publishMicrophoneTrack?:boolean; + + public publishScreenCaptureVideo?:boolean; + + public publishScreenCaptureAudio?:boolean; + + public publishCustomAudioTrack?:boolean; + + public publishCustomAudioTrackId?:number; + + public publishCustomVideoTrack?:boolean; + + public publishEncodedVideoTrack?:boolean; + + public publishMediaPlayerAudioTrack?:boolean; + + public publishMediaPlayerVideoTrack?:boolean; + + public publishTranscodedVideoTrack?:boolean; + + public publishMixedAudioTrack?:boolean; + + public autoSubscribeAudio?:boolean; + + public autoSubscribeVideo?:boolean; + + public enableAudioRecordingOrPlayout?:boolean; + + public publishMediaPlayerId?:number; + + public clientRoleType?:number; + + public audienceLatencyLevel?:number; + + public defaultVideoStreamType?:number; + + public channelProfile?:number; + + public audioDelayMs?:number; + + public mediaPlayerAudioDelayMs?:number; - public publishCameraTrack?:boolean; - - public publishSecondaryCameraTrack?:boolean; - - public publishMicrophoneTrack?:boolean; - - public publishScreenCaptureVideo?:boolean; - - public publishScreenCaptureAudio?:boolean; - - public publishCustomAudioTrack?:boolean; - - public publishCustomAudioTrackId?:number; - - public publishCustomVideoTrack?:boolean; - - public publishEncodedVideoTrack?:boolean; - - public publishMediaPlayerAudioTrack?:boolean; - - public publishMediaPlayerVideoTrack?:boolean; - - public publishTranscodedVideoTrack?:boolean; - - public publishMixedAudioTrack?:boolean; - - public autoSubscribeAudio?:boolean; - - public autoSubscribeVideo?:boolean; - - public enableAudioRecordingOrPlayout?:boolean; - - public publishMediaPlayerId?:number; - - public clientRoleType?:number; - - public audienceLatencyLevel?:number; - - public defaultVideoStreamType?:number; - - public channelProfile?:number; - - public audioDelayMs?:number; - - public mediaPlayerAudioDelayMs?:number; - - public enableBuiltInMediaEncryption?:boolean; - - public publishRhythmPlayerTrack?:boolean; - - public isInteractiveAudience?:boolean; - - public customVideoTrackId?:number; - - public isAudioFilterable?:boolean; - - public startPreview?:boolean; - public constructor() { - } - } + public enableBuiltInMediaEncryption?:boolean; + + public publishRhythmPlayerTrack?:boolean; + + public isInteractiveAudience?:boolean; + + public customVideoTrackId?:number; + + public isAudioFilterable?:boolean; + + public startPreview?:boolean; + public constructor() { + } +} __attribute__((visibility("default"))) @interface AgoraRtcChannelMediaOptions : NSObject @property(assign, nonatomic) BOOL publishCameraTrack; @property(assign, nonatomic) BOOL publishSecondaryCameraTrack; diff --git a/dita/RTC-NG/API/class_climaxsegment.dita b/dita/RTC-NG/API/class_climaxsegment.dita index 1aaad90b47b..aeafde4bdce 100644 --- a/dita/RTC-NG/API/class_climaxsegment.dita +++ b/dita/RTC-NG/API/class_climaxsegment.dita @@ -26,7 +26,11 @@ return endTimeMs; } } - + export class ClimaxSegment +{ + public startTimeMs:number = 0 + public endTimeMs:number = 0 +} __attribute__((visibility("default"))) @interface AgoraClimaxSegment : NSObject @property(nonatomic, assign) NSInteger startTimeMs; @property(nonatomic, assign) NSInteger endTimeMs; diff --git a/dita/RTC-NG/API/class_contentinspectconfig.dita b/dita/RTC-NG/API/class_contentinspectconfig.dita index 4de270babb1..97b4a41654b 100644 --- a/dita/RTC-NG/API/class_contentinspectconfig.dita +++ b/dita/RTC-NG/API/class_contentinspectconfig.dita @@ -34,7 +34,17 @@ moduleCount = 0; } } - + export class ContentInspectConfig { + public static readonly MAX_CONTENT_INSPECT_MODULE_COUNT:number = 32; + + public extraInfo?:string; + + public serverConfig?:string; + + public modules? :Array<ContentInspectModule>; + + public moduleCount:number = 0; +} __attribute__((visibility("default"))) @interface AgoraContentInspectConfig: NSObject @property (nonatomic, copy) NSString* _Nullable extraInfo; @property (nonatomic, copy) NSString* _Nullable serverConfig; diff --git a/dita/RTC-NG/API/class_contentinspectmodule.dita b/dita/RTC-NG/API/class_contentinspectmodule.dita index 382fa1f1fd1..fa4fc7adb22 100644 --- a/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/dita/RTC-NG/API/class_contentinspectmodule.dita @@ -13,7 +13,12 @@ type = CONTENT_INSPECT_TYPE_INVALID; interval = 0; } - + export class ContentInspectModule { + + public type:Constants.ContentInspectType = Constants.ContentInspectType.INVALID; + + public interval:number = 0; +} __attribute__((visibility("default"))) @interface AgoraContentInspectModule: NSObject @property (assign, nonatomic) AgoraContentInspectType type; diff --git a/dita/RTC-NG/API/class_logconfig.dita b/dita/RTC-NG/API/class_logconfig.dita index 16ea5ef428a..61e5c747b82 100644 --- a/dita/RTC-NG/API/class_logconfig.dita +++ b/dita/RTC-NG/API/class_logconfig.dita @@ -11,7 +11,14 @@ public int fileSizeInKB; public int level = Constants.LogLevel.getValue(Constants.LogLevel.LOG_LEVEL_INFO); } - + export class LogConfig { + + public filePath:string = ''; + + public fileSizeInKB:number = 2048; + + public level: Constants.LogLevel = Constants.LogLevel.INFO; +} __attribute__((visibility("default"))) @interface AgoraLogConfig: NSObject @property (copy, nonatomic) NSString * _Nullable filePath; @property (assign, nonatomic) NSInteger fileSizeInKB; diff --git a/dita/RTC-NG/API/class_mediasource.dita b/dita/RTC-NG/API/class_mediasource.dita index 5adda6d0bbf..b26e4cb2097 100644 --- a/dita/RTC-NG/API/class_mediasource.dita +++ b/dita/RTC-NG/API/class_mediasource.dita @@ -17,7 +17,25 @@ boolean enableMultiAudioTrack; IMediaPlayerCustomDataProvider provider; } - + export class MediaPlayerSource +{ + + public url:string = "" + + public uri:string = "" + + public startPos:number = 0 + + public autoPlay:boolean = true ; + + public enableCache:boolean = false ; + + public enableMultiAudioTrack:boolean = false ; + + public isAgoraSource?:Boolean + + public isLiveSource?:Boolean +} __attribute__((visibility("default"))) @interface AgoraMediaSource : NSObject @property(copy, nonatomic) NSString *_Nullable url; @property(copy, nonatomic) NSString *_Nullable uri; diff --git a/dita/RTC-NG/API/class_music.dita b/dita/RTC-NG/API/class_music.dita index fa9359071fe..8461efe6bbe 100644 --- a/dita/RTC-NG/API/class_music.dita +++ b/dita/RTC-NG/API/class_music.dita @@ -86,7 +86,31 @@ return climaxSegments; } } - + export class Music +{ + + public songCode:bigint = BigInt(0) + + public name:string = "" + + public singer:string = "" + + public poster:string = "" + + public releaseTime:string = "" + + public type:number = 0 + + public pitchType:number = 0 + + public durationS:number = 0 + + public lyricTypes?:number[] + + public mvProperties?:MvProperty[] + + public climaxSegments?:ClimaxSegment[] +} __attribute__((visibility("default"))) @interface AgoraMusic : NSObject @property(nonatomic, assign) NSInteger songCode; @property(nonatomic, assign) NSInteger type; diff --git a/dita/RTC-NG/API/class_musiccacheinfo.dita b/dita/RTC-NG/API/class_musiccacheinfo.dita index 31ef0e3e934..680470d16fc 100644 --- a/dita/RTC-NG/API/class_musiccacheinfo.dita +++ b/dita/RTC-NG/API/class_musiccacheinfo.dita @@ -12,7 +12,13 @@ public MusicCacheInfo() {} } - + export class MusicCacheInfo +{ + + public songCode:bigint = BigInt(0) + + public status:number = 0 +} __attribute__((visibility("default"))) @interface AgoraMusicCacheInfo : NSObject @property(nonatomic, assign) NSInteger songCode; diff --git a/dita/RTC-NG/API/class_musicchartinfo.dita b/dita/RTC-NG/API/class_musicchartinfo.dita index 74afa74bab4..8e06407e6dc 100644 --- a/dita/RTC-NG/API/class_musicchartinfo.dita +++ b/dita/RTC-NG/API/class_musicchartinfo.dita @@ -26,7 +26,13 @@ return type; } } - + export class MusicChartInfo +{ + + public name:string = "" + + public type:number = 0 +} __attribute__((visibility("default"))) @interface AgoraMusicChartInfo : NSObject @property (nonatomic, copy) NSString *chartName; @property (nonatomic, assign) NSInteger identify; diff --git a/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita b/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita index 6f642dc4453..eccaff91c37 100644 --- a/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita +++ b/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita @@ -22,7 +22,21 @@ eventHandler = null; } } - + export class MusicContentCenterConfiguration +{ + + public appId:string = "" + + public token:string = "" + + public mccUid:number = 0 + + public maxCacheSize:number = 0 + + public eventHandler?:IMusicContentCenterEventHandler + + public mccDomain:string = "" +} __attribute__((visibility("default"))) @interface AgoraMusicContentCenterConfig : NSObject @property(assign, nonatomic) AgoraRtcEngineKit* _Nullable rtcEngine; @property (nonatomic, copy) NSString *appId; diff --git a/dita/RTC-NG/API/class_playerplaybackstats.dita b/dita/RTC-NG/API/class_playerplaybackstats.dita index fb42818cc20..f197d1704cc 100644 --- a/dita/RTC-NG/API/class_playerplaybackstats.dita +++ b/dita/RTC-NG/API/class_playerplaybackstats.dita @@ -12,7 +12,17 @@ private long audioBitrateInKbps; private long totalBitrateInKbps; } - + export class PlayerPlaybackStats +{ + + public videoFps:number = 0 + + public videoBitrateInKbps:number = 0 + + public audioBitrateInKbps:number = 0 + + public totalBitrateInKbps:number = 0 +} __attribute__((visibility("default"))) @interface AgoraMediaPlayerPlaybackStats : NSObject @property(assign, nonatomic) NSInteger videoFps; @property(assign, nonatomic) NSInteger videoBitrateInKbps; diff --git a/dita/RTC-NG/API/class_playerstreaminfo.dita b/dita/RTC-NG/API/class_playerstreaminfo.dita index 072bdf9e0d6..6edcbf45253 100644 --- a/dita/RTC-NG/API/class_playerstreaminfo.dita +++ b/dita/RTC-NG/API/class_playerstreaminfo.dita @@ -23,7 +23,22 @@ public MediaStreamInfo() {} } - + export class MediaStreamInfo +{ + public streamIndex:number = 0 + public mediaStreamType:number = 0 + public codecName:string = "" + public language:string = "" + public videoFrameRate:number = 0 + public videoBitRate:number = 0 + public videoWidth:number = 0 + public videoHeight:number = 0 + public videoRotation:number = 0 + public audioSampleRate:number = 0 + public audioChannels:number = 0 + public audioBytesPerSample:number = 0 + public duration:bigint = BigInt(0) +} __attribute__((visibility("default"))) @interface AgoraMediaStreamInfo : NSObject @property(nonatomic, assign) NSInteger streamIndex; diff --git a/dita/RTC-NG/API/class_playerupdatedinfo.dita b/dita/RTC-NG/API/class_playerupdatedinfo.dita index 608c9697e47..d92c49c868d 100644 --- a/dita/RTC-NG/API/class_playerupdatedinfo.dita +++ b/dita/RTC-NG/API/class_playerupdatedinfo.dita @@ -14,7 +14,23 @@ private long audioChannels; private long audioBitsPerSample; } - + export class PlayerUpdatedInfo +{ + + public internalPlayerUuid:string = "" + + public deviceId:string = "" + + public videoHeight:number = 0 + + public videoWidth:number = 0 + + public audioSampleRate:number = 0 + + public audioChannels:number = 0 + + public audioBitsPerSample:number = 0 +} __attribute__((visibility("default"))) @interface AgoraMediaPlayerUpdatedInfo : NSObject @property(copy, nonatomic) NSString *_Nullable deviceId; @property(assign, nonatomic) NSInteger videoHeight; diff --git a/dita/RTC-NG/API/class_rtcengineconfig.dita b/dita/RTC-NG/API/class_rtcengineconfig.dita index 8050d83704f..c2f9ab9621b 100644 --- a/dita/RTC-NG/API/class_rtcengineconfig.dita +++ b/dita/RTC-NG/API/class_rtcengineconfig.dita @@ -29,6 +29,7 @@ public mContext:Context | null = null; public mAppId:string | null = null; public mEventHandler: IRtcEngineEventHandler | null = null; + public mLogConfig?:LogConfig; } __attribute__((visibility("default"))) @interface AgoraRtcEngineConfig: NSObject diff --git a/dita/RTC-NG/API/class_segmentationproperty.dita b/dita/RTC-NG/API/class_segmentationproperty.dita index ea04676fece..0db625d5b38 100644 --- a/dita/RTC-NG/API/class_segmentationproperty.dita +++ b/dita/RTC-NG/API/class_segmentationproperty.dita @@ -22,8 +22,10 @@ } } export class SegmentationProperty { + public static readonly SEG_MODEL_AI:number = 1; + public static readonly SEG_MODEL_GREEN:number = 2; - public modelType:Constants.SegModelType = Constants.SegModelType.AI; + public modelType:number = SegmentationProperty.SEG_MODEL_AI; public greenCapacity:number = 0.5; } diff --git a/dita/RTC-NG/API/class_srcinfo.dita b/dita/RTC-NG/API/class_srcinfo.dita index bf7ed1c1392..719883a7473 100644 --- a/dita/RTC-NG/API/class_srcinfo.dita +++ b/dita/RTC-NG/API/class_srcinfo.dita @@ -12,7 +12,13 @@ public SrcInfo() {} } - + export class SrcInfo +{ + + public bitrateInKbps:number = 0 + + public name:string = "" +} __attribute__((visibility("default"))) @interface AgoraMediaPlayerSrcInfo : NSObject @property(assign, nonatomic) int bitrateInKbps; @property(copy, nonatomic) NSString *_Nullable name; diff --git a/dita/RTC-NG/API/class_videocanvas.dita b/dita/RTC-NG/API/class_videocanvas.dita index 951ee55a61e..6d2b10c2b00 100644 --- a/dita/RTC-NG/API/class_videocanvas.dita +++ b/dita/RTC-NG/API/class_videocanvas.dita @@ -58,6 +58,7 @@ public uid:number = 0; public renderMode:number = VideoCanvas.RENDER_MODE_HIDDEN; public mirrorMode:number = 0; + public sourceType:Constants.VideoSourceType = Constants.VideoSourceType.CAMERA_PRIMARY; constructor(componentId:string) { this.xcomponentId = componentId; } diff --git a/dita/RTC-NG/API/class_virtualbackgroundsource.dita b/dita/RTC-NG/API/class_virtualbackgroundsource.dita index aa6dc9ebd9a..1c11dcbd683 100644 --- a/dita/RTC-NG/API/class_virtualbackgroundsource.dita +++ b/dita/RTC-NG/API/class_virtualbackgroundsource.dita @@ -36,13 +36,29 @@ export class VirtualBackgroundSource { - public backgroundSourceType: Constants.VirtualBackgroundType = Constants.VirtualBackgroundType.COLOR; + public static readonly BACKGROUND_NONE:number = 0; + + public static readonly BACKGROUND_COLOR:number = 1; + + public static readonly BACKGROUND_IMG:number = 2; + + public static readonly BACKGROUND_BLUR:number = 3; + + public static readonly BACKGROUND_VIDEO:number = 4; + + public static readonly BLUR_DEGREE_LOW:number = 1; + + public static readonly BLUR_DEGREE_MEDIUM:number = 2; + + public static readonly BLUR_DEGREE_HIGH:number = 3; + + public backgroundSourceType:number = VirtualBackgroundSource.BACKGROUND_COLOR; public color:number = 0xffffff; - public source:string | null = null; + public source?:string; - public blurDegree:Constants.VirtualBackgroundBlurDegree = Constants.VirtualBackgroundBlurDegree.HIGH; + public blurDegree:number = VirtualBackgroundSource.BLUR_DEGREE_HIGH; } __attribute__((visibility("default"))) @interface AgoraVirtualBackgroundSource : NSObject @property(nonatomic, assign) AgoraVirtualBackgroundSourceType backgroundSourceType NS_SWIFT_NAME(backgroundSourceType); From a1fa01200698a6f29c7797d9d723e5bd1c9997df Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:40:35 +0800 Subject: [PATCH 02/20] 1 --- .../api_irtcengine_startscreencapture.dita | 4 +- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 56 ++++++------ .../config/keys-rtc-ng-api-harmony.ditamap | 86 +++++++++---------- 3 files changed, 73 insertions(+), 73 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index a828da7bf24..c3ee036e869 100644 --- a/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -73,8 +73,8 @@ parameters screenCaptureParameters - captureParams - 屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080,即 2,073,600 像素。该像素值为计费标准。详见 + captureParams + 屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080,即 2,073,600 像素。该像素值为计费标准。详见

diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 89121d8e9b9..12ba32f1862 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -119,7 +119,7 @@ - + @@ -233,7 +233,7 @@ - + @@ -281,11 +281,11 @@ - + - + @@ -402,8 +402,8 @@ - - + + @@ -411,7 +411,7 @@ - + @@ -446,13 +446,13 @@ - + - + @@ -461,7 +461,7 @@ - + @@ -471,7 +471,7 @@ - + @@ -497,11 +497,11 @@ - - - + + + - + @@ -529,7 +529,7 @@ - + @@ -588,7 +588,7 @@ - + @@ -641,25 +641,25 @@ - + - - + + - + - - + + - + - + @@ -676,7 +676,7 @@ - + @@ -699,11 +699,11 @@ - + - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 8795eee2fe2..ad17b13d223 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -389,7 +389,7 @@ - + @@ -593,14 +593,14 @@ - + registerAudioFrameObserver - + registerVideoFrameObserver @@ -1209,7 +1209,7 @@ - + adjustUserPlaybackSignalVolumeEx @@ -1237,7 +1237,7 @@ - + enableAudioVolumeIndicationEx @@ -1287,14 +1287,14 @@ - + muteRemoteAudioStreamEx - + muteRemoteVideoStreamEx @@ -1315,7 +1315,7 @@ - + sendCustomReportMessageEx @@ -1329,7 +1329,7 @@ - + setRemoteRenderModeEx @@ -1343,7 +1343,7 @@ - + setRemoteVideoStreamTypeEx @@ -1406,14 +1406,14 @@ - + takeSnapshotEx - + updateChannelMediaOptionsEx @@ -1527,7 +1527,7 @@ - + updateScreenCaptureParameters @@ -1564,7 +1564,7 @@ - + setAudioMixingPlaybackSpeed @@ -1621,14 +1621,14 @@ - + getAudioMixingPlayoutVolume - + getAudioMixingPublishVolume @@ -2045,7 +2045,7 @@ - + startRtmpStreamWithoutTranscoding @@ -2359,7 +2359,7 @@ - + isCameraFaceDetectSupported @@ -2375,7 +2375,7 @@ - + setEnableSpeakerphone @@ -2727,7 +2727,7 @@ - + @@ -2744,7 +2744,7 @@ - + registerAudioFrameObserver @@ -2789,7 +2789,7 @@ - + @@ -3058,7 +3058,7 @@ - + isCameraZoomSupported @@ -3079,7 +3079,7 @@ - + isCameraExposurePositionSupported @@ -3093,7 +3093,7 @@ - + isCameraAutoFocusFaceModeSupported @@ -3121,21 +3121,21 @@ - + setCameraExposurePosition - + setCameraTorchOn - + setCameraAutoFocusFaceModeEnabled @@ -3252,7 +3252,7 @@ - + @@ -3415,7 +3415,7 @@ - + @@ -3460,7 +3460,7 @@ - + enableContentInspect @@ -3546,7 +3546,7 @@ - + getErrorDescription @@ -3560,7 +3560,7 @@ - + getSdkVersion @@ -4005,42 +4005,42 @@ - + onMetaData - + onPlayerCacheStats - + onPlayerEvent - + onPlayerPlaybackStats - + onPlayerStateChanged - + onPositionChanged @@ -4068,7 +4068,7 @@ - + onPreloadEvent @@ -4082,14 +4082,14 @@ - + onPlayerSrcInfoChanged - + onPlayerInfoUpdated @@ -4244,7 +4244,7 @@ - + From 19bbec81f4941d08d6998a1c5c92e08f99c89f92 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 23 Aug 2024 14:40:39 +0800 Subject: [PATCH 03/20] 1 --- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 12ba32f1862..26f8065d679 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -387,7 +387,7 @@ - + From 1b7e7d34e5f2507c143a0c73656449f923480b68 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 23 Aug 2024 16:29:13 +0800 Subject: [PATCH 04/20] 1 --- ...venthandler_onaudiomixingstatechanged.dita | 10 +++--- .../config/keys-rtc-ng-api-harmony.ditamap | 32 +++++++++++++------ 2 files changed, 28 insertions(+), 14 deletions(-) diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita index c39f8a9ce20..828c4a3af2f 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita @@ -42,8 +42,8 @@ reasonCode:(AgoraAudioMixingReasonCode)reasonCode; state - 音乐文件播放状态。详见 -

+ 音乐文件播放状态。详见 +

  • (710): 音乐文件正常播放。
  • (711): 音乐文件暂停播放。
  • @@ -56,9 +56,9 @@ reasonCode:(AgoraAudioMixingReasonCode)reasonCode; reasonCode - reason - 错误码。详见 -

    + reason + 错误码。详见 +

    • (0): 正常。
    • (701): 音乐文件打开出错。
    • diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index ad17b13d223..d84bda45962 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -3845,7 +3845,7 @@ - + onAudioPublishStateChanged @@ -3861,7 +3861,7 @@ - + onAudioSubscribeStateChanged @@ -4177,7 +4177,7 @@ - + onChannelMediaRelayStateChanged @@ -6228,6 +6228,13 @@ + + + + AudioMixingReason + + + @@ -6277,45 +6284,52 @@ + + + + AudioMixingState + + + - AUDIO_MIXING_STATE_PLAYING + PLAYING - AUDIO_MIXING_STATE_PAUSED + PAUSED - AUDIO_MIXING_STATE_STOPPED + STOPPED - AUDIO_MIXING_STATE_FAILED + FAILED - AUDIO_MIXING_STATE_COMPLETED + COMPLETED - AUDIO_MIXING_STATE_ALL_LOOPS_COMPLETED + ALL_LOOPS_COMPLETED From f0db5f136ff9db104b0cf3f2f939d0c3860dbe36 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 23 Aug 2024 17:54:11 +0800 Subject: [PATCH 05/20] 1 --- .../API/callback_irtcengineeventhandler_onerror.dita | 4 ++-- dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita index 1d66fae9583..2ed1c8a0f1a 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita @@ -42,14 +42,14 @@ errorCode - err + err 错误码。详见 msg 错误描述。 - + err 错误码。 diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index d84bda45962..ef36781589f 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -3717,7 +3717,7 @@ - + onUserMuteAudio @@ -3759,7 +3759,7 @@ - + onTokenPrivilegeWillExpire @@ -3838,7 +3838,7 @@ - + onFirstLocalVideoFrame @@ -3875,7 +3875,7 @@ - + onFirstRemoteVideoFrame @@ -3910,7 +3910,7 @@ - + onUserMuteVideo @@ -3924,7 +3924,7 @@ - + onVideoSubscribeStateChanged From ef237394923098e9dfae850c3c477bc33769edfd Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Mon, 26 Aug 2024 17:32:56 +0800 Subject: [PATCH 06/20] 1 --- .../API/api_imediaplayer_setaudiopitch.dita | 4 + dita/RTC-NG/API/rtc_api_overview.dita | 26 +- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 183 +++++++------ .../api_irtcengine_setremoterendermode.dita | 2 +- .../config/keys-rtc-ng-api-harmony.ditamap | 67 ++--- .../config/keys-rtc-ng-links-harmony.ditamap | 2 +- .../config/relations-rtc-ng-api.ditamap | 247 +++++++++--------- 7 files changed, 259 insertions(+), 272 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita b/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita index a02da6918df..0925ccbb471 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita @@ -35,6 +35,10 @@ + + pitch + 按半音音阶调整本地播放的音乐文件的音调,默认值为 0,即不调整音调。取值范围为 [-12,12],每相邻两个值的音高距离相差半音。取值的绝对值越大,音调升高或降低得越多。 +
<ph keyref="return-section-title"/> diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index 976c6042e18..cd1746edff4 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -557,7 +557,7 @@ 方法/回调 描述 - + @@ -1521,7 +1521,7 @@
-
+
虚拟节拍器 @@ -2118,7 +2118,7 @@ - + @@ -2255,7 +2255,7 @@ (仅适用于 Android 和 iOS) - + (仅适用于 Android 和 iOS) @@ -2585,7 +2585,7 @@ (仅适用于 Android)
-
+
插件相关 @@ -2600,7 +2600,7 @@ - + @@ -2608,31 +2608,31 @@ - + - + - + - + - + - + - + diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 26f8065d679..ba7dc031c23 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -19,15 +19,15 @@ - + - + - + @@ -37,7 +37,7 @@ - + @@ -48,7 +48,7 @@ - + @@ -61,47 +61,47 @@ - + - + - + - + - + - + - + - - - + + + - + - + - + @@ -112,9 +112,9 @@ - - - + + + @@ -124,14 +124,14 @@ - + - + - + @@ -139,11 +139,11 @@ - + - + @@ -152,8 +152,8 @@ - - + + @@ -172,31 +172,31 @@ - - - - - + + + + + - - - - - + + + + + - - - - - - - - + + + + + + + + - + @@ -230,10 +230,10 @@ - + - + @@ -256,9 +256,9 @@ - + - + @@ -266,10 +266,10 @@ - + - + @@ -288,7 +288,7 @@ - + @@ -297,14 +297,14 @@ - - - - - - - - + + + + + + + + @@ -312,23 +312,23 @@ - + - + - + - + - + @@ -336,25 +336,25 @@ - + - + - + - + @@ -413,7 +413,7 @@ - + @@ -455,7 +455,6 @@ - @@ -495,23 +494,23 @@ - + - - - + + + - - - - - - + + + + + + @@ -582,12 +581,12 @@ - + - + @@ -606,10 +605,10 @@ - - - - + + + + @@ -676,7 +675,7 @@ - + @@ -684,7 +683,7 @@ - + @@ -711,8 +710,6 @@ - - diff --git a/dita/RTC-NG/archive/api_irtcengine_setremoterendermode.dita b/dita/RTC-NG/archive/api_irtcengine_setremoterendermode.dita index 622150c5845..edcbb009bcf 100644 --- a/dita/RTC-NG/archive/api_irtcengine_setremoterendermode.dita +++ b/dita/RTC-NG/archive/api_irtcengine_setremoterendermode.dita @@ -14,7 +14,7 @@

public abstract int setRemoteRenderMode(int userId, int renderMode); - public abstract setRemoteRenderMode(uid: number, renderMode: number, mirrorMode: number): number; + - (int)setRemoteRenderMode:(NSUInteger)uid mode:(AgoraVideoRenderMode) mode; virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode) = 0; diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index ef36781589f..719ce6436df 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -23,6 +23,14 @@ + + + + API 列表 + API List + + + @@ -187,7 +195,7 @@ - + IBaseSpatialAudioEngine @@ -208,21 +216,21 @@ - + IMusicContentCenterEventHandler - + IAgoraMusicPlayer - + IAgoraMusicContentCenter @@ -740,13 +748,6 @@ - - - - openWithCustomSource - - - @@ -1025,7 +1026,7 @@ - + setRemoteRenderMode [1/2] @@ -1315,7 +1316,7 @@ - + sendCustomReportMessageEx @@ -1427,84 +1428,84 @@ - + startRtmpStreamWithoutTranscodingEx - + startRtmpStreamWithTranscodingEx - + updateRtmpTranscodingEx - + stopRtmpStreamEx - + startOrUpdateChannelMediaRelayEx - + pauseAllChannelMediaRelayEx - + muteLocalAudioStreamEx - + muteLocalVideoStreamEx - + muteAllRemoteAudioStreamsEx - + muteAllRemoteVideoStreamsEx - + stopChannelMediaRelayEx - + resumeAllChannelMediaRelayEx @@ -2744,7 +2745,7 @@ - + registerAudioFrameObserver @@ -2945,20 +2946,6 @@ - - - - setEncryptionMode - - - - - - - setEncryptionSecret - - - diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-harmony.ditamap index 7306c00e8b4..92270584b53 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-harmony.ditamap @@ -3,7 +3,7 @@ Keys RTC NG Android Links - + 音频路由 diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index b49a666bf6c..b5902edde4b 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -2197,8 +2197,8 @@ - - + + @@ -2208,9 +2208,9 @@ - - - + + + @@ -2232,30 +2232,30 @@ - - - + + + - + - + - - + + - + - - + + @@ -2266,10 +2266,10 @@ - + - + @@ -2278,19 +2278,19 @@ - + - - + + - - + + - + @@ -2299,14 +2299,14 @@ - + - - + + @@ -2326,8 +2326,8 @@ - - + + @@ -2347,18 +2347,18 @@ - - + + - - + + - - + + - + @@ -2375,15 +2375,15 @@ - + - - - - - - + + + + + + @@ -2391,7 +2391,7 @@ - + @@ -2406,30 +2406,29 @@ - - + + - - - - - + + + + + - - + - - + + @@ -2437,15 +2436,15 @@ - - - - - + + + + + - + @@ -2456,46 +2455,46 @@ - + - + - + - + - - - - + + + + - + - + - + - - + + - + @@ -2503,20 +2502,20 @@ - + - - + + - + @@ -2527,14 +2526,14 @@ - + - + @@ -2555,18 +2554,18 @@ - - + + - - - + + + - + @@ -2580,32 +2579,32 @@ - + - + - + - - - - + + + + - - - - - - - + + + + + + + - - + + @@ -2624,17 +2623,17 @@ - + - + - - + + @@ -2643,8 +2642,8 @@ - - + + @@ -2655,12 +2654,12 @@ - + - - - - + + + + @@ -2681,13 +2680,13 @@ - - + + - + - + @@ -2696,10 +2695,10 @@ - - - - + + + + @@ -2707,10 +2706,10 @@ - + - + @@ -2793,7 +2792,7 @@ - + From 44965d5e3fb666b684b54dd08198f10b966513d4 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 27 Aug 2024 14:30:56 +0800 Subject: [PATCH 07/20] 1 --- .../API/api_imediaplayer_setaudiopitch.dita | 4 ++-- dita/RTC-NG/API/api_irtcengine_getcallid.dita | 2 +- .../RTC-NG/API/api_irtcengine_initialize.dita | 4 +++- .../API/api_irtcengine_joinchannel2.dita | 2 +- .../API/api_irtcengine_selectaudiotrack.dita | 4 ++-- ...ne_setdefaultaudioroutetospeakerphone.dita | 6 +++--- ...tcengine_setvideoencoderconfiguration.dita | 2 +- dita/RTC-NG/API/class_rtcengineconfig.dita | 20 +++++++++--------- dita/RTC-NG/API/enum_errorcodetype.dita | 6 +++--- .../enum_videoapplicationscenariotype.dita | 2 +- dita/RTC-NG/API/enum_videomoduleposition.dita | 6 +++--- dita/RTC-NG/API/rtc_api_data_type.dita | 2 +- dita/RTC-NG/API/rtc_api_overview.dita | 2 +- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 14 ++++++------- .../config/keys-rtc-ng-api-harmony.ditamap | 21 ++++++++++++------- 15 files changed, 53 insertions(+), 44 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita b/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita index 0925ccbb471..e96cd000ccf 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita @@ -31,7 +31,7 @@

参数 - + @@ -48,4 +48,4 @@
  • < 0: 方法调用失败。详见了解详情和解决建议。
  • - \ No newline at end of file + diff --git a/dita/RTC-NG/API/api_irtcengine_getcallid.dita b/dita/RTC-NG/API/api_irtcengine_getcallid.dita index ea92738818c..d77fe8cdab6 100644 --- a/dita/RTC-NG/API/api_irtcengine_getcallid.dita +++ b/dita/RTC-NG/API/api_irtcengine_getcallid.dita @@ -26,7 +26,7 @@

    -

    客户端在每次加入频道后会生成一个对应的 callId,标识该客户端的此次通话。你可以调用该方法获取 callId 参数,然后在调用 等方法时填入。

    +

    客户端在每次加入频道后会生成一个对应的 callId,标识该客户端的此次通话。你可以调用该方法获取 callId 参数,然后在调用 等方法时填入。

    调用时机 diff --git a/dita/RTC-NG/API/api_irtcengine_initialize.dita b/dita/RTC-NG/API/api_irtcengine_initialize.dita index a5bede4cdad..b9f5ba73f71 100644 --- a/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -15,7 +15,9 @@

    public static synchronized RtcEngine create(RtcEngineConfig config) throws Exception {} - + public static create(config: RtcEngineConfig): RtcEngine { + return RtcEngineImpl.createEngineImpl(config); + } + (instancetype _Nonnull)sharedEngineWithConfig:(AgoraRtcEngineConfig * _Nonnull)config delegate:(id<AgoraRtcEngineDelegate> _Nullable)delegate; virtual int initialize(const RtcEngineContext& context) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index aad3183bce1..27c51b95e7e 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -126,7 +126,7 @@

  • -2:传入的参数无效。例如,使用了不合法的 Token,uid 参数未设置为整型,或 成员值不合法。你需要填入有效的参数,重新加入频道。
  • -3: 对象初始化失败。你需要重新初始化 对象。
  • -7: 对象尚未初始化。你需要在调用该方法前成功初始化 对象。
  • -
  • -8: 对象内部状态错误。可能的原因是:调用 开始通话回路测试后,未调用 停止测试就调用该方法加入频道。你需要在该方法前调用
  • +
  • -8: 对象内部状态错误。可能的原因是:调用 开始通话回路测试后,未调用 停止测试就调用该方法加入频道。你需要在该方法前调用
  • -17:加入频道被拒绝。可能的原因是用户已经在频道中。建议通过 回调判断用户是否在频道中。除收到 (1) 状态外,不要再次调用该方法加入频道。
  • -102:频道名无效。你需要在 channelId 中填入有效的频道名,重新加入频道。
  • -121:用户 ID 无效。你需要在 uid 中填入有效的用户 ID,重新加入频道。
  • diff --git a/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita b/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita index 6bfa2575521..cfe72da412b 100644 --- a/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita +++ b/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita @@ -14,7 +14,7 @@

    public abstract int selectAudioTrack(int audioIndex); - + public abstract selectAudioTrack(index: number): number; - (int)selectAudioTrack:(NSInteger)index; virtual int selectAudioTrack(int index) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") @@ -37,7 +37,7 @@ 参数 - index + index audioIndex 指定的播放音轨。取值范围应大于等于 0 且小于 的返回值。 diff --git a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita index 57adedd7a68..c8aff2e99c4 100644 --- a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -18,7 +18,7 @@ - (int)setDefaultAudioRouteToSpeakerphone:(BOOL)defaultToSpeaker; virtual int setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker) = 0; - UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") + UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine") int SetDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker); abstract setDefaultAudioRouteToSpeakerphone( defaultToSpeaker: boolean @@ -46,7 +46,7 @@

    调用时机 -

    该方法需要在加入频道前调用。如需在加入频道后切换音频路由,请调用

    +

    该方法需要在加入频道前调用。如需在加入频道后切换音频路由,请调用

    调用限制 @@ -76,4 +76,4 @@
  • < 0: 方法调用失败。详见了解详情和解决建议。
  • - \ No newline at end of file + diff --git a/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita b/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita index 78e28c6b94c..f2fbd3beb67 100644 --- a/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita +++ b/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita @@ -41,7 +41,7 @@
    调用限制
      -
    • 该方法和 方法均支持设置镜像效果,声网建议你仅选择一种方法进行设置,同时使用两种方法会导致镜像效果叠加从而造成设置镜像失败。
    • +
    • 该方法和 方法均支持设置镜像效果,声网建议你仅选择一种方法进行设置,同时使用两种方法会导致镜像效果叠加从而造成设置镜像失败。
    • 该方法的 config 参数设置是在理想网络状态下能达到的最大值。如果网络状态不好,视频引擎便不能使用该 config 渲染本地视频,它会自动降低到一个合适的视频参数设置。
    diff --git a/dita/RTC-NG/API/class_rtcengineconfig.dita b/dita/RTC-NG/API/class_rtcengineconfig.dita index c2f9ab9621b..a0fbedb63dd 100644 --- a/dita/RTC-NG/API/class_rtcengineconfig.dita +++ b/dita/RTC-NG/API/class_rtcengineconfig.dita @@ -212,7 +212,7 @@ class RtcEngineContext {

    上下文。

    - + mNativeLibPath

    指定 .so 文件的存储目录。存储目录必须为有效的 App 的私有目录,可以通过 Context.getDir() 获取。

    @@ -226,17 +226,17 @@ class RtcEngineContext {
  • 务必确保你设置的路径为有效路径,否则会导致 创建失败。
  • - + channelProfile mChannelProfile - + audioScenario mAudioScenario - + areaCode mAreaCode 服务器的访问区域。该功能为高级设置,适用于有访问安全限制的场景。支持的区域详见 。区域码支持位操作。 @@ -252,12 +252,12 @@ class RtcEngineContext {
  • - + mExtensionList 插件列表。 - - mExtensionObserver + + mExtensionObserver eventDelegate 实例。 @@ -265,7 +265,7 @@ class RtcEngineContext { mediaFilterExtensions 实例。 - + mDomainLimit domainLimit @@ -276,7 +276,7 @@ class RtcEngineContext {

    - + mAutoRegisterAgoraExtensions autoRegisterAgoraExtensions @@ -288,7 +288,7 @@ class RtcEngineContext {
  • -
    +
    方法 diff --git a/dita/RTC-NG/API/enum_errorcodetype.dita b/dita/RTC-NG/API/enum_errorcodetype.dita index 29547c8d468..a5dbf151a83 100644 --- a/dita/RTC-NG/API/enum_errorcodetype.dita +++ b/dita/RTC-NG/API/enum_errorcodetype.dita @@ -30,7 +30,7 @@
    • 初始化失败。请重新初始化
    • 调用方法时用户尚未加入频道。请检查方法的调用逻辑。
    • -
    • 调用 方法时用户尚未离开频道。请检查方法的调用逻辑。
    • +
    • 调用 方法时用户尚未离开频道。请检查方法的调用逻辑。
    • 音频模块未开启。
    • 程序集不完整。
    @@ -41,7 +41,7 @@
      -
    • Android 平台调用 方法时,如果设备版本低于 Android 5.0,会上报该错误码。请确认 Android 设备版本。
    • +
    • Android 平台调用 方法时,如果设备版本低于 Android 5.0,会上报该错误码。请确认 Android 设备版本。
    • 使用内置加密时,设置的加密模式不正确,或加载外部加密库失败。请检查加密的枚举值是否正确,或重新加载外部加密库。
    @@ -83,7 +83,7 @@
    • 用户已经在频道中。建议通过 回调判断用户是否在频道中。除收到 (1) 状态外,不要再次调用该方法加入频道。
    • -
    • 用户在调用 进行通话测试后,未调用 结束当前测试就尝试加入频道。开始通话测试后,需要先调用 结束当前测试,再加入频道。
    • +
    • 用户在调用 进行通话测试后,未调用 结束当前测试就尝试加入频道。开始通话测试后,需要先调用 结束当前测试,再加入频道。
    diff --git a/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita b/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita index d71d5783eae..6cb0973510c 100644 --- a/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita +++ b/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita @@ -19,7 +19,7 @@ 0: (默认) 通用场景。 - +

    1: 会议场景。

    diff --git a/dita/RTC-NG/API/enum_videomoduleposition.dita b/dita/RTC-NG/API/enum_videomoduleposition.dita index b54d3cf8b93..25af3b4f98b 100644 --- a/dita/RTC-NG/API/enum_videomoduleposition.dita +++ b/dita/RTC-NG/API/enum_videomoduleposition.dita @@ -10,15 +10,15 @@ - 1: 本地采集视频数据并且经过前处理之后的位置,对应 回调。此处观测到的视频具备视频前处理的效果,可通过开启美颜、虚拟背景或水印等方式验证。 + 1: 本地采集视频数据并且经过前处理之后的位置,对应 回调。此处观测到的视频具备视频前处理的效果,可通过开启美颜、虚拟背景或水印等方式验证。 - 2: 接收远端发送的视频在渲染前的位置,对应 回调。 + 2: 接收远端发送的视频在渲染前的位置,对应 回调 - 4: 本地视频编码前的位置,对应 回调。此处观测到的视频具备视频前处理和编码前处理的效果:
      + 4: 本地视频编码前的位置,对应 回调。此处观测到的视频具备视频前处理和编码前处理的效果:
      • 对于视频前处理效果,可通过开启美颜、虚拟背景或水印等方式验证。
      • 对于编码前处理效果,可通过设置一个较低的帧率(例如 5 fps)验证。
      diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita index d52c798d28e..ed145e57c2e 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -264,7 +264,7 @@
    • -
    • +
    • diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index cd1746edff4..dd1b70d70d0 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -550,7 +550,7 @@
    -
    +
    原始音频数据 diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index ba7dc031c23..3d4a7deb427 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -45,7 +45,7 @@ - + @@ -118,7 +118,7 @@ - + @@ -171,7 +171,7 @@ - + @@ -195,9 +195,9 @@ - - - + + + @@ -332,7 +332,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 719ce6436df..496395ec769 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -247,7 +247,7 @@ - + create @@ -883,7 +883,7 @@ - + adjustUserPlaybackSignalVolume @@ -2466,7 +2466,7 @@ - + setDualStreamMode @@ -2744,8 +2744,8 @@ - - + + registerAudioFrameObserver @@ -4247,7 +4247,7 @@ - + @@ -4446,7 +4446,7 @@ - + @@ -7832,6 +7832,13 @@ + + + + ERR_INIT_NET_ENGINE + + + From 2f4a57396247f23b4354084b8ab61abfd287d3dc Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Tue, 27 Aug 2024 17:43:29 +0800 Subject: [PATCH 08/20] 1 --- ...rtcengine_adjustrecordingsignalvolume.dita | 4 +- .../API/api_irtcengine_setaudioscenario.dita | 2 +- .../API/api_irtcengine_setdualstreammode.dita | 2 +- .../api_irtcengine_setdualstreammode2.dita | 4 +- ...tcengineex_setremotevideostreamtypeex.dita | 2 +- ...nthandler_onrtmpstreamingstatechanged.dita | 2 +- .../class_cameracapturerconfiguration.dita | 2 +- dita/RTC-NG/API/enum_audioscenariotype.dita | 2 +- .../enum_videoapplicationscenariotype.dita | 2 +- dita/RTC-NG/API/rtc_api_data_type.dita | 4 +- dita/RTC-NG/API/rtc_api_overview.dita | 6 +- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 25 ++++---- .../config/keys-rtc-ng-api-harmony.ditamap | 62 +++++++++---------- 13 files changed, 56 insertions(+), 63 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita b/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita index e288ce0ecd7..a56556e77ad 100644 --- a/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita +++ b/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita @@ -26,7 +26,7 @@

    -

    如果你只需将音频信号静音,建议你使用

    +

    如果你只需将音频信号静音,建议你使用

    调用时机 @@ -59,4 +59,4 @@
  • < 0: 方法调用失败。详见了解详情和解决建议。
  • - \ No newline at end of file + diff --git a/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita b/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita index edc5ad169fd..e6f6e46f05e 100644 --- a/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita +++ b/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita @@ -44,7 +44,7 @@ scenario 音频场景。不同的音频场景下,设备的音量类型是不同的。 详见 -
      +
      • (0):(默认)自动场景,根据用户角色和音频路由自动匹配合适的音质。
      • (3): 高音质场景,适用于音乐为主的场景。
      • (5): 聊天室场景,适用于用户需要频繁上下麦的场景。
      • diff --git a/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita b/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita index 8e100e01766..d2ea7bff682 100644 --- a/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita +++ b/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita @@ -33,7 +33,7 @@

        SDK 默认在发送端开启小流自适应模式 (),即发送端不主动发送小流,主播身份的接收端可以调用 发起小流申请,发送端收到申请后开始自动发送小流。

        • 如果你想修改此行为,可以调用该方法并修改 mode(始终不发送小流)或 (始终发送小流)。
        • 如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 mode 设置为

        - 该方法和 的区别与联系如下: + 该方法和 的区别与联系如下:
        • 调用该方法并设置 mode 时,跟 () 的效果相同。
        • 调用该方法并设置 mode 时,跟 () 的效果相同。
        • diff --git a/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita b/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita index cde8db511f1..2f35000f510 100644 --- a/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita @@ -44,8 +44,8 @@

          -

          该方法跟 的区别在于,该方法还可以进行视频小流的配置,SDK 会根据 streamConfig 中的配置发送小流。

          - 该方法和 的区别与联系如下: +

          该方法跟 的区别在于,该方法还可以进行视频小流的配置,SDK 会根据 streamConfig 中的配置发送小流。

          + 该方法和 的区别与联系如下:
          • 调用该方法并设置 mode 时,跟调用 并设置 enabled 的效果相同。
          • 调用该方法并设置 mode 时,跟调用 并设置 enabled 的效果相同。
          • diff --git a/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita b/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita index 6a2e7ecd8e3..c1d9d579615 100644 --- a/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita @@ -49,7 +49,7 @@

              -
            • 如果发送端已调用 并将 mode 设置为 (始终不发送小流),则调用该方法不生效,你需要在发送端重新调用 修改设置。
            • +
            • 如果发送端已调用 并将 mode 设置为 (始终不发送小流),则调用该方法不生效,你需要在发送端重新调用 修改设置。
            • 观众角色的接收端调用该方法不生效。
    diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita index 323ad7f34dd..df48a0e3e4c 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita @@ -96,7 +96,7 @@
  • (9):服务器未找到这个流。
  • (10):推流地址格式有错误。请检查推流地址格式是否正确。
  • (11):用户角色不是主播,该用户无法使用推流功能。请检查你的应用代码逻辑。
  • -
  • (13):非转码推流情况下,调用了 方法更新转码属性。请检查你的应用代码逻辑。
  • +
  • (13):非转码推流情况下,调用了 更新转码属性。请检查你的应用代码逻辑。
  • (14):主播的网络出错。
  • (16):你的项目没有使用声网推流服务的权限。请参考旁路推流中的前提条件开启推流服务。
  • (100):推流已正常结束。当你调用 结束推流后,SDK 会返回该值。
  • diff --git a/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index 0b5833484e5..e21fa2dc3f7 100644 --- a/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -340,7 +340,7 @@ class CameraCapturerConfiguration { followEncodeDimensionRatio (可选)是否跟随 中设置的视频宽高比:
      -
    • :(默认) 跟随。SDK 会将采集到的视频按照已设置的视频宽高比进行裁剪,会同步改变本地预览画面、 中的视频画面。
    • +
    • :(默认) 跟随。SDK 会将采集到的视频按照已设置的视频宽高比进行裁剪,会同步改变本地预览画面、 中的视频画面。
    • :不跟随。SDK不改变采集到的视频帧宽高比。
    diff --git a/dita/RTC-NG/API/enum_audioscenariotype.dita b/dita/RTC-NG/API/enum_audioscenariotype.dita index 5746fa3ad95..965578f3cae 100644 --- a/dita/RTC-NG/API/enum_audioscenariotype.dita +++ b/dita/RTC-NG/API/enum_audioscenariotype.dita @@ -22,7 +22,7 @@ 7: 合唱场景。适用于网络条件良好,要求极低延时的实时合唱场景。 - 使用该枚举前,你需要调用 获取音频设备是否支持极低延时采集和播放。只有在支持极低延时(isLowLatencyAudioSupported = )的音频设备上,才能够体验到极低延时。 + 使用该枚举前,你需要调用 获取音频设备是否支持极低延时采集和播放。只有在支持极低延时(isLowLatencyAudioSupported = )的音频设备上,才能够体验到极低延时。 diff --git a/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita b/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita index 6cb0973510c..4c3e9f0b0a5 100644 --- a/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita +++ b/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita @@ -26,7 +26,7 @@

    - +

    2: 1v1 视频通话

    diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita index ed145e57c2e..8933f9da464 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -259,7 +259,7 @@
    • -
    • +
    • @@ -302,7 +302,7 @@
    • -
    • +
    • diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index dd1b70d70d0..5706fe03ff8 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -1546,7 +1546,7 @@
    -
    +
    媒体播放器

    更多有关媒体播放器的方法,详见内置媒体播放器

    更多有关媒体播放器的方法,详见

    @@ -2045,7 +2045,7 @@
    -
    +
    Metadata (SEI) @@ -2060,7 +2060,7 @@ - + diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 3d4a7deb427..c9e84a57428 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -27,13 +27,13 @@ - + - + @@ -80,9 +80,9 @@ - + - + @@ -250,7 +250,7 @@ - + @@ -328,10 +328,10 @@ - - + + - + @@ -352,7 +352,6 @@ - @@ -470,7 +469,7 @@ - + @@ -496,13 +495,13 @@ - + - + @@ -628,7 +627,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 496395ec769..42258caa56a 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -90,7 +90,7 @@ - + IAudioFrameObserver @@ -104,7 +104,7 @@ - + IMediaPlayer @@ -125,7 +125,7 @@ - + IMediaPlayerVideoFrameObserver @@ -160,7 +160,7 @@ - + IMetadataObserver @@ -174,7 +174,7 @@ - + IVideoFrameObserver @@ -209,7 +209,7 @@ - + AudioParams @@ -615,7 +615,7 @@ - + registerPlayerObserver @@ -990,7 +990,7 @@ - + setVideoScenario @@ -1026,13 +1026,6 @@ - - - - setRemoteRenderMode [1/2] - - - @@ -2444,8 +2437,8 @@ - - + + enableDualStreamMode @@ -2459,13 +2452,7 @@ - - - - setDualStreamMode [1/2] - - - + @@ -2892,7 +2879,7 @@ - + @@ -3753,14 +3740,14 @@ - + onRequestToken - + onLocalUserRegistered @@ -3992,7 +3979,7 @@ - + onMetaData @@ -4231,7 +4218,7 @@ - + @@ -4384,7 +4371,7 @@ - + @@ -4471,7 +4458,7 @@ - + @@ -4479,7 +4466,7 @@ - + onTranscodedStreamLayoutInfo @@ -4540,7 +4527,7 @@ - + AdvancedAudioOptions @@ -4771,7 +4758,7 @@ - + AgoraFocalLengthInfo @@ -5030,6 +5017,13 @@ + + + + ScreenCaptureParameters + + + From 532874d8c19dd2906617d76d07fc39192e0e34ac Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 30 Aug 2024 17:47:55 +0800 Subject: [PATCH 09/20] 1 --- dita/RTC-NG/API/rtc_api_overview.dita | 6 +-- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 40 +++++++++---------- .../config/keys-rtc-ng-api-harmony.ditamap | 16 ++++---- 3 files changed, 31 insertions(+), 31 deletions(-) diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index 5706fe03ff8..1b773efad7a 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -849,7 +849,7 @@ - + @@ -1424,7 +1424,7 @@
    -
    +
    音效文件播放 @@ -2130,7 +2130,7 @@ - + diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index c9e84a57428..4cbd4441416 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -265,7 +265,7 @@ - + @@ -406,7 +406,7 @@ - + @@ -419,25 +419,25 @@ - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - + + @@ -641,7 +641,7 @@ - + @@ -663,7 +663,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 42258caa56a..9f1b4421a35 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -636,7 +636,7 @@ - + selectAudioTrack @@ -3877,7 +3877,7 @@ - + onUserEnableVideo @@ -4110,7 +4110,7 @@ - + onAudioEffectFinished @@ -4185,7 +4185,7 @@ - + onAudioRouteChanged @@ -4394,22 +4394,22 @@ - + - onCameraFocusAreaChanged + onCameraFocusPointChanged - + onCameraExposureAreaChanged - + onCameraReady From 5f4208dd3983338afb2f43b024ee20b073ae75c2 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Wed, 11 Sep 2024 15:48:16 +0800 Subject: [PATCH 10/20] add missing APIs --- ...engine_adjustuserplaybacksignalvolume.dita | 2 +- .../api_irtcengine_enabledualstreammode2.dita | 4 +- ..._irtcengine_pauseallchannelmediarelay.dita | 2 +- ...irtcengine_resumeallchannelmediarelay.dita | 2 +- .../api_irtcengineex_setdualstreammodeex.dita | 2 +- ...neex_startorupdatechannelmediarelayex.dita | 2 +- ...ineeventhandler_onaudioeffectfinished.dita | 2 +- ...nthandler_oncameraexposureareachanged.dita | 6 +- ...eventhandler_oncamerafocusareachanged.dita | 17 ++++- ...nthandler_onlocalvideotranscodererror.dita | 8 +-- ...cengineeventhandler_onuserenablevideo.dita | 4 +- dita/RTC-NG/API/class_remoteaudiostats.dita | 2 + dita/RTC-NG/API/rtc_api_overview.dita | 14 ++-- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 12 ++-- .../config/keys-rtc-ng-api-harmony.ditamap | 72 ++++++++++++++++--- .../config/relations-rtc-ng-api.ditamap | 8 +-- 16 files changed, 114 insertions(+), 45 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita b/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita index 70fc80e1bb7..dbfeaea4931 100644 --- a/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita +++ b/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita @@ -14,7 +14,7 @@

    public abstract int adjustUserPlaybackSignalVolume(int uid, int volume); - + public abstract adjustUserPlaybackSignalVolume(uid:number,volume:number):number; - (int)adjustUserPlaybackSignalVolume:(NSUInteger)uid volume:(int)volume; virtual int adjustUserPlaybackSignalVolume(unsigned int uid, int volume) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita b/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita index 99153cc7f08..cc552818811 100644 --- a/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita +++ b/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita @@ -48,7 +48,7 @@

    • 该方法适用于发送端发送的所有类型的流,包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
    • -
    • 如果需要在多频道场景下开启视频双流,可以调用 方法。
    • +
    • 如果需要在多频道场景下开启视频双流,可以调用 方法。
    • 该方法可以在加入频道前后调用。
    @@ -78,4 +78,4 @@
  • < 0: 方法调用失败。 详见了解详情和解决建议。
  • - \ No newline at end of file + diff --git a/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita b/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita index 947c2a9067a..d7cf68a610b 100644 --- a/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita +++ b/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita @@ -14,7 +14,7 @@

    public abstract int pauseAllChannelMediaRelay(); - + public abstract pauseAllChannelMediaRelay():number; - (int)pauseAllChannelMediaRelay; virtual int pauseAllChannelMediaRelay() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita b/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita index ea292434cee..6d46033dea7 100644 --- a/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita +++ b/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita @@ -14,7 +14,7 @@

    public abstract int resumeAllChannelMediaRelay(); - + public abstract resumeAllChannelMediaRelay():number; - (int)resumeAllChannelMediaRelay; virtual int resumeAllChannelMediaRelay() = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 30fa81f7cc5..8d5644fcff6 100644 --- a/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -15,7 +15,7 @@

    public abstract int setDualStreamModeEx(Constants.SimulcastStreamMode mode, SimulcastStreamConfig streamConfig, RtcConnection connection); - + public abstract setDualStreamModeEx(mode:Constants.SimulcastStreamMode,streamConfig:SimulcastStreamConfig,connection:RtcConnection):number; - (int)setDualStreamModeEx:(AgoraSimulcastStreamMode)mode streamConfig:(AgoraSimulcastStreamConfig*)streamConfig connection:(AgoraRtcConnection* _Nonnull)connection; diff --git a/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index a787f1acebf..1beecf3d4bd 100644 --- a/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita @@ -15,7 +15,7 @@

    public abstract int startOrUpdateChannelMediaRelayEx( ChannelMediaRelayConfiguration channelMediaRelayConfiguration, RtcConnection connection); - + public abstract startOrUpdateChannelMediaRelayEx(channelMediaRelayConfiguration:ChannelMediaRelayConfiguration,connection:RtcConnection):number; - (int)startOrUpdateChannelMediaRelayEx:(AgoraChannelMediaRelayConfiguration * _Nonnull)config connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(startOrUpdateChannelMediaRelayEx(_:connection:)); virtual int startOrUpdateChannelMediaRelayEx(const ChannelMediaRelayConfiguration& configuration, const RtcConnection& connection) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy") diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioeffectfinished.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioeffectfinished.dita index f231638de13..870195fece6 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioeffectfinished.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioeffectfinished.dita @@ -14,7 +14,7 @@

    public void onAudioEffectFinished(int soundId) {} - + onAudioEffectFinished?:(soundId:number) => void; - (void)rtcEngineDidAudioEffectFinish:(AgoraRtcEngineKit * _Nonnull)engine soundId:(int)soundId; virtual void onAudioEffectFinished(int soundId) { } diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita index e515569d6d2..97da7fc93b8 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita @@ -14,7 +14,7 @@

    public void onCameraExposureAreaChanged(Rect rect) {} - + onCameraExposureAreaChanged?:(rect:camera.Rect) => void; - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine cameraExposureDidChangedToRect:(CGRect)rect; virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) { (void)x; @@ -60,9 +60,9 @@ - + rect - 镜头内表示曝光的区域。详见 + 镜头内表示曝光的区域。详见

    diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita index b36860a8b6b..b95629f39f8 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita @@ -14,7 +14,7 @@

    public void onCameraFocusAreaChanged(Rect rect) {} - + onCameraFocusPointChanged?:(point:camera.Point) => void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine cameraFocusDidChangedToRect:(CGRect)rect; virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) { (void)x; @@ -67,6 +67,17 @@ -

    + + + + point + 镜头内表示对焦的点。 + + + + + + +
    - \ No newline at end of file + diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita index f0837907acc..03427bb2226 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita @@ -15,7 +15,7 @@

    public void onLocalVideoTranscoderError( LocalTranscoderConfiguration.TranscodingVideoStream stream, int error) {} - + onLocalVideoTranscoderError?:(stream:TranscodingVideoStream, error:Constants.VideoTranscoderError) => void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLocalVideoTranscoderErrorWithStream:(AgoraTranscodingVideoStream * _Nonnull )stream errorCode:(AgoraVideoTranscoderError)errorCode NS_SWIFT_NAME(rtcEngine(_:didLocalVideoTranscoderErrorWithStream:errorCode:)); virtual void onLocalVideoTranscoderError(const TranscodingVideoStream& stream, VIDEO_TRANSCODER_ERROR error){ @@ -54,10 +54,10 @@ 合图失败的视频流。详见 - error + error errorCode - 本地合图出错原因。详见 - 本地合图出错原因: + 本地合图出错原因。详见 + 本地合图出错原因:

    • 1:指定的视频源未开始进行视频采集,你需要为其创建视频轨道并开始视频采集。
    • 2:视频源类型无效,你需要重新指定支持的视频源类型。
    • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita index d5a7a330725..12b1e7faedd 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita @@ -14,7 +14,7 @@

      public void onUserEnableVideo(int uid, boolean enabled) {} - + onUserEnableVideo?:(uid:number, enabled:boolean) => void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didVideoEnabled:(BOOL)enabled byUid:(NSUInteger)uid @@ -79,4 +79,4 @@

      - \ No newline at end of file + diff --git a/dita/RTC-NG/API/class_remoteaudiostats.dita b/dita/RTC-NG/API/class_remoteaudiostats.dita index 3bd0b8e83dc..20fd35a4f3b 100644 --- a/dita/RTC-NG/API/class_remoteaudiostats.dita +++ b/dita/RTC-NG/API/class_remoteaudiostats.dita @@ -61,6 +61,8 @@ public qualityChangedReason:number = 0; public rxAudioBytes:number = 0; + + public e2eDelay:number = 0; } __attribute__((visibility("default"))) @interface AgoraRtcRemoteAudioStats : NSObject @property(assign, nonatomic) NSUInteger uid; diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index 1b773efad7a..a5bfb7e84e1 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -290,7 +290,7 @@ 方法/回调 描述 - + @@ -1117,7 +1117,7 @@ - + @@ -1133,7 +1133,7 @@ - + @@ -1880,7 +1880,7 @@ - + @@ -1892,7 +1892,7 @@ - + @@ -1900,7 +1900,7 @@ - + @@ -2307,7 +2307,7 @@ (仅适用于 Android 和 iOS) - + (仅适用于 Android 和 iOS) diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 4cbd4441416..36aef411395 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -27,7 +27,7 @@ - + @@ -333,7 +333,7 @@ - + @@ -572,12 +572,12 @@ - + - + - + @@ -662,7 +662,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 9f1b4421a35..a78a7c8f753 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -104,7 +104,7 @@ - + IMediaPlayer @@ -223,7 +223,7 @@ - + IAgoraMusicPlayer @@ -615,7 +615,7 @@ - + registerPlayerObserver @@ -1449,7 +1449,7 @@ - + startOrUpdateChannelMediaRelayEx @@ -2272,14 +2272,14 @@ - + pauseAllChannelMediaRelay - + resumeAllChannelMediaRelay @@ -2460,7 +2460,7 @@ - + setDualStreamModeEx @@ -4402,7 +4402,7 @@ - + onCameraExposureAreaChanged @@ -11614,6 +11614,62 @@ + + + + VideoTranscoderError + + + + + + + OK + + + + + + + VIDEO_SOURCE_NOT_READY + + + + + + + INVALID_VIDEO_SOURCE_TYPE + + + + + + + INVALID_IMAGE_PATH + + + + + + + UNSUPPORT_IMAGE_FORMAT + + + + + + + INVALID_LAYOUT + + + + + + + INTERNAL + + + diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index b5902edde4b..1a8beddc464 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -2596,7 +2596,7 @@ - + @@ -2626,7 +2626,7 @@ - + @@ -2636,7 +2636,7 @@ - + @@ -2697,7 +2697,7 @@ - + From 76f22dbdd33601587f4cfb2f9fc018e46b4caa01 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Wed, 11 Sep 2024 16:22:43 +0800 Subject: [PATCH 11/20] fix --- dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita | 2 +- .../RTC-NG/API/callback_irtcengineeventhandler_onerror.dita | 6 +++--- dita/RTC-NG/API/rtc_api_overview.dita | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 28166c81a62..b6acd855140 100644 --- a/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -53,7 +53,7 @@
      • 如果你想修改此行为,可以调用该方法并修改 mode(始终不发送小流)或 (始终发送小流)。
      • 如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 mode 设置为

      - 该方法和 的区别与联系如下: + 该方法和 的区别与联系如下:
      • 调用该方法并设置 mode 时,跟 () 的效果相同。
      • 调用该方法并设置 mode 时,跟 () 的效果相同。
      • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita index 5273182b19b..ac313549db0 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita @@ -65,14 +65,14 @@
        • 初始化失败。请重新初始化
        • 调用方法时用户尚未加入频道。请检查方法的调用逻辑。
        • -
        • 调用 方法时用户尚未离开频道。请检查方法的调用逻辑。
        • +
        • 调用 方法时用户尚未离开频道。请检查方法的调用逻辑。
        • 请检查是否已开启音频模块。请检查程序集完整性。
      • (4): 当前状态不支持该操作。可能的原因有:
          -
        • Android 平台调用 方法时,如果设备版本低于 Android 5.0,会上报该错误码。请确认 Android 设备版本。
        • +
        • Android 平台调用 方法时,如果设备版本低于 Android 5.0,会上报该错误码。请确认 Android 设备版本。
        • 使用内置加密时,设置的加密模式不正确,或加载外部加密库失败。请检查加密的枚举值是否正确,或重新加载外部加密库。
      • (5):方法调用被拒绝。可能的原因有: @@ -93,7 +93,7 @@
        • 用户已经在频道中。建议通过 回调判断用户是否在频道中。除收到 (1) 状态外,不要再次调用该方法加入频道。
        • -
        • 用户在调用 进行通话测试后,未调用 结束当前测试就尝试加入频道。开始通话测试后,需要先调用 结束当前测试,再加入频道。
        • +
        • 用户在调用 进行通话测试后,未调用 结束当前测试就尝试加入频道。开始通话测试后,需要先调用 结束当前测试,再加入频道。
      • (18):离开频道失败。可能的原因有: diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index 552f06b0d91..6dc57bcc115 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -951,7 +951,7 @@ - + From f62a4c38a428ad6875693bba966931328ba52274 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Wed, 11 Sep 2024 16:35:14 +0800 Subject: [PATCH 12/20] 1 --- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 2 +- dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 36aef411395..4d97c77eadb 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -19,7 +19,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index a78a7c8f753..8dc8e1783a7 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -83,7 +83,7 @@ - + IAudioEffectManager From d55689e44de7a61f4d85b503d485f3a644eb27cb Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Thu, 12 Sep 2024 11:14:05 +0800 Subject: [PATCH 13/20] to audio_basic --- .../API/api_imediaengine_pushvideoframe.dita | 4 +- .../API/api_irtcengine_joinchannel2.dita | 2 +- .../api_irtcengine_muteremoteaudiostream.dita | 2 +- .../api_irtcengine_muteremotevideostream.dita | 4 +- .../API/api_irtcengine_pushvideoframe3.dita | 2 +- .../API/api_irtcengine_setaudioprofile.dita | 6 +- .../API/api_irtcengine_setaudioscenario.dita | 2 +- .../API/api_irtcengine_setclientrole2.dita | 2 +- .../api_irtcengine_setlocalrendermode.dita | 2 +- ..._irtcengine_updatechannelmediaoptions.dita | 2 +- .../api_irtcengineex_createdatastreamex.dita | 2 +- .../api_irtcengineex_createdatastreamex2.dita | 2 +- .../API/api_irtcengineex_joinchannelex.dita | 4 +- .../API/api_irtcengineex_leavechannelex2.dita | 2 +- ...cengineex_muteallremoteaudiostreamsex.dita | 3 +- ...cengineex_muteallremotevideostreamsex.dita | 2 +- ...i_irtcengineex_mutelocalaudiostreamex.dita | 2 +- ...i_irtcengineex_mutelocalvideostreamex.dita | 3 +- ...entereventhandler_onmusicchartsresult.dita | 4 +- ...enthandler_onaudiopublishstatechanged.dita | 4 +- ...thandler_onaudiosubscribestatechanged.dita | 12 +-- ...ngineeventhandler_onclientrolechanged.dita | 13 +-- ...eventhandler_onclientrolechangefailed.dita | 6 +- ...eventhandler_onconnectionstatechanged.dita | 23 ++--- ...cengineeventhandler_onencryptionerror.dita | 4 +- ...llback_irtcengineeventhandler_onerror.dita | 8 +- ...cengineeventhandler_onlastmilequality.dita | 2 +- ...irtcengineeventhandler_onleavechannel.dita | 4 +- ...eventhandler_onlocalaudiostatechanged.dita | 8 +- ...tcengineeventhandler_onnetworkquality.dita | 6 +- ...cengineeventhandler_onpermissionerror.dita | 4 +- ...venthandler_onremoteaudiostatechanged.dita | 8 +- ...irtcengineeventhandler_onrequesttoken.dita | 2 +- ...nthandler_onrtmpstreamingstatechanged.dita | 4 +- ...thandler_onvideosubscribestatechanged.dita | 10 +- dita/RTC-NG/API/enum_errorcodetype.dita | 2 +- dita/RTC-NG/API/rtc_api_overview.dita | 2 +- dita/RTC-NG/RTC_NG_API_Android.ditamap | 4 +- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 24 +++-- .../config/keys-rtc-ng-api-harmony.ditamap | 96 +++++++++++-------- 40 files changed, 157 insertions(+), 141 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index 79e1ab56064..5f40867b19b 100644 --- a/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -14,7 +14,7 @@

        public abstract int pushExternalVideoFrameById(AgoraVideoFrame frame, int videoTrackId); - public abstract pushExternalVideoFrameById(frame: VideoFrame, videoTrackId: number): number; + - (BOOL)pushExternalVideoFrame:(AgoraVideoFrame * _Nonnull)frame videoTrackId:(NSUInteger)videoTrackId NS_SWIFT_NAME(pushExternalVideoFrame(_:videoTrackId:)); virtual int pushVideoFrame(base::ExternalVideoFrame* frame, unsigned int videoTrackId = 0) = 0; abstract pushVideoFrame( @@ -32,7 +32,7 @@

        详情 -
        +
        弃用:
        如果你需要推送 I422 格式的视频帧,请使用该方法。其他情况下,请改用
        diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index 6a9346ab4b5..86115c52519 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -104,7 +104,7 @@ 用户 ID。该参数用于标识在实时音视频互动频道中的用户。你需要自行设置和管理用户 ID,并确保同一频道内的每个用户 ID 是唯一的。该参数为 32 位有符号整数。取值范围为:-231-1 到 231-1。该参数为 32 位无符号整数。建议设置范围:1 到 232-1。如果不指定(即设为 0),SDK 会自动分配一个,并在 回调中返回, 应用层必须记住该返回值并维护,SDK 不对该返回值进行维护。 - options + options mediaOptions 频道媒体设置选项。详见 diff --git a/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita b/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita index a86c4fef670..03e4d20306d 100644 --- a/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita +++ b/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita @@ -44,7 +44,7 @@ 参数 - uid + uid 指定用户的用户 ID。 diff --git a/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita b/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita index 57fcb80f217..4efa4518caa 100644 --- a/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita +++ b/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita @@ -45,7 +45,7 @@ userId - uid + uid 指定用户的用户 ID。 @@ -69,4 +69,4 @@
      • < 0:方法调用失败。详见了解详情和解决建议。
    - \ No newline at end of file + diff --git a/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita b/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita index 19f711af6cd..18649c82d4f 100644 --- a/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita +++ b/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita @@ -14,7 +14,7 @@

    public abstract int pushExternalVideoFrameById(VideoFrame frame, int videoTrackId); - + public abstract pushExternalVideoFrameById(frame: VideoFrame, videoTrackId: number): number; diff --git a/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita b/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita index c8f06e8b147..e958d1c8603 100644 --- a/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita +++ b/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita @@ -60,8 +60,8 @@ profile -

    音频编码属性,包含采样率、码率、编码模式和声道数。详见 -

      +

      音频编码属性,包含采样率、码率、编码模式和声道数。详见 +

      • (0):默认值。
        • @@ -87,4 +87,4 @@
        • < 0: 方法调用失败。详见了解详情和解决建议。
    - \ No newline at end of file + diff --git a/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita b/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita index da321868af2..01f7efbca47 100644 --- a/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita +++ b/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita @@ -43,7 +43,7 @@ scenario 音频场景。不同的音频场景下,设备的音量类型是不同的。 - 详见 + 详见
    • (0):(默认)自动场景,根据用户角色和音频路由自动匹配合适的音质。
    • (3): 高音质场景,适用于音乐为主的场景。
    • diff --git a/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita index b60eb80942f..89c7370fd41 100644 --- a/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -34,7 +34,7 @@

    SDK 默认设置用户角色为观众,你可以调用该方法设置用户角色为主播。用户角色(role)确定用户在 SDK 层的权限,包含是否有发流权限等。

    -

    该方法与 的区别在于,该方法还支持设置观众端延时级别(audienceLatencyLevel)。audienceLatencyLevel 需与 role 结合使用,确定用户在其权限范围内可以享受到的服务。例如对于观众,选择接收低延时还是超低延时的视频流。不同的延时级别会影响计费,详见

    +

    该方法与 的区别在于,该方法还支持设置观众端延时级别(audienceLatencyLevel)。audienceLatencyLevel 需与 role 结合使用,确定用户在其权限范围内可以享受到的服务。例如对于观众,选择接收低延时还是超低延时的视频流。不同的延时级别会影响计费,详见

    调用时机 diff --git a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita index 6fdc1f12dbc..d40be896816 100644 --- a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita +++ b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita @@ -14,7 +14,7 @@

    public abstract int setLocalRenderMode(int renderMode); - public abstract setLocalRenderMode(renderMode: number, mirrorMode: number): number; + - (int)setLocalRenderMode:(NSUInteger)uid mode:(AgoraVideoRenderMode) mode; virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode) = 0; diff --git a/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita b/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita index b2a23512d86..17c4e34f311 100644 --- a/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita +++ b/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita @@ -29,7 +29,7 @@ 参数 - options + options mediaOptions 频道媒体选项,详见 diff --git a/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita b/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita index 0863b99b7fb..2b9f845244a 100644 --- a/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita @@ -15,7 +15,7 @@

    public abstract int createDataStreamEx( boolean reliable, boolean ordered, RtcConnection connection); - public abstract createDataStreamEx(config:DataStreamConfig,connection:RtcConnection):number; + - (int)createDataStreamEx:(NSInteger * _Nonnull)streamId reliable:(BOOL)reliable ordered:(BOOL)ordered diff --git a/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index c5e7ceb006b..b570817062d 100644 --- a/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -35,7 +35,7 @@

    -

    相比 ,本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。

    +

    相比 ,本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。

    调用时机 diff --git a/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index d448abaa19e..c1a63acb2b7 100644 --- a/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita @@ -85,9 +85,9 @@ - eventHandler + eventHandler delegate - 的回调类,详见 。多频道相关的事件通知通过你在此参数中传递的 eventHandlerdelegate 对象回调。 + 的回调类,详见 。多频道相关的事件通知通过你在此参数中传递的 eventHandlerdelegate 对象回调。 diff --git a/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita b/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita index 500df0f3a37..dd4a8b6eadc 100644 --- a/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita +++ b/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita @@ -42,7 +42,7 @@
    • 该方法是异步操作,调用返回时并没有真正退出频道。
    • 如果你调用了 后,会同时离开 加入的频道。
    • -
    • 如果你调用了 后,会同时离开 加入的频道。
    • +
    • 如果你调用了 后,会同时离开 加入的频道。
    diff --git a/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita b/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita index 5f179592ad6..fdf6825d757 100644 --- a/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita @@ -14,7 +14,8 @@

    public abstract int muteAllRemoteAudioStreamsEx(boolean muted, RtcConnection connection); - + public abstract muteAllRemoteAudioStreamsEx(muted:boolean,connection:RtcConnection):number; + - (int)muteAllRemoteAudioStreamsEx:(BOOL)mute connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(muteAllRemoteAudioStreamsEx(_:connection:)); virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection& connection) = 0; diff --git a/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita b/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita index c73e4cc5613..1cac40c3646 100644 --- a/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita @@ -14,7 +14,7 @@

    public abstract int muteAllRemoteVideoStreamsEx(boolean muted, RtcConnection connection); - + public abstract muteAllRemoteVideoStreamsEx(muted:boolean,connection:RtcConnection):number; - (int)muteAllRemoteVideoStreamsEx:(BOOL)mute connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(muteAllRemoteVideoStreamsEx(_:connection:)); virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection& connection) = 0; diff --git a/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita b/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita index 48ff9831a89..65d4ff13bc3 100644 --- a/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita @@ -14,7 +14,7 @@

    public abstract int muteLocalAudioStreamEx(boolean muted, RtcConnection connection); - + public abstract muteLocalAudioStreamEx(muted:boolean,connection:RtcConnection):number; - (int)muteLocalAudioStreamEx:(BOOL)mute connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(muteLocalAudioStreamEx(_:connection:)); virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection& connection) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine") diff --git a/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita b/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita index 7debee043cd..fab91341ea0 100644 --- a/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita @@ -14,7 +14,8 @@

    public abstract int muteLocalVideoStreamEx(boolean muted, RtcConnection connection); - + public abstract muteLocalVideoStreamEx(muted:boolean,connection:RtcConnection):number; + - (int)muteLocalVideoStreamEx:(BOOL)mute connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(muteLocalVideoStreamEx(_:connection:)); virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection& connection) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine") diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita index b88bfd71d81..7966eacded2 100644 --- a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita +++ b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita @@ -51,8 +51,8 @@ reason -

    音乐内容中心的请求状态码,详见

    -

    音乐内容中心的请求状态码: +

    音乐内容中心的请求状态码,详见

    +

    音乐内容中心的请求状态码:

    • (0):请求成功。
    • (1):一般错误,无明确归因。
    • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita index a0399733ff3..c320e50e5e7 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita @@ -61,7 +61,7 @@ elapseSinceLastState:(int)elapseSinceLastState; - channel + channel channelId 频道名。 @@ -79,4 +79,4 @@ elapseSinceLastState:(int)elapseSinceLastState;
    - \ No newline at end of file + diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita index 42a4922b6da..ae040d00967 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita @@ -67,7 +67,7 @@ elapseSinceLastState:(int)elapseSinceLastState; - channel + channel channelId 频道名。 @@ -77,8 +77,8 @@ elapseSinceLastState:(int)elapseSinceLastState; oldState - 之前的订阅状态,详见 - 之前的订阅状态。 + 之前的订阅状态,详见 + 之前的订阅状态。
    • (0): 加入频道后的初始订阅状态。
    • @@ -103,8 +103,8 @@ elapseSinceLastState:(int)elapseSinceLastState; newState - 当前的订阅状态,详见 - 当前的订阅状态。 + 当前的订阅状态,详见 + 当前的订阅状态。
      • (0): 加入频道后的初始订阅状态。
      • (1): 订阅失败。可能是因为: @@ -132,4 +132,4 @@ elapseSinceLastState:(int)elapseSinceLastState;
    - \ No newline at end of file + diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita index 2d73b39e573..d26283456fe 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita @@ -44,13 +44,14 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));在以下任意一种情况时,会触发此回调:
    • 加入频道后调用 设置用户角色或观众端延时级别。
    • 加入频道前调用 并将用户角色设为 AUDIENCE

    -

    在以下任意一种情况时,会触发此回调:

      +

      在以下任意一种情况时,会触发此回调:

      • 加入频道后调用 设置用户角色或观众端延时级别。
      • 加入频道前调用 并将用户角色设为 AUDIENCE

    使用限制 -

    当你在加入频道前调用 并将用户角色设为 BROADCASTER 时,不会触发此回调。

    +

    当你在加入频道前调用 并将用户角色设为 BROADCASTER 时,不会触发此回调。

    +

    当你在加入频道前调用 并将用户角色设为 BROADCASTER 时,不会触发此回调。

    <ph keyref="callback-section-title"/> @@ -65,15 +66,15 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:)); oldRole - 切换前的角色: -
      + 切换前的角色: +
      newRole - 切换后的角色: -
        + 切换后的角色: +
        diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita index 458a15f348d..914a813bd0f 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita @@ -45,7 +45,7 @@
        触发时机

        本地用户加入频道后调用 设置用户角色失败时,SDK 会触发该回调。

        -

        本地用户加入频道后调用 设置用户角色失败时,SDK 会触发该回调。

        +

        本地用户加入频道后调用 设置用户角色失败时,SDK 会触发该回调。

        使用限制 @@ -78,8 +78,8 @@ currentRole - 当前用户角色。详见 - 当前用户角色。 + 当前用户角色。详见 + 当前用户角色。
        • (1): 主播。主播可以发流也可以收流。
        • (2): 观众。观众只能收流不能发流。
        • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita index b2cf0a21ba6..4cf8ccac9b3 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita @@ -56,25 +56,20 @@ state -

          当前网络连接状态。详见

          -
            -
          • - (1):网络连接断开。
          • -
          • - (2):建立网络连接中。
          • -
          • - (3):网络已连接。
          • -
          • - (4):重新建立网络连接中 。
          • -
          • - (5):网络连接失败 。
          • +

            当前网络连接状态。详见

            +
              +
            • (1):网络连接断开。
            • +
            • (2):建立网络连接中。
            • +
            • (3):网络已连接。
            • +
            • (4):重新建立网络连接中。
            • +
            • (5):网络连接失败。
            reason -

            引起当前网络连接状态改变的原因。详见

            -

            +

            引起当前网络连接状态改变的原因。详见

            +

            • (0):建立网络连接中。
            • (1):成功加入频道。
            • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita index 034451f763a..46b9d0e924a 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita @@ -50,11 +50,11 @@ connection Connection 信息。详见 - + errorType 错误类型,详见 - + errorType 错误类型。
                diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita index ac313549db0..8ed5a00b668 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita @@ -41,7 +41,7 @@ - + errorCode err 错误码。详见 @@ -50,8 +50,8 @@ msg 错误描述。 - - err + + err error 错误码。 @@ -125,7 +125,7 @@
              • 在控制台中启用了 App 证书,但未使用 App ID + Token 鉴权。当项目启用了 App 证书,就必须使用 Token 鉴权。
              • 生成 Token 时填入的 uid 字段,和用户加入频道时填入的 uid 不匹配。
              -
              +
              弃用:
              该枚举已废弃。请改用 回调中的 (8)。
              diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita index b3312d0c314..00f7c54ed8d 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita @@ -40,7 +40,7 @@ quality - Last mile 网络质量。详见 + Last mile 网络质量。详见
              diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita index ab51cbdb25a..c4083649521 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita @@ -33,8 +33,8 @@
        触发时机 -

        当你成功调用 离开频道后,SDK 会触发该回调。

        -

        当你成功调用 离开频道后,SDK 会触发该回调。

        +

        当你成功调用 离开频道后,SDK 会触发该回调。

        +

        当你成功调用 离开频道后,SDK 会触发该回调。

        使用限制 diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita index 54ffe7d5dc3..db1421a5e57 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita @@ -55,8 +55,8 @@ state - 当前的本地音频状态。详见 - 当前的本地音频状态。 + 当前的本地音频状态。详见 + 当前的本地音频状态。
        • (0): 本地音频默认初始状态。
        • (1): 本地音频采集设备启动成功。
        • @@ -66,8 +66,8 @@ reason - 本地音频状态改变原因。详见 - 本地音频状态改变原因。 + 本地音频状态改变原因。详见 + 本地音频状态改变原因。
          • (0): 本地音频状态正常。
          • (1): 本地音频出错原因不明确。建议提示用户尝试重新加入频道。
          • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita index 9c5fe53db17..79dfc18c90c 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita @@ -47,7 +47,7 @@

            该回调描述每个用户在通话中的 last mile 网络状态,其中 last mile 是指设备到声网边缘服务器的网络状态。

            该回调每 2 秒触发一次。如果远端有多个用户,该回调每 2 秒会被触发多次。

            该回调通过频道内的广播包反馈网络质量。过多的广播包可能引发广播风暴。为防止广播风暴导致频道内大量数据传输,该回调默认支持同时反馈最多 4 个远端主播的网络质量。

            - 用户不发流时,txQualityUNKNOWNUnknown;用户不收流时,rxQualityUNKNOWNUnknown
        + 用户不发流时,txQualityUNKNOWNUnknown;用户不收流时,rxQualityUNKNOWNUnknown
    <ph keyref="callback-section-title" /> @@ -68,14 +68,14 @@ txQuality - 该用户的上行网络质量,基于发送码率、上行丢包率、平均往返时延和网络抖动计算。 该值代表当前的上行网络质量,帮助判断是否可以支持当前设置的视频编码属性。 假设上行码率是 1000 Kbps,那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题,但是支持 1280 × 720 的分辨率就会有困难。 详见 + 该用户的上行网络质量,基于发送码率、上行丢包率、平均往返时延和网络抖动计算。 该值代表当前的上行网络质量,帮助判断是否可以支持当前设置的视频编码属性。 假设上行码率是 1000 Kbps,那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题,但是支持 1280 × 720 的分辨率就会有困难。 详见
    rxQuality - 该用户的下行网络质量,基于下行网络的丢包率、平均往返延时和网络抖动计算。详见 + 该用户的下行网络质量,基于下行网络的丢包率、平均往返延时和网络抖动计算。详见
    diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita index cfdb203cc06..f776aae5bf7 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita @@ -41,8 +41,8 @@ permission type permissionType - 设备权限类型。详见 - 设备权限类型。 + 设备权限类型。详见 + 设备权限类型。
    • (0): 音频采集设备的权限。
    • (1): 摄像头权限。
    • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita index 5595f699b20..c9e3a9ada5c 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita @@ -72,8 +72,8 @@ state - 远端音频流状态,详见 - 远端音频流状态。 + 远端音频流状态,详见 + 远端音频流状态。
      • (0): 远端音频默认初始状态。在 的情况下,会报告该状态。
      • @@ -85,8 +85,8 @@ reason - 远端音频流状态改变的具体原因,详见 - 远端音频流状态改变的具体原因。 + 远端音频流状态改变的具体原因,详见 + 远端音频流状态改变的具体原因。
        • (0): 音频状态发生改变时,会报告该原因。
        • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita index d9ca3f136e8..534c1409eb9 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita @@ -14,7 +14,7 @@

          public void onRequestToken() {} - + onRequestToken?:() => void; - (void)rtcEngineRequestToken:(AgoraRtcEngineKit * _Nonnull)engine; virtual void onRequestToken() UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event") diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita index 36466ad388b..11899ac3143 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita @@ -59,8 +59,8 @@ state - 当前的推流状态,详见 - 当前的推流状态: + 当前的推流状态,详见 + 当前的推流状态: diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita index 7a6d7766ac1..9e3d1226948 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita @@ -78,8 +78,8 @@ oldState - 之前的订阅状态,详见 - 之前的订阅状态。 + 之前的订阅状态,详见 + 之前的订阅状态。

          • (0): 加入频道后的初始订阅状态。
          • (1): 订阅失败。可能是因为: @@ -103,8 +103,8 @@ newState - 当前的订阅状态,详见 - 当前的订阅状态。 + 当前的订阅状态,详见 + 当前的订阅状态。
            • (0): 加入频道后的初始订阅状态。
            • (1): 订阅失败。可能是因为: @@ -135,4 +135,4 @@
          - \ No newline at end of file + diff --git a/dita/RTC-NG/API/enum_errorcodetype.dita b/dita/RTC-NG/API/enum_errorcodetype.dita index a5dbf151a83..340e5e4b06e 100644 --- a/dita/RTC-NG/API/enum_errorcodetype.dita +++ b/dita/RTC-NG/API/enum_errorcodetype.dita @@ -142,7 +142,7 @@
        • 在控制台中启用了 App 证书,但未使用 App ID + Token 鉴权。当项目启用了 App 证书,就必须使用 Token 鉴权。
        • 生成 Token 时填入的 uid 字段,和用户加入频道时填入的 uid 不匹配。
        -
        +
        弃用:
        该枚举已废弃。请改用 回调中的 (8)。
        diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index 6dc57bcc115..5362e39beca 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -1317,7 +1317,7 @@ - + diff --git a/dita/RTC-NG/RTC_NG_API_Android.ditamap b/dita/RTC-NG/RTC_NG_API_Android.ditamap index e9a29d7770e..d4ec4d99a54 100644 --- a/dita/RTC-NG/RTC_NG_API_Android.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Android.ditamap @@ -623,9 +623,9 @@ - + - + diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 4d97c77eadb..bc45c365d46 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -61,16 +61,16 @@ - + - + - + @@ -149,7 +149,7 @@ - + @@ -349,7 +349,6 @@ - @@ -386,8 +385,8 @@ - - + + @@ -453,7 +452,6 @@ - @@ -534,23 +532,23 @@ - + - + - + - - + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 8dc8e1783a7..cb2c5f53f6d 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -268,7 +268,7 @@ - + @@ -297,7 +297,7 @@ - + @@ -553,13 +553,6 @@ - - - open [1/2] - - - - open @@ -1018,7 +1011,6 @@ - @@ -1217,7 +1209,7 @@ - + createDataStreamEx [1/2] @@ -1273,7 +1265,7 @@ - + @@ -2557,15 +2549,15 @@ - + + + - pushExternalVideoFrameById [1/2] + pushExternalVideoFrameById - - - + @@ -3227,14 +3219,14 @@ - + open - + open2 @@ -6860,6 +6852,13 @@ + + + + ConnectionChangedReason + + + @@ -8400,80 +8399,94 @@ + + + + LocalAudioStreamReason + + + - LOCAL_AUDIO_STREAM_REASON_OK + OK - LOCAL_AUDIO_STREAM_REASON_FAILURE + FAILURE - LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION + DEVICE_NO_PERMISSION - LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY + DEVICE_BUSY - LOCAL_AUDIO_STREAM_REASON_CAPTURE_FAILURE + CAPTURE_FAILURE - LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE + ENCODE_FAILURE - LOCAL_AUDIO_STREAM_REASON_INTERRUPTED + INTERRUPTED + + + + + + + LocalAudioStreamState - LOCAL_AUDIO_STREAM_STATE_STOPPED + STOPPED - LOCAL_AUDIO_STREAM_STATE_RECORDING + RECORDING - LOCAL_AUDIO_STREAM_STATE_ENCODING + ENCODING - LOCAL_AUDIO_STREAM_STATE_FAILED + FAILED @@ -9327,56 +9340,56 @@ - MUSIC_CONTENT_CENTER_STATE_REASON_OK + OK - MUSIC_CONTENT_CENTER_STATE_REASON_ERROR + ERROR - MUSIC_CONTENT_CENTER_STATE_REASON_GATEWAY + GATEWAY - MUSIC_CONTENT_CENTER_STATE_REASON_PERMISSION_AND_RESOURCE + PERMISSION_AND_RESOURCE - MUSIC_CONTENT_CENTER_STATE_REASON_INTERNAL_DATA_PARSE + INTERNAL_DATA_PARSE - MUSIC_CONTENT_CENTER_STATE_REASON_MUSIC_LOADING + MUSIC_LOADING - MUSIC_CONTENT_CENTER_STATE_REASON_MUSIC_DECRYPTION + MUSIC_DECRYPTION - MUSIC_CONTENT_CENTER_STATE_REASON_HTTP_INTERNAL + HTTP_INTERNAL @@ -9464,6 +9477,13 @@ + + + + PermissionType + + + From 7f75cc533ac9062d427a3b790182c2905c584db0 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Fri, 13 Sep 2024 18:27:26 +0800 Subject: [PATCH 14/20] to screencapture --- ...api_irtcengine_enableinearmonitoring2.dita | 2 +- .../api_irtcengine_startcameracapture.dita | 2 +- .../api_irtcengine_startscreencapture.dita | 2 +- .../API/api_irtcengine_stopscreencapture.dita | 2 +- ...cengine_updatescreencaptureparameters.dita | 2 +- ...neeventhandler_onfirstlocalvideoframe.dita | 4 +- ...eeventhandler_onfirstremotevideoframe.dita | 6 +-- ...eventhandler_onlocalvideostatechanged.dita | 10 ++--- ...venthandler_onremotevideostatechanged.dita | 8 ++-- ...engineeventhandler_onvideosizechanged.dita | 4 +- .../API/class_screenaudioparameters.dita | 11 ++++-- .../API/class_screencaptureparameters2.dita | 11 +++++- .../API/class_screenvideoparameters.dita | 19 ++++++---- .../API/enum_localvideostreamreason.dita | 14 ++++++- .../config/keys-rtc-ng-api-harmony.ditamap | 38 ++++++++++++++++--- 15 files changed, 96 insertions(+), 39 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita b/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 84cada70fbb..3d7085ba607 100644 --- a/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -58,7 +58,7 @@ includeAudioFilters 耳返 Audio filter 类型。详见 - 耳返 Audio filter 类型: + 耳返 Audio filter 类型:
        • (1 << 0):不在耳返中添加 Audio filter。
        • (1 << 1): 在耳返中添加人声效果 Audio filter。如果你实现了美声、音效等功能,用户可以在耳返中听到添加效果后的声音。该枚举值支持使用按位或运算符(|)进行组合。
        • diff --git a/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita b/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index b67352436e2..d5a2a78eafb 100644 --- a/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -53,7 +53,7 @@ sourceType

          视频源的类型。详见

          -
            +
            • iOS 设备最多支持 2 路摄像头采集的视频流(要求设备配备多摄像头或支持外接摄像头)。
            • Android 设备最多支持 4 路摄像头采集的视频流(要求设备配备多摄像头或支持外接摄像头)。
            • 桌面端最多支持 4 路摄像头采集的视频流。
            • diff --git a/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index 8c2602c4c9a..a7b159e4242 100644 --- a/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -31,7 +31,7 @@
              • 该方法仅适用于 Android 和 iOS 平台。
              • -
              • 屏幕共享流的计费标准以 中的 dimensions 值为准:
                  +
                • 屏幕共享流的计费标准以 中的 dimensions 值为准:
                  • 当你未传值时,以 1280 × 720 计费。
                  • 当你传值时,以你传入的值计费。
                diff --git a/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita b/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita index 1ce989db41e..5fd2becf53f 100644 --- a/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita +++ b/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita @@ -34,7 +34,7 @@ 适用场景

                如果你调用了 开启屏幕采集,则停止屏幕采集时需要调用该方法。

                如果你调用了 开启屏幕采集,则停止屏幕采集时需要调用该方法。

                -

                如果你调用了 开启屏幕采集,则停止屏幕采集时需要调用该方法。

                +

                如果你调用了 开启屏幕采集,则停止屏幕采集时需要调用该方法。

                如果你调用了 开启屏幕采集,则停止屏幕采集时需要调用该方法。

              diff --git a/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita b/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index 187a45aaaa1..b49436ccf32 100644 --- a/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita @@ -45,7 +45,7 @@ screenCaptureParameters captureParams - 屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080,即 2073600 像素。该像素值为计费标准。详见 。 + 屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080,即 2073600 像素。该像素值为计费标准。详见 屏幕共享流的视频属性只需通过该参数设置,与 无关。 diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita index 5fae662f0db..380adf0ca4a 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita @@ -67,11 +67,11 @@ size 本地渲染视频的尺寸。 - + width 本地渲染视频的宽 (px) 。 - + height 本地渲染视频的高 (px)。 diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita index f406a63ad7d..526aa3d3904 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita @@ -55,7 +55,7 @@ - uid + uid remoteUid userId 用户 ID,指定是哪个用户的视频流。 @@ -68,11 +68,11 @@ connection Connection 信息。详见 - + width 视频流宽(px)。 - + height 视频流高(px)。 diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita index 80303ddd223..5f97ed34e2a 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita @@ -71,14 +71,14 @@ sourceType - source + source 视频源的类型。详见 state -

              本地视频状态,详见

              -

              +

              本地视频状态,详见

              +

              • (0): 本地视频默认初始状态。
              • (1): 本地视频采集设备启动成功。
              • @@ -90,8 +90,8 @@ reason -

                本地视频状态改变原因,详见

                -

                +

                本地视频状态改变原因,详见

                +

                • (0): 本地视频状态正常。
                • (1): 出错原因不明确。
                • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita index 4b87ee592dd..9883bee0aad 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita @@ -72,8 +72,8 @@ state -

                  远端视频流状态,详见

                  -

                  远端视频流状态: +

                  远端视频流状态,详见

                  +

                  远端视频流状态:

                  • (0):远端视频默认初始状态。在 (3)、 (5) 或 (7) 的情况下,会报告该状态。
                  • (1):本地用户已接收远端视频首包。
                  • @@ -86,8 +86,8 @@ reason -

                    远端视频流状态改变的具体原因,详见

                    -

                    远端视频流状态改变的具体原因: +

                    远端视频流状态改变的具体原因,详见

                    +

                    远端视频流状态改变的具体原因:

                    • (0):内部原因。
                    • (1):网络阻塞。
                    • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita index 2fb580f7722..cbe800eb042 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita @@ -70,11 +70,11 @@ size 视频流的尺寸。 - + width 视频流的宽度(像素)。 - + height 视频流的高度(像素)。 diff --git a/dita/RTC-NG/API/class_screenaudioparameters.dita b/dita/RTC-NG/API/class_screenaudioparameters.dita index 35c81583ca5..f7830d5ef71 100644 --- a/dita/RTC-NG/API/class_screenaudioparameters.dita +++ b/dita/RTC-NG/API/class_screenaudioparameters.dita @@ -30,6 +30,11 @@ + captureSignalVolume + ", allowCaptureCurrentApp=" + allowCaptureCurrentApp + '}'; } } + export class ScreenAudioParameters { + public sampleRate: number = 16000; + public channels: number = 2; + public captureSignalVolume : number = 100; +} __attribute__((visibility("default"))) @interface AgoraScreenAudioParameters : NSObject @property(assign, nonatomic) NSInteger captureSignalVolume; @end @@ -123,11 +128,11 @@ public:
                      <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> - + sampleRate 音频采样率 (Hz)。默认值为 16000。 - + channels 声道数。默认值为 2,表示双声道。 @@ -135,7 +140,7 @@ public: captureSignalVolume 采集的系统音量。取值范围为 [0,100]。默认值为 100。 - + allowCaptureCurrentApp 是否采集当前 App 中的音频:
                        diff --git a/dita/RTC-NG/API/class_screencaptureparameters2.dita b/dita/RTC-NG/API/class_screencaptureparameters2.dita index 4eef59c881f..9b4e45c8b98 100644 --- a/dita/RTC-NG/API/class_screencaptureparameters2.dita +++ b/dita/RTC-NG/API/class_screencaptureparameters2.dita @@ -92,6 +92,13 @@ + '}'; } } + + export class ScreenCaptureParameters { + public captureAudio: boolean = false; + public audioParams: ScreenAudioParameters = new ScreenAudioParameters(); + public captureVideo: boolean = true; + public videoParams: ScreenVideoParameters = new ScreenVideoParameters(); +} __attribute__((visibility("default"))) @interface AgoraScreenCaptureParameters2 : NSObject @property(assign, nonatomic) BOOL captureAudio; @@ -214,7 +221,7 @@ public:
                      • 受系统限制,采集系统音频仅适用于 Android API 级别为 29 及以上,即 Android 10 及以上。
                      • 为提高屏幕共享时采集系统音频的成功率,请确保你已调用 方法并设置音频场景为
                      - + audioParams 共享屏幕流的音频配置。详见 该参数仅在 captureAudio 时生效。 @@ -228,7 +235,7 @@ public:
                    受系统限制,采集屏幕仅适用于 Android API 级别为 21 及以上,即 Android 5 及以上。
                    - + videoParams 共享屏幕流的视频编码配置。详见 该参数仅在 captureVideo 时生效。 diff --git a/dita/RTC-NG/API/class_screenvideoparameters.dita b/dita/RTC-NG/API/class_screenvideoparameters.dita index d12a2c06e44..c283a7a95c8 100644 --- a/dita/RTC-NG/API/class_screenvideoparameters.dita +++ b/dita/RTC-NG/API/class_screenvideoparameters.dita @@ -46,6 +46,11 @@ } } + export class ScreenVideoParameters { + public dimensions: VideoDimensions = new VideoDimensions(1280, 720); + public frameRate: number = 15; + public bitrate: number = 0; +} __attribute__((visibility("default"))) @interface AgoraScreenVideoParameters : NSObject @property(assign, nonatomic) CGSize dimensions; @@ -157,7 +162,7 @@ public:
                    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - + dimensions 视频编码的分辨率。默认值为 1280 × 720。 如果 dimensions 宽高比与屏幕像素值的宽高比不一致,SDK 会按照如下规则调节视频编码分辨率,以 dimensions 是 1280 × 720 为例: @@ -171,7 +176,7 @@ public:
                  • 该值不代表最终视频输出的方向。详见 了解设置视频方向。
                  • 视频能否达到 720P 的分辨率取决于设备的性能,在性能配备较低的设备上有可能无法实现。如果采用 720P 分辨率而设备性能跟不上,则有可能出现帧率过低的情况。
                  - 在共享文档的场景()下设置编码分辨率时,选择以下两种方式其中之一。 + 在共享文档的场景()下设置编码分辨率时,选择以下两种方式其中之一。
                  • 如果你需要最优的画质,建议将编码分辨率设置为与采集分辨率相同。
                  • 如果你希望在画质、带宽和系统性能之间达到相对平衡,则: @@ -182,7 +187,7 @@ public:
                  - + width 视频编码分辨率中的宽 (px)。默认值为 1280。如果 width 和 height 的宽高比与屏幕像素值的宽高比不一致,SDK 会按照如下规则调节视频编码分辨率, 以 width × height 是 1280 × 720 为例:
                    @@ -206,7 +211,7 @@ public:
                  - + height 视频编码分辨率中的高 (px)。默认值为 720。如果 width 和 height 的宽高比与屏幕像素值的宽高比不一致,SDK 会按照如下规则调节视频编码分辨率,以 width × height 是 1280 × 720 为例:
                    @@ -231,15 +236,15 @@ public: - framerate - frameRate + framerate + frameRate 视频编码帧率 (fps)。默认值为 15。 bitrate 视频编码码率 (Kbps)。 - + contentHint 屏幕共享视频的内容类型。详见
                      diff --git a/dita/RTC-NG/API/enum_localvideostreamreason.dita b/dita/RTC-NG/API/enum_localvideostreamreason.dita index a7cf6dd036d..4d048580cb2 100644 --- a/dita/RTC-NG/API/enum_localvideostreamreason.dita +++ b/dita/RTC-NG/API/enum_localvideostreamreason.dita @@ -47,7 +47,7 @@ 7:(仅适用于 iOS)当前 App 窗口处于侧拉、分屏、画中画模式,且其他 App 正占用摄像头。请提示用户当 App 窗口处于侧拉、分屏、画中画模式,且其他 App 正占用摄像头时,无法正常进行视频采集。 7:预留。 - + 8:找不到本地视频采集设备。需检查摄像头是否与设备正常连接、摄像头是否正常工作,或者尝试重新加入频道。 @@ -132,6 +132,18 @@ 30:(仅适用于 Windows 和 macOS)进行屏幕采集的显示器已断开连接。 + + + 31:用户已停止屏幕共享。 + + + + 32:屏幕共享进程已被其他屏幕共享进程打断。 + + + + 33:屏幕共享进程被系统来电打断。 + 101:由于系统压力过大,导致当前视频采集设备不可用。 diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index cb2c5f53f6d..21d7edb2730 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -8560,6 +8560,27 @@ + + + + SCREEN_CAPTURE_STOPPED_BY_USER + + + + + + + SCREEN_CAPTURE_INTERRUPTED_BY_OTHER + + + + + + + SCREEN_CAPTURE_STOPPED_BY_CALL + + + @@ -9771,38 +9792,45 @@ + + + + RemoteVideoStreamState + + + - REMOTE_VIDEO_STATE_STOPPED + STOPPED - REMOTE_VIDEO_STATE_STARTING + STARTING - REMOTE_VIDEO_STATE_DECODING + DECODING - REMOTE_VIDEO_STATE_FROZEN + FROZEN - REMOTE_VIDEO_STATE_FAILED + FAILED From 22079f343fb244f535a2976e3b0ad876c3605201 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Sat, 14 Sep 2024 12:16:40 +0800 Subject: [PATCH 15/20] all APIs are done --- ...api_imediaplayer_setaudiodualmonomode.dita | 4 +- .../API/api_imediaplayer_setrendermode.dita | 2 +- ...ediarecorder_setmediarecorderobserver.dita | 2 +- ...imusiccontentcenter_createmusicplayer.dita | 2 +- .../API/api_irtcengine_createdatastream2.dita | 2 +- .../API/api_irtcengine_createmediaplayer.dita | 2 +- ...pi_irtcengine_destroycustomvideotrack.dita | 2 +- .../api_irtcengine_destroymediarecorder.dita | 3 +- .../api_irtcengine_enablefacedetection.dita | 2 +- .../api_irtcengine_geterrordescription.dita | 6 +- .../API/api_irtcengine_getnativehandle.dita | 2 +- .../API/api_irtcengine_pushvideoframe2.dita | 2 +- .../API/api_irtcengine_pushvideoframe3.dita | 2 +- .../API/api_irtcengine_pushvideoframe4.dita | 2 +- .../API/api_irtcengine_sendstreammessage.dita | 3 +- ...engine_setcameracapturerconfiguration.dita | 4 +- ..._irtcengine_setcameraexposureposition.dita | 4 +- ...ngine_setcamerafocuspositioninpreview.dita | 4 +- .../api_irtcengine_setcamerazoomfactor.dita | 2 +- .../api_irtcengine_setlocalrendermode2.dita | 4 +- .../API/api_irtcengine_setparameters.dita | 2 +- ...ngine_setremotedefaultvideostreamtype.dita | 4 +- .../api_irtcengine_setremoterendermode2.dita | 6 +- ...i_irtcengine_setremotevideostreamtype.dita | 4 +- .../API/api_irtcengine_setuplocalvideo.dita | 2 +- .../API/api_irtcengine_setupremotevideo.dita | 2 +- .../API/api_irtcengine_startaudiomixing.dita | 2 +- .../api_irtcengine_startaudiorecording.dita | 4 +- ...api_irtcengine_startlastmileprobetest.dita | 2 +- ...engine_startrtmpstreamwithtranscoding.dita | 2 +- .../RTC-NG/API/api_irtcengine_stopeffect.dita | 2 +- .../api_irtcengineex_setupremotevideoex.dita | 2 +- ...reventhandler_onmusiccollectionresult.dita | 5 +- ...ndler_onchannelmediarelaystatechanged.dita | 4 +- ...ineeventhandler_onfacepositionchanged.dita | 4 +- ...ineeventhandler_onlastmileproberesult.dita | 2 +- ...cengineeventhandler_onlastmilequality.dita | 2 +- ...tcengineeventhandler_onnetworkquality.dita | 2 +- ...gineeventhandler_onrtmpstreamingevent.dita | 4 +- ...nthandler_onrtmpstreamingstatechanged.dita | 4 +- ...rtcengineeventhandler_onstreammessage.dita | 2 +- ...gineeventhandler_onstreammessageerror.dita | 8 +- .../API/class_simulcaststreamconfig.dita | 2 +- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 8 +- .../config/keys-rtc-ng-api-harmony.ditamap | 112 ++++++++++-------- 45 files changed, 132 insertions(+), 117 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita b/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita index 370be1d2a19..56e49ff9999 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita @@ -38,8 +38,8 @@ mode - 声道模式。详见 -
                        + 声道模式。详见 +
                        • (0): 原始模式。
                        • (1): 左声道模式。该模式用左声道的音频替换右声道的音频,即用户只能听到左声道的音频。
                        • (2): 右声道模式。该模式用右声道的音频替换左声道的音频,即用户只能听到右声道的音频。
                        • diff --git a/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index f95b8f3125e..9ff525e28ec 100644 --- a/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita @@ -32,7 +32,7 @@ renderMode - mode + mode

                          播放器视图的渲染模式。详见

                          播放器视图的渲染模式: diff --git a/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita b/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita index 0165280cfe5..4b5808150d6 100644 --- a/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita +++ b/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita @@ -40,7 +40,7 @@ 参数 - callback + callback delegate 音视频流录制回调,详见 diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita b/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita index a5de257a6a9..c78f307adb5 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita @@ -44,7 +44,7 @@

                          返回值
                            -
                          • 方法调用成功:返回 对象。
                          • +
                          • 方法调用成功:返回 对象。
                          • 方法调用成功:返回 实例。
                          • 方法调用失败:返回空指针。
                          diff --git a/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index a7d2f31c027..7c0171b03b0 100644 --- a/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -27,7 +27,7 @@

              -

              相比 ,本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。

              +

              相比 ,本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。

              调用时机 diff --git a/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita b/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita index 4fc1705e054..205dd9990f9 100644 --- a/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita +++ b/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita @@ -2,7 +2,7 @@ <ph keyref="createMediaPlayer" /> - 创建媒体播放器对象。创建媒体播放器实例。 + 创建媒体播放器对象。创建媒体播放器实例。 diff --git a/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita b/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita index c218a3e2b8f..a5af4880740 100644 --- a/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita +++ b/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita @@ -30,7 +30,7 @@ video_track_id - videoTrackId + videoTrackId 调用 方法返回的视频轨道 ID。
              diff --git a/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita b/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita index e0928158e78..96cf774e356 100644 --- a/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita +++ b/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita @@ -38,7 +38,8 @@ 参数 - mediaRecorder + mediaRecorder + recorder 待销毁的音视频录制对象。
    diff --git a/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita b/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita index 7f604ec5a61..ba335de45e3 100644 --- a/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita +++ b/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita @@ -50,7 +50,7 @@ enable - enabled + enabled 是否开启人脸检测:
      diff --git a/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita b/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita index eae97a2b4b1..a64117e54a9 100644 --- a/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita +++ b/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita @@ -32,13 +32,13 @@ code - error - SDK 报告的错误码或警告码。 + error + SDK 报告的错误码。
    返回值 -

    具体的错误或警告描述。

    +

    具体的错误描述。

    \ No newline at end of file diff --git a/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita b/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita index 9cc2f2c1a2e..17eb43bfd4d 100644 --- a/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita +++ b/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita @@ -37,7 +37,7 @@
    返回值 -

    SDK 引擎的 Native 句柄。

    +

    SDK 引擎的 Native 句柄。

    • 0:方法调用成功。
    • < 0:方法调用失败。详见了解详情和解决建议。
    • diff --git a/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita b/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita index d35ef01a90f..01a7f746f03 100644 --- a/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita +++ b/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita @@ -25,7 +25,7 @@
    详情 -
    +
    弃用:
    如果你需要推送 I422 格式的视频帧,请使用该方法。其他情况下,请改用
    diff --git a/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita b/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita index 18649c82d4f..bcfc861227e 100644 --- a/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita +++ b/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita @@ -27,7 +27,7 @@ 详情

    -

    调用该方法或 均能将视频帧数据传递给 SDK,区别为该方法支持 Texture 格式的视频数据。

    +

    调用该方法或 均能将视频帧数据传递给 SDK,区别为该方法支持 Texture 格式的视频数据。

    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_pushvideoframe4.dita b/dita/RTC-NG/API/api_irtcengine_pushvideoframe4.dita index 0fa00595273..3b0c796e209 100644 --- a/dita/RTC-NG/API/api_irtcengine_pushvideoframe4.dita +++ b/dita/RTC-NG/API/api_irtcengine_pushvideoframe4.dita @@ -26,7 +26,7 @@
    详情

    -

    调用该方法或 均能将视频帧数据传递给 SDK。区别为该方法支持 Texture 格式的视频数据。

    +

    调用该方法或 均能将视频帧数据传递给 SDK。区别为该方法支持 Texture 格式的视频数据。

    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita b/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita index a7eabfefe99..f5b4c67aab8 100644 --- a/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita +++ b/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita @@ -42,8 +42,7 @@
  • 每个数据通道每秒最多能发送 60 个包(每个包最大为 1 KB)。
  • 每个数据通道每秒最多能发送 30 KB 数据。
  • -

    成功调用该方法后,远端会触发 回调,远端用户可以在该回调中获取接收到的流消息; - 若调用失败,远端会触发 回调。

    +

    成功调用该方法后,远端会触发 回调,远端用户可以在该回调中获取接收到的流消息;若调用失败,远端会触发 回调。

    • 该方法需要在加入频道后、且调用 创建数据通道之后调用。
    • diff --git a/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita b/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita index 82081bdb1f2..c7d641d256c 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita @@ -36,10 +36,10 @@

      该方法必须在开启本地摄像头采集前调用,如 前调用。

    - <ph>调用限制</ph> + 调用限制

    在调整摄像头的焦距配置前,建议先调用 查询设备支持的焦距能力,再根据查询结果进行配置。

    由于部分 Android 设备的限制,即使根据 的查询结果设置焦距类型,设置结果也可能不生效。

    -

    无。

    +

    无。

    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita b/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita index 52dc5928491..6efdd0619b2 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita @@ -44,11 +44,11 @@
    参数 - + positionXinView 触摸点相对于视图的横坐标。 - + positionYinView 触摸点相对于视图的纵坐标。 diff --git a/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita b/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita index 60b2b74a989..70a41a6a0e1 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita @@ -44,11 +44,11 @@
    参数 - + positionX 触摸点相对于视图的横坐标。 - + positionY 触摸点相对于视图的纵坐标。 diff --git a/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita b/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita index 58cf80f9887..3d39dc25410 100644 --- a/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita +++ b/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita @@ -38,7 +38,7 @@ 参数 - factor + factor zoomFactor 摄像头缩放比例。对不支持超广角的设备,取值范围从 1.0 到最大缩放比例;对支持超广角的设备,取值范围从 0.5 到最大缩放比例。你可以通过 方法获取设备支持的最大缩放比例。 diff --git a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index 5fde4f6d6e9..4ad2ded3587 100644 --- a/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -53,7 +53,7 @@ 参数 - renderMode + renderMode mode

    本地视图显示模式。详见

    @@ -62,7 +62,7 @@
    • (1):优先保证视窗被填满。视频尺寸等比缩放,直至整个视窗被视频填满。如果视频长宽与显示窗口不同,多出的视频将被截掉。
    • (2):优先保证视频内容全部显示。视频尺寸等比缩放,直至视频窗口的一边与视窗边框对齐。如果视频长宽与显示窗口不同,视窗上未被填满的区域将被涂黑。
    • -
    • (3):匹配模式。 +
    • (3):匹配模式。
      弃用:
      diff --git a/dita/RTC-NG/API/api_irtcengine_setparameters.dita b/dita/RTC-NG/API/api_irtcengine_setparameters.dita index 81c7ab78060..d09551b63a3 100644 --- a/dita/RTC-NG/API/api_irtcengine_setparameters.dita +++ b/dita/RTC-NG/API/api_irtcengine_setparameters.dita @@ -37,7 +37,7 @@ 参数 - parameters + parameters options JSON 字符串形式的参数。 diff --git a/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita b/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita index 3f8d387ebca..4961d62d5ff 100644 --- a/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita +++ b/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita @@ -49,8 +49,8 @@ streamType -

      默认订阅的视频流类型:

      -

      默认订阅的视频流类型: +

      默认订阅的视频流类型:

      +

      默认订阅的视频流类型:

      • (0):视频大流,即高分辨率、高码率视频流。
      • (1):视频小流,即低分辨率、低码率视频流。
      • diff --git a/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita b/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita index f5e1dda352e..959603d3a68 100644 --- a/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita @@ -51,11 +51,11 @@ userId - uid + uid 远端用户 ID。 - renderMode + renderMode mode

        远端用户视图的渲染模式,详见

        @@ -70,7 +70,7 @@
        - mirrorMode + mirrorMode mirror

        远端用户视图的镜像模式,详见

        diff --git a/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita b/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita index 15965b90c48..5d97fc5de1e 100644 --- a/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita +++ b/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita @@ -59,8 +59,8 @@ streamType -

        视频流类型:

        -

        视频流类型: +

        视频流类型:

        +

        视频流类型:

        • 0:视频大流。
        • 1:视频小流。
        • diff --git a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita index 1bde9a3adc5..d87eccb09fb 100644 --- a/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita +++ b/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita @@ -26,7 +26,7 @@

    -

    该方法初始化本地视图并设置本地用户视频显示属性,只影响本地用户看到的视频画面,不影响本地视频的发布。调用该方法绑定本地视频流的显示视窗(view),并设置本地用户视图的渲染模式和镜像模式。

    +

    该方法初始化本地视图并设置本地用户视频显示属性,只影响本地用户看到的视频画面,不影响本地视频的发布。调用该方法绑定本地视频流的显示视窗 (view),并设置本地用户视图的渲染模式和镜像模式。

    退出频道后绑定仍然有效。如果需要停止渲染或解除绑定,可以调用该方法将参数 view 设为 ,以停止渲染并清理渲染缓存。

      diff --git a/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita b/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index eae02628ca2..6d49f9fe2f6 100644 --- a/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -44,7 +44,7 @@ 参数 - canvas + canvas remote

      远端视频显示属性。详见

      diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita b/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita index 3e57579b146..82a97e8a604 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita @@ -14,7 +14,7 @@

      public abstract int startAudioMixing(String filePath, boolean loopback, int cycle); - public abstract startAudioMixing(filepath: string, loopback: boolean, cycle: number): number; + - (int)startAudioMixing:(NSString * _Nonnull)filePath loopback:(BOOL)loopback cycle:(NSInteger)cycle NS_SWIFT_NAME(startAudioMixing(_:loopback:cycle:)); diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita b/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita index eb3f209ff98..f5353593415 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita @@ -45,8 +45,8 @@ quality - 录音质量。详见 -

        + 录音质量。详见 +
        • 0: 低音质。采样率为 32 kHz,录制 10 分钟的文件大小为 1.2 M 左右。
        • 1: 中音质。采样率为 32 kHz,录制 10 分钟的文件大小为 2 M 左右。
        • 2: 高音质。采样率为 32 kHz,录制 10 分钟的文件大小为 3.75 M 左右。
        • diff --git a/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita b/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita index d4644d1c0ba..f50e9ac4f63 100644 --- a/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita +++ b/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita @@ -38,7 +38,7 @@
      diff --git a/dita/RTC-NG/API/api_irtcengine_stopeffect.dita b/dita/RTC-NG/API/api_irtcengine_stopeffect.dita index 89e5d73ec6c..3e2ce455c0a 100644 --- a/dita/RTC-NG/API/api_irtcengine_stopeffect.dita +++ b/dita/RTC-NG/API/api_irtcengine_stopeffect.dita @@ -32,7 +32,7 @@
    调用时机 -

    该方法需要在 之后调用。

    +

    该方法需要在 之后调用。

    该方法需要在 之后调用。

    diff --git a/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita b/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index adaf1417277..30909074de5 100644 --- a/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita @@ -51,7 +51,7 @@ remote - canvas + canvas

    视频画布信息。详见

    diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita index 14fc016e6b2..10724e1a0c7 100644 --- a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita +++ b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita @@ -40,7 +40,8 @@
    v4.1.0
    -

    当你调 方法来获取指定榜单的音乐资源列表或调用 来搜索音乐资源时,SDK 会触发此回调报告榜单中音乐资源列表的详细信息。

    +

    当你调用 方法来获取指定榜单的音乐资源列表或调用 来搜索音乐资源时,SDK 会触发此回调报告榜单中音乐资源列表的详细信息。

    +

    当你调用 方法来获取指定榜单的音乐资源列表或调用 来搜索音乐资源时,SDK 会触发此回调报告榜单中音乐资源列表的详细信息。

    参数 @@ -68,7 +69,7 @@ list result - 音乐资源列表的详细信息。详见 + 音乐资源列表的详细信息。详见
    diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita index 5edbd44a1e0..0c80700184d 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita @@ -49,7 +49,7 @@ channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state state -

    跨频道媒体流转发状态。详见

    +

    跨频道媒体流转发状态。详见

    跨频道媒体流转发状态:

      @@ -63,7 +63,7 @@ channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state code -

      跨频道媒体流转发出错的错误码。详见

      +

      跨频道媒体流转发出错的错误码。详见

      跨频道媒体流转发出错的错误码: diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita index a73c5a4421c..9a9cce26d8c 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita @@ -73,12 +73,12 @@ - imageWidth + imageWidth width 摄像头采集画面的宽度 (px)。 - imageHeight + imageHeight height 摄像头采集画面的高度 (px)。 diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmileproberesult.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmileproberesult.dita index 9002022c944..388f73c7906 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmileproberesult.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmileproberesult.dita @@ -42,7 +42,7 @@ result - 上下行 Last mile 质量探测结果。 详见: + 上下行 Last mile 质量探测结果。详见

    diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita index 00f7c54ed8d..358d7f3d8d6 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita @@ -40,7 +40,7 @@ quality - Last mile 网络质量。详见 + Last mile 网络质量。详见
    diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita index 79dfc18c90c..a2cc44d6b24 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita @@ -68,7 +68,7 @@
    txQuality - 该用户的上行网络质量,基于发送码率、上行丢包率、平均往返时延和网络抖动计算。 该值代表当前的上行网络质量,帮助判断是否可以支持当前设置的视频编码属性。 假设上行码率是 1000 Kbps,那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题,但是支持 1280 × 720 的分辨率就会有困难。 详见 + 该用户的上行网络质量,基于发送码率、上行丢包率、平均往返时延和网络抖动计算。 该值代表当前的上行网络质量,帮助判断是否可以支持当前设置的视频编码属性。 假设上行码率是 1000 Kbps,那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题,但是支持 1280 × 720 的分辨率就会有困难。详见
    diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita index e1dc9608361..e6c7a4488ea 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita @@ -39,8 +39,8 @@ eventCode event - 旁路推流事件码。详见 - 旁路推流事件码。 + 旁路推流事件码。详见 + 旁路推流事件码。
    • (1): 旁路推流时,添加背景图或水印出错。
    • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita index 11899ac3143..4b204135a3a 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita @@ -82,8 +82,8 @@ reason - 推流状态改变的原因,详见 - 推流状态改变的原因。 + 推流状态改变的原因,详见 + 推流状态改变的原因。
      • (0):推流成功。
      • (1):参数无效。请检查输入参数是否正确。
      • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita index e7a7f8dd295..61d958be74a 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita @@ -59,7 +59,7 @@ - uid + uid userId remoteUid 发送消息的用户 ID。 diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita index 06256fe1811..81ab900c3be 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita @@ -65,10 +65,10 @@ connection - Connection 信息。详见 + Connection 信息。详见 - uid + uid userId remoteUid 发送消息的用户 ID。 @@ -79,8 +79,8 @@ code - error - 发生错误的错误码。详见 + error + 错误码。详见 missed diff --git a/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/dita/RTC-NG/API/class_simulcaststreamconfig.dita index cda236b0a3a..f13d4bab7fc 100644 --- a/dita/RTC-NG/API/class_simulcaststreamconfig.dita +++ b/dita/RTC-NG/API/class_simulcaststreamconfig.dita @@ -118,7 +118,7 @@ public: 视频尺寸。详见 默认值为视频大流的 50%。 - bitrate + bitrate kBitrate 视频码率 (Kbps)。该参数无需设置,SDK 会根据你设定的视频分辨率和帧率自动匹配最合适的码率。 diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index bc45c365d46..22dfd24c308 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -411,7 +411,7 @@ - + @@ -448,7 +448,7 @@ - + @@ -616,9 +616,9 @@ - + - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 21d7edb2730..9a39f817eef 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -482,7 +482,7 @@ - + getMediaPlayerCacheManager @@ -1557,7 +1557,7 @@ - + @@ -3147,7 +3147,7 @@ - + @@ -4736,7 +4736,7 @@ - + AgoraVideoFrame @@ -6141,28 +6141,28 @@ - AUDIO_DUAL_MONO_STEREO + STEREO - AUDIO_DUAL_MONO_L + L - AUDIO_DUAL_MONO_R + R - AUDIO_DUAL_MONO_MIX + MIX @@ -7153,220 +7153,234 @@ + + + + ChannelMediaRelayError + + + - RELAY_OK + OK - RELAY_ERROR_SERVER_ERROR_RESPONSE + SERVER_ERROR_RESPONSE - RELAY_ERROR_SERVER_NO_RESPONSE + SERVER_NO_RESPONSE - RELAY_ERROR_NO_RESOURCE_AVAILABLE + NO_RESOURCE_AVAILABLE - RELAY_ERROR_FAILED_JOIN_SRC + FAILED_JOIN_SRC - RELAY_ERROR_FAILED_JOIN_DEST + FAILED_JOIN_DEST - RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC + FAILED_PACKET_RECEIVED_FROM_SRC - RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST + FAILED_PACKET_SENT_TO_DEST - RELAY_ERROR_SERVER_CONNECTION_LOST + SERVER_CONNECTION_LOST - RELAY_ERROR_INTERNAL_ERROR + INTERNAL_ERROR - RELAY_ERROR_SRC_TOKEN_EXPIRED + SRC_TOKEN_EXPIRED - RELAY_ERROR_DEST_TOKEN_EXPIRED + DEST_TOKEN_EXPIRED + + + + + + + ChannelMediaRelayState - RELAY_EVENT_NETWORK_DISCONNECTED + NETWORK_DISCONNECTED - RELAY_EVENT_NETWORK_CONNECTED + NETWORK_CONNECTED - RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL + PACKET_JOINED_SRC_CHANNEL - RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL + PACKET_JOINED_DEST_CHANNEL - RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL + PACKET_SENT_TO_DEST_CHANNEL - RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC + PACKET_RECEIVED_VIDEO_FROM_SRC - RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC + PACKET_RECEIVED_AUDIO_FROM_SRC - RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL + PACKET_UPDATE_DEST_CHANNEL - RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE + PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE - RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL + PACKET_UPDATE_DEST_CHANNEL_IS_NULL - RELAY_EVENT_VIDEO_PROFILE_UPDATE + VIDEO_PROFILE_UPDATE - RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS + PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS - RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED + PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED - RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS + RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS - RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED + RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED - RELAY_STATE_IDLE + IDLE - RELAY_STATE_CONNECTING + CONNECTING - RELAY_STATE_RUNNING + RUNNING - RELAY_STATE_FAILURE + FAILURE @@ -9102,70 +9116,70 @@ - PLAYER_STATE_UNKNOWN + UNKNOWN - PLAYER_STATE_IDLE + IDLE - PLAYER_STATE_OPENING + OPENING - PLAYER_STATE_OPEN_COMPLETED + OPEN_COMPLETED - PLAYER_STATE_PLAYING + PLAYING - PLAYER_STATE_PAUSED + PAUSED - PLAYER_STATE_PLAYBACK_COMPLETED + PLAYBACK_COMPLETED - PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED + PLAYBACK_ALL_LOOPS_COMPLETED - PLAYER_STATE_STOPPED + STOPPED - PLAYER_STATE_FAILED + FAILED From e8a73918fef22383da6b69a4e2591c5ebd1939eb Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Sat, 14 Sep 2024 18:23:13 +0800 Subject: [PATCH 16/20] that's all --- .../API/api_irtcengine_leavechannel2.dita | 4 +- ...pectrumobserver_onremoteaudiospectrum.dita | 8 +- ...eventhandler_onclientrolechangefailed.dita | 4 +- dita/RTC-NG/API/class_audioparams.dita | 7 +- dita/RTC-NG/API/class_audiospectrumdata.dita | 2 +- .../class_cameracapturerconfiguration.dita | 2 +- .../RTC-NG/API/class_channelmediaoptions.dita | 4 +- .../class_channelmediarelayconfiguration.dita | 14 +-- dita/RTC-NG/API/class_clientroleoptions.dita | 4 +- .../API/class_contentinspectconfig.dita | 6 +- .../API/class_contentinspectmodule.dita | 4 +- dita/RTC-NG/API/class_encryptionconfig.dita | 2 +- dita/RTC-NG/API/class_localvideostats.dita | 2 +- dita/RTC-NG/API/class_logconfig.dita | 2 +- dita/RTC-NG/API/class_mediasource.dita | 2 +- dita/RTC-NG/API/class_recorderinfo.dita | 4 +- dita/RTC-NG/API/class_rtcimage.dita | 10 +- dita/RTC-NG/API/class_transcodinguser.dita | 8 +- .../API/class_useraudiospectruminfo.dita | 6 +- dita/RTC-NG/API/class_videocanvas.dita | 10 +- .../API/class_videoencoderconfiguration.dita | 4 +- dita/RTC-NG/API/class_videoframe.dita | 27 +++-- .../API/class_virtualbackgroundsource.dita | 6 +- dita/RTC-NG/API/rtc_api_data_type.dita | 66 +++++------ dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 14 +-- .../config/keys-rtc-ng-api-harmony.ditamap | 111 +++++++++++++----- 26 files changed, 198 insertions(+), 135 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita b/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita index 6ac30b7c2d8..da910159ae4 100644 --- a/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita +++ b/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita @@ -28,8 +28,8 @@

    调用该方法后,SDK 会终止音视频互动、离开当前频道,并会释放会话相关的所有资源。

    -

    成功加入频道后,必须调用本方法或者 结束通话,否则无法开始下一次通话。如果你已调用 加入多个频道,调用本方法后会同时离开所有已加入的频道。

    -

    成功加入频道后,必须调用本方法结束通话,否则无法开始下一次通话。如果你已调用 加入多个频道,调用本方法后会同时离开所有已加入的频道。

    +

    成功加入频道后,必须调用本方法或者 结束通话,否则无法开始下一次通话。如果你已调用 加入多个频道,调用本方法后会同时离开所有已加入的频道。

    +

    成功加入频道后,必须调用本方法结束通话,否则无法开始下一次通话。如果你已调用 加入多个频道,调用本方法后会同时离开所有已加入的频道。

    该方法是异步操作,调用返回时并没有真正退出频道。
    diff --git a/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita b/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita index db6d6fcd2cb..3f90dbce3fe 100644 --- a/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita +++ b/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita @@ -43,8 +43,12 @@
    参数 - - userAudioSpectrumInfos + + data + 远端用户的音频频谱信息,详见 。数组数量等于 SDK 监测到的远端用户数量,数组为空表示没有监测到远端用户的音频频谱。 + + + userAudioSpectrumInfos AudioSpectrumInfo spectrums 远端用户的音频频谱信息,详见 。 数组数量等于 SDK 监测到的远端用户数量,数组为空表示没有监测到远端用户的音频频谱。 diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita index 914a813bd0f..41fe7647a8e 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita @@ -44,7 +44,7 @@
    触发时机 -

    本地用户加入频道后调用 设置用户角色失败时,SDK 会触发该回调。

    +

    本地用户加入频道后调用 设置用户角色失败时,SDK 会触发该回调。

    本地用户加入频道后调用 设置用户角色失败时,SDK 会触发该回调。

    @@ -91,4 +91,4 @@
    - \ No newline at end of file + diff --git a/dita/RTC-NG/API/class_audioparams.dita b/dita/RTC-NG/API/class_audioparams.dita index 09f71cd5182..6a4e83ffbc1 100644 --- a/dita/RTC-NG/API/class_audioparams.dita +++ b/dita/RTC-NG/API/class_audioparams.dita @@ -20,7 +20,12 @@ this.samplesPerCall = samplesPerCall; } } - + export class AudioParams { + public sampleRate: number = 16000; + public channel: number = 1; + public mode: Constants.RawAudioFrameOpMode = Constants.RawAudioFrameOpMode.READ_ONLY; + public samplesPerCall: number = 1024; +} __attribute__((visibility("default"))) @interface AgoraAudioParams : NSObject @property (assign, nonatomic) NSInteger sampleRate; diff --git a/dita/RTC-NG/API/class_audiospectrumdata.dita b/dita/RTC-NG/API/class_audiospectrumdata.dita index da3718f45dd..021420a3e66 100644 --- a/dita/RTC-NG/API/class_audiospectrumdata.dita +++ b/dita/RTC-NG/API/class_audiospectrumdata.dita @@ -72,7 +72,7 @@ struct FAudioSpectrumData {

    音频频谱数据。声网将声音频率分为 256 个频域,通过该参数报告各频域的能量值,每个能量值的取值范围为 [-300,1],单位为 dBFS。

    - + dataLength 音频频谱数据长度为 256。 diff --git a/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index 2e627a2ff24..d9c1edaefcf 100644 --- a/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/dita/RTC-NG/API/class_cameracapturerconfiguration.dita @@ -341,7 +341,7 @@ class CameraCapturerConfiguration { <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - + cameraDirection (可选)摄像头方向。详见 该参数仅适用于 Android 和 iOS 平台。 diff --git a/dita/RTC-NG/API/class_channelmediaoptions.dita b/dita/RTC-NG/API/class_channelmediaoptions.dita index db74b395cf2..3542e5816ce 100644 --- a/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -1501,7 +1501,7 @@ public: 该参数仅适用于 Windows 和 macOS 平台。 - + publishScreenCaptureVideo

    设置是否发布屏幕采集的视频: @@ -1512,7 +1512,7 @@ public: 该参数仅适用于 Android 和 iOS 平台。 自 v4.0.0 起,该参数名称由 publishScreenTrack 改为 publishScreenCaptureVideo - + publishScreenCaptureAudio

    设置是否发布屏幕采集的音频: diff --git a/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita index 5a60c85ae1b..eb5d3ac69cf 100644 --- a/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita +++ b/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita @@ -153,20 +153,20 @@ public: setSrcChannelInfo 设置源频道信息。详见 - + setDestChannelInfo 设置目标频道信息。详见 - - removeDestChannelInfo + + removeDestChannelInfo removeDestinationInfoForChannelName 删除目标频道信息。详见 - + getSrcChannelMediaInfo 获取源频道信息。详见 - + getDestChannelMediaInfos 获取目标频道信息。详见 @@ -176,7 +176,7 @@ public: <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - srcInfo + srcInfo sourceInfo

    源频道信息 ,包含如下成员: @@ -192,7 +192,7 @@ public: - destInfos + destInfos destinationInfos

    目标频道信息 ,包含如下成员: diff --git a/dita/RTC-NG/API/class_clientroleoptions.dita b/dita/RTC-NG/API/class_clientroleoptions.dita index 4cbae7da5c2..04b90c7613a 100644 --- a/dita/RTC-NG/API/class_clientroleoptions.dita +++ b/dita/RTC-NG/API/class_clientroleoptions.dita @@ -80,8 +80,8 @@ public: audienceLatencyLevel - 观众端延时级别。详见 -

      + 观众端延时级别。详见 +
      • (1): 低延时。
      • (2): (默认)超低延时。
      diff --git a/dita/RTC-NG/API/class_contentinspectconfig.dita b/dita/RTC-NG/API/class_contentinspectconfig.dita index 8d10bbe5f4b..9b697c79f8f 100644 --- a/dita/RTC-NG/API/class_contentinspectconfig.dita +++ b/dita/RTC-NG/API/class_contentinspectconfig.dita @@ -169,7 +169,7 @@ class ContentInspectConfig {
      参数 - + CONTENT_INSPECT_TYPE_INVALID 0:(默认)无实际功能。请不要将 type 设为该值。 @@ -177,11 +177,11 @@ class ContentInspectConfig { CONTENT_INSPECT_TYPE_MODERATION 1:视频鉴黄。SDK 会对本地用户发送的视频进行截图、鉴黄,并将截图和审核结果上传。 - + CONTENT_INSPECT_TYPE_SUPERVISE 2:使用声网自研插件截图上传。SDK 会对本地用户发送的视频进行截图并上传。 - + CONTENT_INSPECT_TYPE_IMAGE_MODERATION 3:使用云市场插件截图上传。SDK 会使用云市场视频审核插件对视频流进行截图并上传。 diff --git a/dita/RTC-NG/API/class_contentinspectmodule.dita b/dita/RTC-NG/API/class_contentinspectmodule.dita index d2bfc34e2d1..a79c6ff18fd 100644 --- a/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/dita/RTC-NG/API/class_contentinspectmodule.dita @@ -96,8 +96,8 @@ public: type - 功能模块的类型。详见 - + 功能模块的类型。详见 +

      功能模块的类型:

      • (0):(默认)该功能模块无实际功能。请不要设为该值。
      • diff --git a/dita/RTC-NG/API/class_encryptionconfig.dita b/dita/RTC-NG/API/class_encryptionconfig.dita index 3f507ce2e8c..a789b307b24 100644 --- a/dita/RTC-NG/API/class_encryptionconfig.dita +++ b/dita/RTC-NG/API/class_encryptionconfig.dita @@ -169,7 +169,7 @@ class EncryptionConfig { 只有在 加密模式下,该参数才生效。此时,需确保填入该参数的值不全为 0 - + datastreamEncryptionEnabled 是否开启数据流加密:
          diff --git a/dita/RTC-NG/API/class_localvideostats.dita b/dita/RTC-NG/API/class_localvideostats.dita index cf2d330c67f..b0a276bbe30 100644 --- a/dita/RTC-NG/API/class_localvideostats.dita +++ b/dita/RTC-NG/API/class_localvideostats.dita @@ -549,7 +549,7 @@ public: codecType - 视频的编码类型。详见 。 + 视频的编码类型。详见

          • (1):VP8。
          • diff --git a/dita/RTC-NG/API/class_logconfig.dita b/dita/RTC-NG/API/class_logconfig.dita index bffeaa37523..25786510791 100644 --- a/dita/RTC-NG/API/class_logconfig.dita +++ b/dita/RTC-NG/API/class_logconfig.dita @@ -127,7 +127,7 @@ public:
        • Windows:C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log

        -

        默认路径为 /storage/emulated/0/Android/data/<packagename>/files/agorasdk.log

        +

        默认路径为 /storage/emulated/0/Android/data/<packagename>/files/agorasdk.log

        默认路径为 AppSandbox/Library/caches/agorasdk.log

        默认路径为: diff --git a/dita/RTC-NG/API/class_mediasource.dita b/dita/RTC-NG/API/class_mediasource.dita index 1b96d165165..4ef17912603 100644 --- a/dita/RTC-NG/API/class_mediasource.dita +++ b/dita/RTC-NG/API/class_mediasource.dita @@ -212,7 +212,7 @@ public: url

        需要播放的媒体资源的 URL。

        - +

        如果你打开的为普通媒体资源,请向 url 传值;如果你打开媒体资源为自定义媒体资源,请向 playerOnReadCallbackplayerOnSeekCallback 传值,同时传值会导致方法调用失败。

        如果你打开的为普通媒体资源,请向 url 传值;如果你打开媒体资源为自定义媒体资源,请向 provider 传值,同时传值会导致方法调用失败。

        diff --git a/dita/RTC-NG/API/class_recorderinfo.dita b/dita/RTC-NG/API/class_recorderinfo.dita index ad61164843b..7d49913948f 100644 --- a/dita/RTC-NG/API/class_recorderinfo.dita +++ b/dita/RTC-NG/API/class_recorderinfo.dita @@ -96,7 +96,7 @@ struct FRecorderInfo { <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> - fileName + fileName recorderFileName 录制文件的绝对存储路径。 @@ -110,4 +110,4 @@ struct FRecorderInfo {
      - \ No newline at end of file + diff --git a/dita/RTC-NG/API/class_rtcimage.dita b/dita/RTC-NG/API/class_rtcimage.dita index f59403ca47a..454fdde36ed 100644 --- a/dita/RTC-NG/API/class_rtcimage.dita +++ b/dita/RTC-NG/API/class_rtcimage.dita @@ -229,19 +229,19 @@ struct FRtcImage url 直播视频上图片的 HTTP/HTTPS 地址。字符长度不得超过 1024 字节。 - + x 图片在视频画面上的 x 坐标 (px),以输出视频画面的左上角为原点。 - + y 图片在视频画面上的 y 坐标 (px),以输出视频画面的左上角为原点。 - + width 图片在视频画面上的宽度 (px)。 - + height 图片在视频画面上的高度 (px)。 @@ -264,4 +264,4 @@ struct FRtcImage
    - \ No newline at end of file + diff --git a/dita/RTC-NG/API/class_transcodinguser.dita b/dita/RTC-NG/API/class_transcodinguser.dita index 926cc5a718e..a3b58b42732 100644 --- a/dita/RTC-NG/API/class_transcodinguser.dita +++ b/dita/RTC-NG/API/class_transcodinguser.dita @@ -212,21 +212,21 @@ public:

    主播的用户 ID。

    - + x

    主播视频画面在输出视频画面的 x 坐标 (px),以输出视频画面的左上角为原点。取值范围为[0,width],width 为 中设置的 width

    - + y 主播视频画面在输出视频画面的 y 坐标 (px),以输出视频画面的左上角为原点。取值范围为[0,height],height 为 中设置的 height - + width 主播视频画面的宽 (px)。 - + height

    主播视频画面的高 (px)。

    diff --git a/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/dita/RTC-NG/API/class_useraudiospectruminfo.dita index cfda2556d3c..d2318438266 100644 --- a/dita/RTC-NG/API/class_useraudiospectruminfo.dita +++ b/dita/RTC-NG/API/class_useraudiospectruminfo.dita @@ -11,7 +11,7 @@ private AudioSpectrumInfo audioSpectrumInfo; } - + __attribute__((visibility("default"))) @interface AgoraAudioSpectrumInfo : NSObject @property(nonatomic, assign) NSInteger uid; @@ -77,9 +77,9 @@ struct FUserAudioSpectrumInfo { audioSpectrumData spectrumData -

    远端用户的音频频谱数据。详见

    +

    远端用户的音频频谱数据。详见

    - \ No newline at end of file + diff --git a/dita/RTC-NG/API/class_videocanvas.dita b/dita/RTC-NG/API/class_videocanvas.dita index e81733e9948..3c03a71e988 100644 --- a/dita/RTC-NG/API/class_videocanvas.dita +++ b/dita/RTC-NG/API/class_videocanvas.dita @@ -335,7 +335,7 @@ class VideoCanvas { sourceType 视频源的类型,详见 - + setupMode 视图设置模式。详见 视图设置模式: @@ -350,7 +350,7 @@ class VideoCanvas { 媒体播放器 ID。可通过 获取。 sourceType 时,此参数为必填项。 - + rect (可选)视频帧的展示区域。详见 。其中,widthheight 表示该区域的视频像素宽度和高度。默认值为空值 (宽或高为 0),表示展示实际分辨率的视频帧。 @@ -362,11 +362,11 @@ class VideoCanvas { cropArea (可选)视频帧的展示区域,详见 。其中,widthheight 表示该区域的视频像素宽度和高度。默认值为空值 (宽或高为 0),表示展示实际分辨率的视频帧。 - + backgroundColor 视频画布的背景颜色,格式为 RGBA。默认值为 0x00000000,代表完全透明的黑色。 - + enableAlphaMask (可选)是否开启 Alpha 遮罩渲染:
      @@ -382,7 +382,7 @@ class VideoCanvas { 预留。 - + position 视频帧在视频链路中的位置。详见 diff --git a/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/dita/RTC-NG/API/class_videoencoderconfiguration.dita index c05e0a09590..9b027c942d9 100644 --- a/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -570,7 +570,7 @@ public: dimensions -

      视频编码的分辨率(px),详见 。该参数用于衡量编码质量,以长 × 宽表示,默认值为 960 × 540。用户可以自行设置分辨率。

      +

      视频编码的分辨率 (px),详见 。该参数用于衡量编码质量,以长 × 宽表示,默认值为 960 × 540。用户可以自行设置分辨率。

      用户可以自行设置分辨率,也可以在如下列表中直接选择想要的分辨率:

        @@ -641,7 +641,7 @@ public: degradationPreference - 带宽受限时,视频编码降级偏好。详见 。 + 带宽受限时,视频编码降级偏好。详见 当该参数设置为 (1) 或者 (2) 时,需要同时将 orientationMode 设置为 (0),否则设置不生效。 diff --git a/dita/RTC-NG/API/class_videoframe.dita b/dita/RTC-NG/API/class_videoframe.dita index 0e2de8f9661..8a355275c8d 100644 --- a/dita/RTC-NG/API/class_videoframe.dita +++ b/dita/RTC-NG/API/class_videoframe.dita @@ -611,46 +611,51 @@ class VideoFrame {
        <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - - type - 像素格式。详见 + + type + 视频类型。详见 + + + format + type + 像素格式。详见 - + width 视频像素宽度。 - + height 视频像素高度。 - + yStride 对 YUV 数据,表示 Y 缓冲区的行跨度;对 RGBA 数据,表示总的数据长度。 在处理视频数据时,需根据该参数处理每行像素数据之间的偏移量,否则可能导致图像失真。 - + uStride 对 YUV 数据,表示 U 缓冲区的行跨度;对 RGBA 数据,值为 0。 在处理视频数据时,需根据该参数处理每行像素数据之间的偏移量,否则可能导致图像失真。 - + vStride 对 YUV 数据,表示 V 缓冲区的行跨度;对 RGBA 数据,值为 0。 在处理视频数据时,需根据该参数处理每行像素数据之间的偏移量,否则可能导致图像失真。 - + yBuffer 对 YUV 数据,表示 Y 缓冲区的指针;对 RGBA 数据,表示数据缓冲区。 - + uBuffer 对 YUV 数据,表示 U 缓冲区的指针;对 RGBA 数据,值为空。 - + vBuffer 对 YUV 数据,表示 V 缓冲区的指针;对 RGBA 数据,值为空。 diff --git a/dita/RTC-NG/API/class_virtualbackgroundsource.dita b/dita/RTC-NG/API/class_virtualbackgroundsource.dita index a110120c1b3..d2b16d43304 100644 --- a/dita/RTC-NG/API/class_virtualbackgroundsource.dita +++ b/dita/RTC-NG/API/class_virtualbackgroundsource.dita @@ -174,7 +174,7 @@ public: <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> - backgroundSourceType + backgroundSourceType background_source_type 自定义的背景。详见
          @@ -201,7 +201,7 @@ public: 该参数仅在自定义背景图类型为 时生效。 - blurDegree + blurDegree blur_degree 自定义背景图的模糊程度。详见
            @@ -213,4 +213,4 @@ public:
        - \ No newline at end of file + diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita index 8933f9da464..367403d9ef6 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -260,50 +260,50 @@
        • -
        • +
        • -
        • -
        • +
        • +
        • -
        • +
        • -
        • +
          • -
          • -
          • -
          • -
          • +
          • +
          • +
          • +
        • -
        • -
        • -
        • -
        • +
        • +
        • +
        • +
        • -
        • -
        • -
        • -
        • +
        • +
        • +
        • +
        • -
        • -
        • -
        • -
        • -
        • +
        • +
        • +
        • +
        • +
        • -
        • -
        • -
        • +
        • +
        • +
        • @@ -316,7 +316,7 @@
        • -
        • +
        • @@ -325,7 +325,7 @@
        • -
        • +
        • @@ -343,18 +343,18 @@
        • -
        • -
        • -
        • +
        • +
        • +
        • -
        • +
        • -
        • +
        • -
        • +
        diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 22dfd24c308..fc367347568 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -40,7 +40,7 @@ - + @@ -63,14 +63,14 @@ - + - + @@ -467,7 +467,7 @@ - + @@ -480,7 +480,7 @@ - + @@ -534,7 +534,7 @@ - + @@ -547,7 +547,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 9a39f817eef..85dcd2ba826 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -223,7 +223,7 @@ - + IAgoraMusicPlayer @@ -268,7 +268,7 @@ - + @@ -436,7 +436,7 @@ - getPlaySrc [1/2] + getPlaySrc @@ -1265,7 +1265,7 @@ - + @@ -1658,28 +1658,28 @@ - + getAudioEffectManager - + getEffectsVolume - + setEffectsVolume - + setVolumeOfEffect @@ -1708,70 +1708,70 @@ - + stopAllEffects - + preloadEffect - + unloadEffect - + pauseEffect - + pauseAllEffects - + resumeEffect - + resumeAllEffects - + setEffectPosition - + getEffectDuration - + getEffectCurrentPosition @@ -3219,7 +3219,7 @@ - + open @@ -5096,7 +5096,7 @@ - UserAudioSpectrumInfo + AudioSpectrumInfo @@ -5795,31 +5795,38 @@ + + + + ContentInspectType + + + - CONTENT_INSPECT_TYPE_INVALID + INVALID - CONTENT_INSPECT_TYPE_MODERATION + MODERATION - CONTENT_INSPECT_TYPE_SUPERVISE + SUPERVISE - CONTENT_INSPECT_TYPE_IMAGE_MODERATION + IMAGE_MODERATION @@ -6750,21 +6757,21 @@ - AUDIO_SAMPLE_RATE_32000 + TYPE_32000 - AUDIO_SAMPLE_RATE_44100 + TYPE_44100 - AUDIO_SAMPLE_RATE_48000 + TYPE_48000 @@ -10493,31 +10500,38 @@ + + + + StreamSubscribeState + + + - SUB_STATE_IDLE + IDLE - SUB_STATE_NO_SUBSCRIBED + NO_SUBSCRIBED - SUB_STATE_SUBSCRIBING + SUBSCRIBING - SUB_STATE_SUBSCRIBED + SUBSCRIBED @@ -10542,6 +10556,13 @@ + + + + VideoBufferType + + + @@ -10570,6 +10591,34 @@ + + + + VideoBufferType + + + + + + + VIDEO_BUFFER_RAW_DATA + + + + + + + VIDEO_BUFFER_ARRAY + + + + + + + VIDEO_BUFFER_TEXTURE + + + From 707ddc32ada9ecfe68e26e7e0094606972485adf Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Wed, 18 Sep 2024 10:11:59 +0800 Subject: [PATCH 17/20] fix publish errors --- .../API/api_irtcengine_playeffect3.dita | 8 +++--- dita/RTC-NG/API/rtc_api_overview.dita | 28 +++++++++---------- .../config/keys-rtc-ng-api-harmony.ditamap | 16 +---------- 3 files changed, 19 insertions(+), 33 deletions(-) diff --git a/dita/RTC-NG/API/api_irtcengine_playeffect3.dita b/dita/RTC-NG/API/api_irtcengine_playeffect3.dita index 40f83347ced..6d77e9871eb 100644 --- a/dita/RTC-NG/API/api_irtcengine_playeffect3.dita +++ b/dita/RTC-NG/API/api_irtcengine_playeffect3.dita @@ -77,8 +77,8 @@

        该方法在加入频道前后均可调用。

    - 调用限制 -

    如果你需要播放在线音效文件,声网建议先将在线音效文件缓存到本地设备,调用 将缓存的音效文件预加载到内存中,然后再调用此方法播放音效。否则,可能出现因在线音效文件加载超时、加载失败而导致的播放失败和无声的问题。

    + <ph props="android cpp apple framework">调用限制</ph> +

    如果你需要播放在线音效文件,声网建议先将在线音效文件缓存到本地设备,调用 将缓存的音效文件预加载到内存中,然后再调用此方法播放音效。否则,可能出现因在线音效文件加载超时、加载失败而导致的播放失败和无声的问题。

    -

    调用该方法启用外部视频源后,你可以调用 向 SDK 推送外部视频数据。

    +

    调用该方法启用外部视频源后,你可以调用 向 SDK 推送外部视频数据。

    +

    调用该方法启用外部视频源后,你可以调用 向 SDK 推送外部视频数据。

    调用时机 diff --git a/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita b/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita index 6b4e5a5f591..b7aebaaf27b 100644 --- a/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita +++ b/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita @@ -31,7 +31,7 @@
    1. 调用该方法创建视频轨道并获得视频轨道 ID。
    2. 调用 加入频道时,将 中的 customVideoTrackId 设置为你想要发布的视频轨道 ID,并将 publishCustomVideoTrack 设置为
    3. -
    4. 调用 videoTrackId 指定为步骤 2 中指定的视频轨道 ID,即可实现在频道内发布对应的自定义视频源。
    5. +
    6. 调用 videoTrackId 指定为步骤 2 中指定的视频轨道 ID,即可实现在频道内发布对应的自定义视频源。

    diff --git a/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita b/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 3d7085ba607..77c23131a83 100644 --- a/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -14,7 +14,7 @@

    public abstract int enableInEarMonitoring(boolean enabled, int includeAudioFilters); - public abstract enableInEarMonitoring(enabled: boolean, includeAudioFilters: number): number; + public abstract enableInEarMonitoring(enabled: boolean, includeAudioFilters?: Constants.EarMontoringFilterType): number; - (int)enableInEarMonitoring:(BOOL)enabled includeAudioFilters:(AgoraEarMonitoringFilterType)includeAudioFilters; virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters) = 0; UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine") @@ -57,8 +57,8 @@ includeAudioFilters - 耳返 Audio filter 类型。详见 - 耳返 Audio filter 类型: + 耳返 Audio filter 类型。详见 + 耳返 Audio filter 类型:

    • (1 << 0):不在耳返中添加 Audio filter。
    • (1 << 1): 在耳返中添加人声效果 Audio filter。如果你实现了美声、音效等功能,用户可以在耳返中听到添加效果后的声音。该枚举值支持使用按位或运算符(|)进行组合。
    • diff --git a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita index a73ba01793b..d00c4f1e1c5 100644 --- a/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita +++ b/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita @@ -29,7 +29,7 @@
      详情

      虚拟背景功能支持将本地用户原来的背景替换为静态图片、动态视频、将背景虚化,或者将人像与背景分割以实现人像画中画。成功开启虚拟背景功能后,频道内所有用户都能看到自定义的背景。

      -

      该方法和 均可用于开启/关闭虚拟背景,区别在于该方法支持在开启虚拟背景时指定应用虚拟背景的媒体源。

      +

      该方法和 均可用于开启/关闭虚拟背景,区别在于该方法支持在开启虚拟背景时指定应用虚拟背景的媒体源。

      请在 之后调用该方法。

      diff --git a/dita/RTC-NG/API/api_irtcengine_playeffect3.dita b/dita/RTC-NG/API/api_irtcengine_playeffect3.dita index 6d77e9871eb..37066919aef 100644 --- a/dita/RTC-NG/API/api_irtcengine_playeffect3.dita +++ b/dita/RTC-NG/API/api_irtcengine_playeffect3.dita @@ -99,6 +99,7 @@

      播放文件的地址,支持在线文件的 URL 地址、播放文件的绝对路径,需精确到文件名及后缀。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP 等。详见支持的媒体格式

      播放文件的地址,支持以 content:// 开头的 URI 地址、以 /assets/ 开头的路径、在线文件的 URL 地址、本地文件的绝对路径,需精确到文件名及后缀。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP。详见支持的媒体格式

      播放文件的地址,支持以 ipod-library// 开头的文件路径、在线文件的 URL 地址、文件的绝对路径,需精确到文件名及后缀。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP。详见支持的媒体格式

      +

      播放文件的地址。

      如果你已通过 将音效加载至内存,请确保该参数与 中设置的 filePath 相同。 diff --git a/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita index 89c7370fd41..57d8825412a 100644 --- a/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -34,7 +34,7 @@

    SDK 默认设置用户角色为观众,你可以调用该方法设置用户角色为主播。用户角色(role)确定用户在 SDK 层的权限,包含是否有发流权限等。

    -

    该方法与 的区别在于,该方法还支持设置观众端延时级别(audienceLatencyLevel)。audienceLatencyLevel 需与 role 结合使用,确定用户在其权限范围内可以享受到的服务。例如对于观众,选择接收低延时还是超低延时的视频流。不同的延时级别会影响计费,详见

    +

    该方法与 的区别在于,该方法还支持设置观众端延时级别(audienceLatencyLevel)。audienceLatencyLevel 需与 role 结合使用,确定用户在其权限范围内可以享受到的服务。例如对于观众,选择接收低延时还是超低延时的视频流。不同的延时级别会影响计费,详见

    调用时机 diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita b/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita index f5353593415..e0bab685196 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita @@ -45,7 +45,7 @@ quality - 录音质量。详见 + 录音质量。详见
    • 0: 低音质。采样率为 32 kHz,录制 10 分钟的文件大小为 1.2 M 左右。
    • 1: 中音质。采样率为 32 kHz,录制 10 分钟的文件大小为 2 M 左右。
    • diff --git a/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita b/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita index 997066632b2..88419566f70 100644 --- a/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita +++ b/dita/RTC-NG/API/api_irtcengine_startlocalvideotranscoder.dita @@ -38,15 +38,15 @@

      你可以在远程会议、直播、在线教育等场景下开启本地合图功能,可以让用户更加方便地查看和管理多个视频画面,同时支持人像画中画等功能。

      以下是一个实现人像画中画的典型场景:

        -
      1. 调用 ,并将自定义背景图设置为 ,即:在摄像头采集的视频中将人像和背景分割。
      2. -
      3. 调用 ,开始采集屏幕共享视频流。
      4. +
      5. 调用 ,并将自定义背景图设置为 ,即:在摄像头采集的视频中将人像和背景分割。
      6. +
      7. 调用 ,开始采集屏幕共享视频流。
      8. 调用该方法,并将采集人像的视频源设置为参与本地合图的视频源之一,即可在合图后的视频中实现人像画中画。

    调用时机
      -
    • 如果你需要对本地采集的视频流进行合图,需要在 之后调用该方法。
    • +
    • 如果你需要对本地采集的视频流进行合图,需要在 之后调用该方法。
    • 如果你要将合图后的视频流发布到频道中,需要在调用 时,将 中的 publishTranscodedVideoTrack 设置为
    @@ -59,6 +59,7 @@
  • 在 macOS 平台上,最多支持 4 路摄像头采集的视频流 + 1 路屏幕共享流合图。
  • 在 Android 和 iOS 平台上,最多支持 2 路摄像头采集的视频流(需要设备本身支持双摄或支持外接摄像头)+ 1 路屏幕共享合图。
  • 在 Android 平台上,最多支持 2 路摄像头采集的视频流(需要设备本身支持双摄或支持外接摄像头)+ 1 路屏幕共享合图。
  • +
  • 在 HarmonyOS 平台上,最多支持 2 路摄像头采集的视频流(需要设备本身支持双摄或支持外接摄像头)+ 1 路屏幕共享合图。
  • 在 iOS 平台上,最多支持 2 路摄像头采集的视频流(需要设备本身支持双摄或支持外接摄像头)+ 1 路屏幕共享合图。
  • 在进行合图配置时,需确保采集人像的摄像头视频流在合图中的图层编号大于屏幕共享流的图层编号,否则人像会被屏幕共享覆盖、无法显示在最终合图的视频流中。
  • diff --git a/dita/RTC-NG/API/api_irtcengine_startpreview.dita b/dita/RTC-NG/API/api_irtcengine_startpreview.dita index a67d13e9d80..4f75a86c559 100644 --- a/dita/RTC-NG/API/api_irtcengine_startpreview.dita +++ b/dita/RTC-NG/API/api_irtcengine_startpreview.dita @@ -34,7 +34,7 @@ 调用限制
    • 本地预览默认开启镜像功能。
    • -
    • 在离开频道后,本地预览依然处于开启状态。你需要调用 关闭本地预览。
    • +
    • 在离开频道后,本地预览依然处于开启状态。你需要调用 关闭本地预览。
    diff --git a/dita/RTC-NG/API/api_irtcengine_stopeffect.dita b/dita/RTC-NG/API/api_irtcengine_stopeffect.dita index 3e2ce455c0a..0e74806bcd4 100644 --- a/dita/RTC-NG/API/api_irtcengine_stopeffect.dita +++ b/dita/RTC-NG/API/api_irtcengine_stopeffect.dita @@ -28,7 +28,7 @@

    -

    当你不需要再播放某一音效文件时,可以调用该方法停止播放。如果你仅需暂停播放,请调用

    +

    当你不需要再播放某一音效文件时,可以调用该方法停止播放。如果你仅需暂停播放,请调用

    调用时机 diff --git a/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita b/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita index d63c70f6c8b..9d17bb39593 100644 --- a/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita +++ b/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita @@ -61,6 +61,7 @@
  • iOS: /App Sandbox/Library/Caches/example.jpg
  • macOS: ~/Library/Logs/example.jpg
  • Android: /storage/emulated/0/Android/data/<package name>/files/example.jpg
  • +
  • HarmonyOS: /data/app/el2/100/base/PACKAGENAME/haps/ENTRYNAME/files/example.jpg
  • 请确保目录存在且可写。 diff --git a/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita b/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita index dd4a8b6eadc..c82d5458061 100644 --- a/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita +++ b/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita @@ -36,12 +36,12 @@

    调用该方法后,SDK 会终止音视频互动、离开当前频道,并会释放会话相关的所有资源。

    -

    调用 成功加入频道后,必须调用本方法或 结束通话,否则无法开始下一次通话。

    -

    调用 成功加入频道后,必须调用本方法结束通话,否则无法开始下一次通话。

    +

    调用 成功加入频道后,必须调用本方法或 结束通话,否则无法开始下一次通话。

    +

    调用 成功加入频道后,必须调用本方法结束通话,否则无法开始下一次通话。

    • 该方法是异步操作,调用返回时并没有真正退出频道。
    • -
    • 如果你调用了 后,会同时离开 加入的频道。
    • +
    • 如果你调用了 后,会同时离开 加入的频道。
    • 如果你调用了 后,会同时离开 加入的频道。
    diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita index 8618ec6077d..fb1a8b9b2f9 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita @@ -15,7 +15,7 @@

    void onPlayBufferUpdated(long playCachedBuffer); - + onPlayBufferUpdated?:(playCachedBuffer:number) => void - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didPlayBufferUpdated:(NSInteger)playCachedBuffer NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:didPlayBufferUpdated:)); virtual void onPlayBufferUpdated(int64_t playCachedBuffer) = 0; diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita index a19de0cc597..e96e83445bc 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita @@ -15,7 +15,7 @@

    void onPlayerEvent(Constants.MediaPlayerEvent eventCode, long elapsedTime, String message); - onPlayerEvent?:(eventCode:Constants.MediaPlayerEvent,elapsedTime:bigint,message:string) => void + onPlayerEvent?:(eventCode:Constants.MediaPlayerEvent,elapsedTime:number,message:string) => void (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didOccurEvent:(AgoraMediaPlayerEvent)eventCode elapsedTime:(NSInteger)elapsedTime diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita index 3136ed52ea5..72aa61f043d 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita @@ -14,7 +14,7 @@

    void onPositionChanged(long positionMs, long timestampMs); - onPositionChanged?:(positionMs:bigint,timestampMs:bigint) => void + onPositionChanged?:(positionMs:number,timestampMs:number) => void - (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit didChangedToPosition:(NSInteger)positionMs atTimestamp:(NSTimeInterval)timestampMs NS_SWIFT_NAME(AgoraMediaPlayer(_:didChangedToPosition:atTimestamp:)); diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita index d26283456fe..1d8e321e3ed 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita @@ -41,7 +41,7 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));

    触发时机 -

    在以下任意一种情况时,会触发此回调:

      +

      在以下任意一种情况时,会触发此回调:

      • 加入频道后调用 设置用户角色或观众端延时级别。
      • 加入频道前调用 并将用户角色设为 AUDIENCE

      在以下任意一种情况时,会触发此回调:

        @@ -50,7 +50,7 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));
        使用限制 -

        当你在加入频道前调用 并将用户角色设为 BROADCASTER 时,不会触发此回调。

        +

        当你在加入频道前调用 并将用户角色设为 BROADCASTER 时,不会触发此回调。

        当你在加入频道前调用 并将用户角色设为 BROADCASTER 时,不会触发此回调。

        diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita index 4afdb9459e0..00531d2d469 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita @@ -14,7 +14,7 @@

        public void onJoinChannelSuccess(String channel, int uid, int elapsed) {} - onJoinChannelSuccess?:(cid:string, uid:number, elapsed:number) => void; + onJoinChannelSuccess?:(channel:string, uid:number, elapsed:number) => void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didJoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed; virtual void onJoinChannelSuccess(const char* channel, diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita index 5f97ed34e2a..860ba4fcdfb 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita @@ -15,7 +15,7 @@

        public void onLocalVideoStateChanged(Constants.VideoSourceType source, int state, int reason) {} - onLocalVideoStateChanged?:(source: Constants.VideoSourceType, state:Constants.LocalVideoStreamState,error:Constants.LocalVideoStreamReason) => void + onLocalVideoStateChanged?:(source: Constants.VideoSourceType, state:Constants.LocalVideoStreamState,reason:Constants.LocalVideoStreamReason) => void - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localVideoStateChangedOfState:(AgoraVideoLocalState)state reason:(AgoraLocalVideoStreamReason)reason sourceType:(AgoraVideoSourceType)sourceType NS_SWIFT_NAME(rtcEngine(_:localVideoStateChangedOf:reason:sourceType:)); virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason) { diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita index 1509afcddb4..0f36e832506 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita @@ -14,7 +14,7 @@

        public void onRejoinChannelSuccess(String channel, int uid, int elapsed) {} - onRejoinChannelSuccess?:(cid:string, uid:number, elapsed:number) => void; + onRejoinChannelSuccess?:(channel:string, uid:number, elapsed:number) => void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didRejoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed; virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita index 4b204135a3a..4a301984bd2 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita @@ -14,7 +14,7 @@

        public void onRtmpStreamingStateChanged(String url, int state, int reason) {} - onRtmpStreamingStateChanged? : (url:string,state:Constants.RtmpStreamPublishState,errCode:Constants.RtmpStreamPublishReason) => void; + onRtmpStreamingStateChanged? : (url:string,state:Constants.RtmpStreamPublishState,reason:Constants.RtmpStreamPublishReason) => void; - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine rtmpStreamingChangedToState:(NSString * _Nonnull)url state:(AgoraRtmpStreamingState)state reason:(AgoraRtmpStreamingReason)reason NS_SWIFT_NAME(rtcEngine(_:rtmpStreamingChangedToState:state:reason:)); diff --git a/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita b/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita index e50a88db3f0..66925b21623 100644 --- a/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita +++ b/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita @@ -31,7 +31,7 @@ public mccUid:number = 0 - public maxCacheSize:number = 0 + public maxCacheSize:number = 10 public eventHandler?:IMusicContentCenterEventHandler diff --git a/dita/RTC-NG/API/class_videocanvas.dita b/dita/RTC-NG/API/class_videocanvas.dita index 3c03a71e988..8ac957f7c5f 100644 --- a/dita/RTC-NG/API/class_videocanvas.dita +++ b/dita/RTC-NG/API/class_videocanvas.dita @@ -287,7 +287,7 @@ class VideoCanvas { 当视频源为合图视频流 () 时,该参数表示发布合图视频流的用户 ID。 - + subviewUid 发布某一路合图子视频流的用户 ID。 预留参数。 diff --git a/dita/RTC-NG/API/class_videoframe.dita b/dita/RTC-NG/API/class_videoframe.dita index 8a355275c8d..9e9805da7e7 100644 --- a/dita/RTC-NG/API/class_videoframe.dita +++ b/dita/RTC-NG/API/class_videoframe.dita @@ -263,16 +263,16 @@ public yBuffer: ArrayBuffer | null = null; public uBuffer: ArrayBuffer | null = null; public vBuffer: ArrayBuffer | null = null; + public rotation:number = 0; public timestamp:number = 0; - public stride:number = 0; + public yStride:number = 0; public uStride:number = 0; public vStride:number = 0; public width:number = 0; public height:number = 0; - public type:VideoBufferType = VideoBufferType.VIDEO_BUFFER_RAW_DATA; + public type:VideoBufferType = VideoBufferType.RAW_DATA; public format:VideoPixelFormat = VideoPixelFormat.VIDEO_PIXEL_NV21; - public faceInfo:Array<FaceDetectionInfo> | undefined = undefined; constructor(type:VideoBufferType,format:VideoPixelFormat) { this.type = type; this.format = format; diff --git a/dita/RTC-NG/API/enum_connectionstatetype.dita b/dita/RTC-NG/API/enum_connectionstatetype.dita index 8374c4ed44f..5096cbbb726 100644 --- a/dita/RTC-NG/API/enum_connectionstatetype.dita +++ b/dita/RTC-NG/API/enum_connectionstatetype.dita @@ -50,7 +50,7 @@ -

        5: 网络连接失败。该状态表示 SDK 已不再尝试重新加入频道,需要调用 离开频道。 +

        5: 网络连接失败。该状态表示 SDK 已不再尝试重新加入频道,需要调用 离开频道。

        • 如果用户还想重新加入频道,则需要再次调用
        • 如果 SDK 因服务器端使用 RESTful API 禁止加入频道,则 App 会收到
        • diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index 9cc985b1d75..bfe45a2f921 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -1447,7 +1447,7 @@ - + @@ -1698,7 +1698,7 @@ - + diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index fc367347568..41828e628cb 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -414,7 +414,6 @@ - @@ -501,7 +500,7 @@ - + @@ -708,9 +707,9 @@ - - - + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 3d91dce340d..c2db156168f 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -440,7 +440,7 @@ - + getPlaySrc @@ -1665,21 +1665,21 @@ - + getEffectsVolume - + setEffectsVolume - + setVolumeOfEffect @@ -1708,7 +1708,7 @@ - + stopAllEffects @@ -1722,56 +1722,56 @@ - + unloadEffect - + pauseEffect - + pauseAllEffects - + resumeEffect - + resumeAllEffects - + setEffectPosition - + getEffectDuration - + getEffectCurrentPosition @@ -3575,7 +3575,7 @@ - + setLogFile @@ -3589,7 +3589,7 @@ - + setLogFilter @@ -4027,7 +4027,7 @@ - + onPlayBufferUpdated @@ -4088,13 +4088,6 @@ - - - - onAudioMixingFinished - - - @@ -6218,49 +6211,49 @@ - AUDIO_MIXING_REASON_CAN_NOT_OPEN + CAN_NOT_OPEN - AUDIO_MIXING_REASON_TOO_FREQUENT_CALL + TOO_FREQUENT_CALL - AUDIO_MIXING_REASON_INTERRUPTED_EOF + INTERRUPTED_EOF - AUDIO_MIXING_REASON_OK + OK - AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED + ONE_LOOP_COMPLETED - AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED + ALL_LOOPS_COMPLETED - AUDIO_MIXING_REASON_STOPPED_BY_USER + STOPPED_BY_USER @@ -7664,31 +7657,38 @@ + + + + EarMontoringFilterType + + + - EAR_MONITORING_FILTER_NONE + NONE - EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS + BUILT_IN_AUDIO_FILTERS - EAR_MONITORING_FILTER_NOISE_SUPPRESSION + NOISE_SUPPRESSION - EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTER + REUSE_POST_PROCESSING_FILTER @@ -10587,21 +10587,21 @@ - VIDEO_BUFFER_RAW_DATA + RAW_DATA - VIDEO_BUFFER_ARRAY + ARRAY - VIDEO_BUFFER_TEXTURE + TEXTURE diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-harmony.ditamap index 92270584b53..fc86a05ff6f 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-harmony.ditamap @@ -17,14 +17,14 @@ - + 视频属性 - + 使用 Token 鉴权 @@ -66,7 +66,7 @@ - + 屏幕共享 diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index 1fd558ede65..3da1b63ad2e 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -2342,9 +2342,9 @@ - + - + @@ -2424,15 +2424,15 @@ - + - + - + @@ -2441,7 +2441,7 @@ - + @@ -2570,7 +2570,7 @@ - + From de1e575807bc670d3a7153cb035c081b32a34c47 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Mon, 23 Sep 2024 16:08:46 +0800 Subject: [PATCH 19/20] 1 --- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 2 +- dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 41828e628cb..cddbad57f3d 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -476,7 +476,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index c2db156168f..ccd8fbf9b52 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -3233,7 +3233,7 @@ - + stop From 12b9f7efcb3b20ec6f6466bb88aaed4f4835c8e0 Mon Sep 17 00:00:00 2001 From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com> Date: Sun, 29 Sep 2024 17:35:41 +0800 Subject: [PATCH 20/20] 1 --- .../API/api_imediaplayer_getduration.dita | 2 +- dita/RTC-NG/API/api_imediaplayer_getmute.dita | 2 +- .../api_imediaplayer_getplayoutvolume.dita | 2 +- ...i_imediaplayer_getpublishsignalvolume.dita | 2 +- .../API/api_imediaplayer_getstreaminfo.dita | 2 +- ...iaplayer_registerplayersourceobserver.dita | 2 +- .../api_imusiccontentcenter_getcaches.dita | 6 ++-- .../RTC-NG/API/api_irtcengine_initialize.dita | 6 ++-- ...ne_setdefaultaudioroutetospeakerphone.dita | 4 +-- .../api_irtcengine_startaudiorecording.dita | 2 +- ...rsourceobserver_onplayerplaybackstats.dita | 2 +- dita/RTC-NG/API/rtc_api_data_type.dita | 2 +- dita/RTC-NG/API/rtc_api_overview.dita | 2 +- dita/RTC-NG/RTC_NG_API_Harmony.ditamap | 4 +-- .../config/keys-rtc-ng-api-harmony.ditamap | 4 +-- .../config/relations-rtc-ng-api.ditamap | 30 +++++++++---------- 16 files changed, 37 insertions(+), 37 deletions(-) diff --git a/dita/RTC-NG/API/api_imediaplayer_getduration.dita b/dita/RTC-NG/API/api_imediaplayer_getduration.dita index f2e51170786..fc4fd2824e9 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getduration.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getduration.dita @@ -40,7 +40,7 @@
        • < 0: 方法调用失败。详见了解详情和解决建议。

        媒体文件总时长(毫秒)。

        -
          +
          • 方法调用成功时,返回媒体资源的总时长,单位毫秒。
          • ≤ 0:方法调用失败。详见了解详情和解决建议。
        diff --git a/dita/RTC-NG/API/api_imediaplayer_getmute.dita b/dita/RTC-NG/API/api_imediaplayer_getmute.dita index 0ec48925974..53b46f2e439 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getmute.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getmute.dita @@ -44,7 +44,7 @@
      • 0: 方法调用成功。
      • < 0: 方法调用失败。详见了解详情和解决建议。
      -
        +
        • :当前播放的媒体文件为静音。
        • :当前播放的媒体文件没有静音。
    diff --git a/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita b/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita index 5440e1048af..6943719e1b7 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita @@ -45,7 +45,7 @@
  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见了解详情和解决建议。
  • -

    返回当前本地播放音量,取值范围从 0 到 100: +

    返回当前本地播放音量,取值范围从 0 到 100:

    • 0: 无声。
    • 100: (默认)媒体文件的原始播放音量。
    • diff --git a/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita b/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita index 6ca4e1cff36..0bf4e2dd8f5 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita @@ -39,7 +39,7 @@
    • 0: 方法调用成功。
    • < 0: 方法调用失败。详见了解详情和解决建议。
    -
      +
      • ≥ 0: 播放文件的远端播放音量。
      • < 0: 方法调用失败。详见了解详情和解决建议。
    diff --git a/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita b/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita index 26908348228..3c076a692d7 100644 --- a/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita +++ b/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita @@ -40,7 +40,7 @@ index 媒体流索引值。该参数需小于 count 参数。 - 媒体流索引值。该参数的值需小于 的返回值。 + 媒体流索引值。该参数的值需小于 的返回值。 info diff --git a/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita b/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita index deddbe440f3..e688298ebdd 100644 --- a/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita +++ b/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita @@ -51,7 +51,7 @@
    <ph keyref="return-section-title"/>

    方法成功调用时,无返回值;方法调用失败时,会抛出 异常,你需要捕获异常并进行处理。详见了解详情和解决建议。

    -
      +
      • 0: 方法调用成功。
      • < 0: 方法调用失败。详见了解详情和解决建议。
      diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita index d24ecdf5d6d..776ec443c01 100644 --- a/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita +++ b/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita @@ -53,10 +53,10 @@
    • 0: 方法调用成功。
    • < 0: 方法调用失败。详见了解详情和解决建议。
    -
      -
    • 方法调用成功时,返回包含 对象的数组。
    • +
        +
      • 方法调用成功时,返回包含 对象的数组。
      • 方法调用成功时,返回 对象的列表。
      • -
      • 方法调用失败时,返回
      • +
      • 方法调用失败时,返回
      • 方法调用失败时,会抛出 异常,你需要捕获异常并进行处理。详见了解详情和解决建议。

      方法调用成功时,返回一个包含以下属性的对象: diff --git a/dita/RTC-NG/API/api_irtcengine_initialize.dita b/dita/RTC-NG/API/api_irtcengine_initialize.dita index 82ac79a6fcb..e47e88fbe15 100644 --- a/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -2,7 +2,7 @@ <ph keyref="initialize"/> - 创建并初始化 初始化 + 创建并初始化 初始化 @@ -36,7 +36,7 @@

      调用时机

      请确保在调用其他 API 前先调用 创建并初始化

      -

      请确保在调用其他 API 前先调用该方法创建并初始化

      +

      请确保在调用其他 API 前先调用该方法创建并初始化

      调用限制 @@ -47,7 +47,7 @@ context - config + config

      实例的配置。详见

      diff --git a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita index c8aff2e99c4..279942558e1 100644 --- a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -53,8 +53,8 @@

      无。

      参数 diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita b/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita index e0bab685196..d940fcb420c 100644 --- a/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita +++ b/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita @@ -45,7 +45,7 @@ quality - 录音质量。详见 + 录音质量。详见
      • 0: 低音质。采样率为 32 kHz,录制 10 分钟的文件大小为 1.2 M 左右。
      • 1: 中音质。采样率为 32 kHz,录制 10 分钟的文件大小为 2 M 左右。
      • diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita index b7b937eb0c0..eeac90e1f1f 100644 --- a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita +++ b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita @@ -42,7 +42,7 @@ 参数 - stats + stats info 媒体资源的相关信息,详见 diff --git a/dita/RTC-NG/API/rtc_api_data_type.dita b/dita/RTC-NG/API/rtc_api_data_type.dita index 367403d9ef6..412b302f670 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -319,7 +319,7 @@
      • -
      • +
      • diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index bfe45a2f921..d17ddd554c6 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -2134,7 +2134,7 @@ - + diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index cddbad57f3d..db9d21b3e4f 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -492,7 +492,7 @@ - + @@ -638,7 +638,7 @@ - + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index ccd8fbf9b52..a25fea00e75 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -3971,7 +3971,7 @@ - + onMetaData @@ -4170,7 +4170,7 @@ - + onAudioRouteChanged diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index 3da1b63ad2e..ed9d9bede9c 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -2268,9 +2268,9 @@ - + - + @@ -2292,15 +2292,15 @@ - - - - - - - + + + + + + + - + @@ -2393,7 +2393,7 @@ - + @@ -2408,7 +2408,7 @@ - + @@ -2519,7 +2519,7 @@ - + @@ -2558,7 +2558,7 @@ - + @@ -2638,7 +2638,7 @@ - +