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..fc4fd2824e9 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")
@@ -40,7 +40,7 @@
< 0: 方法调用失败。详见了解详情和解决建议。
媒体文件总时长(毫秒)。
-
+
- 方法调用成功时,返回媒体资源的总时长,单位毫秒。
- ≤ 0:方法调用失败。详见了解详情和解决建议。
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 3e40fe876f9..53b46f2e439 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")
@@ -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 60cabf50b8f..6943719e1b7 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")
@@ -45,7 +45,7 @@
0: 方法调用成功。
< 0: 方法调用失败。详见了解详情和解决建议。
- 返回当前本地播放音量,取值范围从 0 到 100:
+
返回当前本地播放音量,取值范围从 0 到 100:
- 0: 无声。
- 100: (默认)媒体文件的原始播放音量。
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 fdb7847ed4e..0bf4e2dd8f5 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")
@@ -39,7 +39,7 @@
- 0: 方法调用成功。
- < 0: 方法调用失败。详见了解详情和解决建议。
-
+
- ≥ 0: 播放文件的远端播放音量。
- < 0: 方法调用失败。详见了解详情和解决建议。
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..3c076a692d7 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")
@@ -40,7 +40,7 @@
index
媒体流索引值。该参数需小于 的 count 参数。
- 媒体流索引值。该参数的值需小于 的返回值。
+ 媒体流索引值。该参数的值需小于 的返回值。
info
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 4bb4bcbef2a..21849727ec4 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 de79bb21acc..694a44647f5 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 6cca2a36508..f8400c81cb9 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;
@@ -34,7 +34,8 @@
调用该方法后,如果收到 回调报告事件 ,则预加载成功;如果你收到 回调报告事件 ,则预加载失败。
预加载成功后,如果你想播放媒体资源,请调用 ;如果你想清空播放列表,请调用 。
- SDK 不支持你预加载重复的媒体资源到播放列表,但支持你将正在播放的媒体资源再次预加载到播放列表。
+ - 调用该方法前,请确保你已经调用 或 成功打开媒体资源。
+ - SDK 不支持你预加载重复的媒体资源到播放列表,但支持你将正在播放的媒体资源再次预加载到播放列表。
参数
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 3b05746bc02..e688298ebdd 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(BlueprintPure, Category = "Agora|IRtcEngine")
@@ -51,7 +51,7 @@
方法成功调用时,无返回值;方法调用失败时,会抛出 异常,你需要捕获异常并进行处理。详见了解详情和解决建议。
-
+
- 0: 方法调用成功。
- < 0: 方法调用失败。详见了解详情和解决建议。
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 0c3d5b5bc4d..a48fd1f92ee 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")
@@ -27,7 +27,7 @@ int SelectAudioTrack(int index);
详情
- 获取音频文件的音轨索引后,你可以调用该方法指定任一音轨进行播放。例如,如果一个多音轨文件的不同音轨存放了不同语言的歌曲,则你可以调用该方法设置播放语言。
+ 获取音频文件的音轨索引后,你可以调用该方法指定任一音轨进行播放。如果一个多音轨文件的不同音轨存放了不同语言的歌曲,你可以调用该方法设置播放语言。
你需要在调用 获取音频流索引值后调用该方法。
参数
diff --git a/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita b/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita
index dac8b19ffce..e9f079cf9ee 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;
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
diff --git a/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita b/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita
index d8a9cfc22ef..56e49ff9999 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")
@@ -38,8 +38,8 @@
mode
- 声道模式。详见 。
-
+ 声道模式。详见 。
+
- (0): 原始模式。
- (1): 左声道模式。该模式用左声道的音频替换右声道的音频,即用户只能听到左声道的音频。
- (2): 右声道模式。该模式用右声道的音频替换左声道的音频,即用户只能听到右声道的音频。
diff --git a/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita b/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita
index 5825f796399..e96cd000ccf 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")
@@ -31,10 +31,14 @@
参数
-
+
+
+ pitch
+ 按半音音阶调整本地播放的音乐文件的音调,默认值为 0,即不调整音调。取值范围为 [-12,12],每相邻两个值的音高距离相差半音。取值的绝对值越大,音调升高或降低得越多。
+
@@ -44,4 +48,4 @@
- < 0: 方法调用失败。详见了解详情和解决建议。
-
\ No newline at end of file
+
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 68c1329ffc6..bad4a63853e 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;
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
diff --git a/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita b/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita
index 5aaf3cb7443..76f1ad62675 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;
UFUNCTION(BlueprintCallable, Category = "Agora|IMediaPlayer")
diff --git a/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita
index ca0a751f4cb..9ff525e28ec 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;
@@ -32,7 +32,7 @@
renderMode
- mode
+ mode
播放器视图的渲染模式。详见 。
播放器视图的渲染模式:
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 8cd3674b14b..880836ce14a 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 d5131633764..43c84f3e753 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_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 855d5cc319c..c78f307adb5 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;
@@ -44,7 +44,7 @@
返回值
- - 方法调用成功:返回 对象。
+ - 方法调用成功:返回 对象。
- 方法调用成功:返回 实例。
- 方法调用失败:返回空指针。
diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita b/dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita
index d27c13bc22c..e19ccd7dc3f 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 4abb151a5cf..c4aa69341dd 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 };
@@ -30,7 +30,7 @@
- v4.2.0
- 调用该方法前,你需要预先分配一定大小的内存空间用来存储缓存音乐资源的信息。如果你需要设置可缓存的音乐资源数量,可通过 的 configurationconfig 来设置。
+ 调用该方法前,你需要预先分配一定大小的内存空间用来存储缓存音乐资源的信息。如果你需要设置可缓存的音乐资源数量,可通过 的 configurationconfig 来设置。
当你不再需要使用已缓存的音乐资源时,你需要及时释放内存以防止内存泄漏。
@@ -53,10 +53,10 @@
- 0: 方法调用成功。
- < 0: 方法调用失败。详见了解详情和解决建议。
-
- - 方法调用成功时,返回包含 对象的数组。
- - 方法调用成功时,返回 对象的列表。
- - 方法调用失败时,返回 。
+
+ - 方法调用成功时,返回包含 对象的数组。
+ - 方法调用成功时,返回 对象的列表。
+ - 方法调用失败时,返回 。
- 方法调用失败时,会抛出 异常,你需要捕获异常并进行处理。详见了解详情和解决建议。
方法调用成功时,返回一个包含以下属性的对象:
diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita
index b6628c469e4..22f61004c6f 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;
@@ -40,7 +40,8 @@
songCode
- 音乐资源编号,用于标识音乐资源。你可以通过调用 或 方法来获取音乐资源,并通过由此触发的 回调获取音乐资源的编号(songCode)。
+ 音乐资源编号,用于标识音乐资源。你可以通过调用 或 方法来获取音乐资源,并通过由此触发的 回调获取音乐资源的编号(songCode)。
+ 音乐资源编号,用于标识音乐资源。你可以通过调用 或 方法来获取音乐资源,并通过由此触发的 回调获取音乐资源的编号(songCode)。
jsonOption
diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita b/dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita
index b31960d3b84..df4e2e9eca5 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 54725b6933c..10aece819f6 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 60cab9cbb1e..c297298723f 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 ea8a897072a..4d39164e268 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;
@@ -30,7 +30,8 @@
- v4.2.2
- 在调用该方法前,你需要先获取到对应的音乐资源的编号。你可以通过调用 或 方法来获取音乐资源,并通过由此触发的 回调获取音乐资源的编号(songCode)。
+ 在调用该方法前,你需要先获取到对应的音乐资源的编号。你可以通过调用 或 方法来获取音乐资源,并通过由此触发的 回调获取音乐资源的编号(songCode)。
+ 在调用该方法前,你需要先获取到对应的音乐资源的编号。你可以通过调用 或 方法来获取音乐资源,并通过由此触发的 回调获取音乐资源的编号(songCode)。
当你调用该方法后,SDK 会触发 回调报告音乐资源的详细信息。
diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_initialize.dita b/dita/RTC-NG/API/api_imusiccontentcenter_initialize.dita
index 6dcbdc7e92e..4d82437ea9b 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;
@@ -37,7 +37,7 @@
参数
- configuration
+ configuration
config
的设置,详见 。
diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_ispreloaded.dita b/dita/RTC-NG/API/api_imusiccontentcenter_ispreloaded.dita
index 70ea7cb223d..53651d833f5 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;
@@ -31,7 +31,7 @@
- v4.1.0
- 该方法为同步调用。如需预加载新的音乐资源,可调用 。
+ 该方法为同步调用。如需预加载新的音乐资源,可调用 。
参数
diff --git a/dita/RTC-NG/API/api_imusiccontentcenter_registereventhandler.dita b/dita/RTC-NG/API/api_imusiccontentcenter_registereventhandler.dita
index b8eb426d1c0..32f66206ca3 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 5ceed8c2c5c..7771766894c 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 e1c8e3d76c5..5cd250ad70c 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 1d6ba9e8348..266f4562703 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 63d74487043..082b7e317cd 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_preload.dita b/dita/RTC-NG/API/api_imusicontentcenter_preload.dita
index 22c384814f6..4dcce6f8e7e 100644
--- a/dita/RTC-NG/API/api_imusicontentcenter_preload.dita
+++ b/dita/RTC-NG/API/api_imusicontentcenter_preload.dita
@@ -32,7 +32,8 @@
你可以调用该方法预先加载需要播放的音乐资源。成功调用该方法后,SDK 会触发 回调报告预加载音乐资源的事件。
- 在调用该方法来预加载音乐资源之前,你需要调用 或 方法来获取你需要播放的音乐资源,并通过由此触发的 回调获取音乐资源的编号(songCode)。
+ 在调用该方法来预加载音乐资源之前,你需要调用 或 方法来获取你需要播放的音乐资源,并通过由此触发的 回调获取音乐资源的编号(songCode)。
+ 在调用该方法前,你需要先获取到对应的音乐资源的编号。你可以通过调用 或 方法来获取音乐资源,并通过由此触发的 回调获取音乐资源的编号(songCode)。
如需销毁 对象,请在收到 回调后,再调用 方法。
diff --git a/dita/RTC-NG/API/api_imusicontentcenter_preload2.dita b/dita/RTC-NG/API/api_imusicontentcenter_preload2.dita
index 5323e96b98f..4b4b23dbfe5 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_imusicplayer_setplaymode.dita b/dita/RTC-NG/API/api_imusicplayer_setplaymode.dita
index 21c3e21caa5..455c38b8768 100644
--- a/dita/RTC-NG/API/api_imusicplayer_setplaymode.dita
+++ b/dita/RTC-NG/API/api_imusicplayer_setplaymode.dita
@@ -14,6 +14,7 @@
int setPlayMode(MusicPlayMode mode);
+ abstract setPlayMode(mode:Constants.MusicPlayMode):number
- (NSInteger)setPlayMode:(AgoraMusicPlayMode)mode NS_SWIFT_NAME(setPlayMode(mode:));
virtual int setPlayMode(MusicPlayMode mode) = 0;
diff --git a/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita b/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita
index aa65f2f19b8..29ff0d9edc8 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_adjustuserplaybacksignalvolume.dita b/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita
index 2dbc91178e1..8abb6fc82be 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita b/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita
index 21fa82d50ae..4f506631808 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|IRtcEngine")
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 @@
- 调用该方法创建视频轨道并获得视频轨道 ID。
- 调用 加入频道时,将 中的 customVideoTrackId 设置为你想要发布的视频轨道 ID,并将 publishCustomVideoTrack 设置为 。
- - 调用 将 videoTrackId 指定为步骤 2 中指定的视频轨道 ID,即可实现在频道内发布对应的自定义视频源。
+ - 调用 将 videoTrackId 指定为步骤 2 中指定的视频轨道 ID,即可实现在频道内发布对应的自定义视频源。
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 17e33987f45..205dd9990f9 100644
--- a/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita
+++ b/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita
@@ -2,7 +2,7 @@
- 创建媒体播放器对象。创建媒体播放器实例。
+ 创建媒体播放器对象。创建媒体播放器实例。
@@ -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_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_destroymediaplayer.dita b/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita
index b61680931c3..9b81f64a1e4 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_destroymediarecorder.dita b/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita
index 58ba7dbba2f..312ab68269e 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_enablecontentinspect.dita b/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita
index 7ca53965b14..77cb547f8bf 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|IRtcEngine")
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_enableextension.dita b/dita/RTC-NG/API/api_irtcengine_enableextension.dita
index 4c6dff8cd0d..4ffd4261cd3 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_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_enableinearmonitoring2.dita b/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita
index 84cada70fbb..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,7 +57,7 @@
includeAudioFilters
- 耳返 Audio filter 类型。详见 。
+ 耳返 Audio filter 类型。详见 。
耳返 Audio filter 类型:
- (1 << 0):不在耳返中添加 Audio filter。
diff --git a/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita b/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita
index 3e7060fde5a..3d551d0fb8e 100644
--- a/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita
+++ b/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita
@@ -35,7 +35,7 @@
适用场景
- 该方法不影响接收远端音频流,() 适用于只听不发的用户场景。
+ 该方法不影响远端音频流的接收和播放。() 适用于只接收远端音频而不发送本地采集音频的场景。
调用时机
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_getaudiomixingplayoutvolume.dita b/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita
index 7ef89893f35..e6f12ccd161 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita b/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita
index 74c4b5c49a2..2c268feb550 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_getcallid.dita b/dita/RTC-NG/API/api_irtcengine_getcallid.dita
index ff97334ebad..7dffca2be68 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_getcameramaxzoomfactor.dita b/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita
index 7902473d03a..637d7d1583a 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita b/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita
index 710fd1f1d26..a64117e54a9 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|IRtcEngine")
@@ -30,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_getversion.dita b/dita/RTC-NG/API/api_irtcengine_getversion.dita
index cc7be0bb342..d5f64006a0c 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_initialize.dita b/dita/RTC-NG/API/api_irtcengine_initialize.dita
index f9ea6da6a57..e47e88fbe15 100644
--- a/dita/RTC-NG/API/api_irtcengine_initialize.dita
+++ b/dita/RTC-NG/API/api_irtcengine_initialize.dita
@@ -2,7 +2,7 @@
- 创建并初始化 。初始化 。
+ 创建并初始化 。初始化 。
@@ -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;
@@ -34,7 +36,7 @@
调用时机
请确保在调用其他 API 前先调用 和 创建并初始化 。
- 请确保在调用其他 API 前先调用该方法创建并初始化 。
+ 请确保在调用其他 API 前先调用该方法创建并初始化 。
调用限制
@@ -45,7 +47,7 @@
context
- config
+ config
实例的配置。详见 。
diff --git a/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita b/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita
index 0c27a5767d2..2e5a3d37bde 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita b/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita
index b2afb6d78b7..1cefc1e7fa4 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita b/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita
index c49d159269e..ed2e9b80aa8 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;
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
@@ -36,7 +36,7 @@
- 该方法仅适用于 Android 和 iOS。
- - 该方法必须在 SDK 触发 回调,返回本地视频状态为 (2) 之后调用。
+ - 该方法必须在 SDK 触发 回调,返回本地视频状态为 (1) 之后调用。
- 建议你在调用 调节曝光系数前,先调用该方法查询当前摄像头是否支持曝光调节。
- 当你调用该方法时,查询的是当前正在使用的摄像头是否支持曝光调节,即调用 时指定的摄像头。
diff --git a/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita b/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita
index 7bfd7673c18..c467422f081 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita b/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita
index 68e714401b7..f145d36c129 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|IRtcEngine")
@@ -30,7 +30,7 @@
调用时机
- 该方法必须在 SDK 触发 回调,返回本地视频状态为 (2) 之后调用。
+ 该方法必须在 SDK 触发 回调,返回本地视频状态为 (1) 之后调用。
调用限制
diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel.dita
index b0b6fb7cc18..ca7efbbc519 100644
--- a/dita/RTC-NG/API/api_irtcengine_joinchannel.dita
+++ b/dita/RTC-NG/API/api_irtcengine_joinchannel.dita
@@ -72,7 +72,7 @@
uid
- 用户 ID。该参数用于标识在实时音视频互动频道中的用户。你需要自行设置和管理用户 ID,并确保同一频道内的每个用户 ID 是唯一的。该参数为 32 位有符号整数。取值范围为:-231-1 到 231-1。该参数为 32 位无符号整数。建议设置范围:1 到 232-1。如果不指定(即设为 0),SDK 会自动分配一个,并在 回调中返回, 应用层必须记住该返回值并维护,SDK 不对该返回值进行维护。
+ 用户 ID。该参数用于标识在实时音视频互动频道中的用户。你需要自行设置和管理用户 ID,并确保同一频道内的每个用户 ID 是唯一的。该参数为 32 位有符号整数。取值范围为:-231 到 231-1。该参数为 32 位无符号整数。建议设置范围:1 到 232-1。如果不指定(即设为 0),SDK 会自动分配一个,并在 回调中返回, 应用层必须记住该返回值并维护,SDK 不对该返回值进行维护。
diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
index 6d7a2522266..a99d76f6b0b 100644
--- a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
+++ b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
@@ -101,10 +101,10 @@
uid
- 用户 ID。该参数用于标识在实时音视频互动频道中的用户。你需要自行设置和管理用户 ID,并确保同一频道内的每个用户 ID 是唯一的。该参数为 32 位有符号整数。取值范围为:-231-1 到 231-1。该参数为 32 位无符号整数。建议设置范围:1 到 232-1。如果不指定(即设为 0),SDK 会自动分配一个,并在 回调中返回, 应用层必须记住该返回值并维护,SDK 不对该返回值进行维护。
+ 用户 ID。该参数用于标识在实时音视频互动频道中的用户。你需要自行设置和管理用户 ID,并确保同一频道内的每个用户 ID 是唯一的。该参数为 32 位有符号整数。取值范围为:-231 到 231-1。该参数为 32 位无符号整数。建议设置范围:1 到 232-1。如果不指定(即设为 0),SDK 会自动分配一个,并在 回调中返回, 应用层必须记住该返回值并维护,SDK 不对该返回值进行维护。
- options
+ options
mediaOptions
频道媒体设置选项。详见 。
@@ -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_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/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_pauseallchannelmediarelay.dita b/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita
index 065e6305600..85d10a1df9b 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_playeffect3.dita b/dita/RTC-NG/API/api_irtcengine_playeffect3.dita
index 40f83347ced..74dbcd8e916 100644
--- a/dita/RTC-NG/API/api_irtcengine_playeffect3.dita
+++ b/dita/RTC-NG/API/api_irtcengine_playeffect3.dita
@@ -78,7 +78,8 @@
调用限制
- 如果你需要播放在线音效文件,声网建议先将在线音效文件缓存到本地设备,调用 将缓存的音效文件预加载到内存中,然后再调用此方法播放音效。否则,可能出现因在线音效文件加载超时、加载失败而导致的播放失败和无声的问题。
+ 如果你需要播放在线音效文件,声网建议先将在线音效文件缓存到本地设备,调用 将缓存的音效文件预加载到内存中,然后再调用此方法播放音效。否则,可能出现因在线音效文件加载超时、加载失败而导致的播放失败和无声的问题。
+ 无。
filePath
@@ -99,7 +100,8 @@
播放文件的地址,支持在线文件的 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 相同。
+ 播放文件的地址。
+ 如果你已通过 将音效加载至内存,请确保该参数与 中设置的 filePath 相同。
loopCount
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 19f711af6cd..bcfc861227e 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;
@@ -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_resumeallchannelmediarelay.dita b/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita
index 640f99b544e..133825223ec 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita b/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita
index 2d0a0ddcc60..3f3cf0c3532 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|IRtcEngine")
@@ -37,7 +37,7 @@ int SelectAudioTrack(int index);
参数
- index
+ index
audioIndex
指定的播放音轨。取值范围应大于等于 0 且小于 的返回值。
diff --git a/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita b/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita
index a7eabfefe99..51fb0e395cd 100644
--- a/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita
+++ b/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita
@@ -38,12 +38,10 @@
调用 后,你可以调用该方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制:
- - 频道内每人最多能同时有 5 个数据通道。
- - 每个数据通道每秒最多能发送 60 个包(每个包最大为 1 KB)。
- - 每个数据通道每秒最多能发送 30 KB 数据。
+ - 频道内每个客户端最多可以同时拥有 5 个数据通道,所有数据通道共用的总发包码率限制为 30 KB/s。
+ - 每个数据通道每秒最多能发送 60 个包,每个包最大为 1 KB。
- 成功调用该方法后,远端会触发 回调,远端用户可以在该回调中获取接收到的流消息;
- 若调用失败,远端会触发 回调。
+ 成功调用该方法后,远端会触发 回调,远端用户可以在该回调中获取接收到的流消息;若调用失败,远端会触发 回调。
- 该方法需要在加入频道后、且调用 创建数据通道之后调用。
diff --git a/dita/RTC-NG/API/api_irtcengine_setaudiomixingplaybackspeed.dita b/dita/RTC-NG/API/api_irtcengine_setaudiomixingplaybackspeed.dita
index 7d5eaa34e2f..acd9d49d36b 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;
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
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
- 音频编码属性,包含采样率、码率、编码模式和声道数。详见 。
-
-
\ 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 73283a1bfd9..01f7efbca47 100644
--- a/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita
+++ b/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita
@@ -43,8 +43,8 @@
scenario
音频场景。不同的音频场景下,设备的音量类型是不同的。
- 详见 。
-
+ 详见 。
+
- (0):(默认)自动场景,根据用户角色和音频路由自动匹配合适的音质。
- (3): 高音质场景,适用于音乐为主的场景。
- (5): 聊天室场景,适用于用户需要频繁上下麦的场景。
diff --git a/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita b/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita
index a4d0fd953c8..92e3e79d2d6 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|IRtcEngine")
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 @@
该方法必须在开启本地摄像头采集前调用,如 和 前调用。
- 调用限制
+ 调用限制
在调整摄像头的焦距配置前,建议先调用 查询设备支持的焦距能力,再根据查询结果进行配置。
由于部分 Android 设备的限制,即使根据 的查询结果设置焦距类型,设置结果也可能不生效。
- 无。
+ 无。
参数
diff --git a/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita b/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita
index 46d1479943e..c1ae077263f 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 c0a6280e4f8..6efdd0619b2 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;
@@ -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_setcameratorchon.dita b/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita
index 38540f626d2..ed96514d3eb 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 dd52639346e..3d39dc25410 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;
@@ -38,7 +38,7 @@
参数
- factor
+ factor
zoomFactor
摄像头缩放比例。对不支持超广角的设备,取值范围从 1.0 到最大缩放比例;对支持超广角的设备,取值范围从 0.5 到最大缩放比例。你可以通过 方法获取设备支持的最大缩放比例。
diff --git a/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita
index b60eb80942f..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_setdefaultaudioroutetospeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita
index b8756fa1e36..279942558e1 100644
--- a/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita
+++ b/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita
@@ -46,15 +46,15 @@
调用时机
- 该方法需要在加入频道前调用。如需在加入频道后切换音频路由,请调用 。
+ 该方法需要在加入频道前调用。如需在加入频道后切换音频路由,请调用 。
参数
@@ -76,4 +76,4 @@
- < 0: 方法调用失败。详见了解详情和解决建议。
-
\ No newline at end of file
+
diff --git a/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita b/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita
index 6ff3ebeb3e4..ad4a198ef02 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 a05b40799b3..fb176f56eca 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_irtcengine_setenablespeakerphone.dita b/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita
index 042723de964..a271c08ab77 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|IRtcEngine")
diff --git a/dita/RTC-NG/API/api_irtcengine_setexternalremoteeglcontext.dita b/dita/RTC-NG/API/api_irtcengine_setexternalremoteeglcontext.dita
new file mode 100644
index 00000000000..5a01a581576
--- /dev/null
+++ b/dita/RTC-NG/API/api_irtcengine_setexternalremoteeglcontext.dita
@@ -0,0 +1,65 @@
+
+
+
+
+ 设置远端视频流渲染的 EGL 环境上下文。
+
+
+
+
+
+
+
+
+
+
+ public abstract int setExternalRemoteEglContext(Object eglContext);
+
+
+ virtual int setExternalRemoteEglContext(void* eglContext) = 0;
+
+
+
+
+
+
+
+
+
+ - 自从
+ - v4.5.0
+
+
+ 通过设置该方法,开发者可以替换 SDK 内部默认的远端 EGL 环境上下文,便于实现统一的 EGL 上下文管理。
+ 引擎销毁时,SDK 会自动释放 EGL 环境上下文。
+ 该方法仅适用于 Android。
+
+
+ 适用场景
+ 该方法适用于使用 Texture 格式的视频数据进行远端视频自渲染的场景。
+
+
+ 调用时机
+ 该方法需要在加入频道前调用。
+
+
+
+ 参数
+
+
+ eglContext
+ 用于远端视频流渲染的 EGL 环境上下文对象。
+
+
+
+
+ 方法成功调用时,无返回值;方法调用失败时,会抛出 异常,你需要捕获异常并进行处理。详见了解详情和解决建议。
+
+ - 0: 方法调用成功。
+ - < 0: 方法调用失败。详见了解详情和解决建议。
+
+
+
\ No newline at end of file
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_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_setplaybackaudioframebeforemixingparameters.dita b/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita
index 430977fea54..420f72f7254 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_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_setremotevideosubscriptionoptions.dita b/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita
index 02eb4b323e5..bafc3665171 100644
--- a/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita
+++ b/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita
@@ -35,21 +35,13 @@
详情
- 当远端发送双流时,可调用此方法来设置远端视频流的订阅选项。
-
-
- - 如果你只注册了 对象,则默认订阅原始视频数据和编码后的视频数据 (效果等同于 encodedFrameOnly 设置为 )。
- - 如果你只注册了 对象,则默认只订阅编码后的视频数据 (效果等同于 encodedFrameOnly 设置为 )。
- - 如果你先后注册了 和 对象,则默认订阅原始视频数据和编码后的视频数据 (效果等同于 encodedFrameOnly 设置为 )。
- - 如果你先调用该方法设置了 options 参数、然后再注册 或 对象,则需要再次调用该方法并按照以上两项描述设置 options 参数,以获得预期的效果。
-
- 声网推荐你按照以下步骤调用该方法:
-
-
- - 调用 加入频道时设置 autoSubscribeVideo 为 。
- - 在收到 回调后调用该方法,设置对指定远端用户视频流的订阅选项。
- - 调用 方法,开始恢复订阅指定远端用户的视频流。如果你在上一步中将 encodedFrameOnly 设置为 ,SDK 会在本地触发 回调,上报接收到的编码后视频帧信息。
-
+ 当远端发送双流时,可调用此方法来设置远端视频流的订阅选项。SDK 对远端视频流的默认订阅行为取决于注册的视频观测器类型:
+ - 如果注册的是 观测器,则默认订阅原始数据和编码后的数据。
+ - 如果注册的是 观测器,则默认仅订阅编码后的数据。
+ - 如果注册了两种观测器,则默认跟随后注册的视频观测器。举例来说,如果后注册的是 观测器,则默认订阅原始数据和编码后的数据。
+
+ 如果你想修改以上默认行为,或者想针对不同 uid 设置不同的订阅选项,可调用该方法设置。有关详细的实现步骤,详见。
+
参数
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_setvideoencoderconfiguration.dita b/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita
index 625ec4d64d2..8efd7fbf421 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/api_irtcengine_setvideoscenario.dita b/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita
index 5142f5585d6..d929855a308 100644
--- a/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita
+++ b/dita/RTC-NG/API/api_irtcengine_setvideoscenario.dita
@@ -77,7 +77,8 @@
- (2) 适用于视频 1v1 通话场景。针对该场景低延迟、高画质的体验要求,SDK 进行了策略调优,提升了画质、首帧出图、中低端机延迟及弱网流畅度等性能表现。
+ (2) 适用于场景。针对该场景低延迟、高画质的体验要求,SDK 进行了策略调优,提升了画质、首帧出图、中低端机延迟及弱网流畅度等性能表现。
+ (3) 适用于场景。针对该场景对首帧出图时间和画质清晰度的高要求,SDK 进行了策略调优,重点提升了首帧出图体验和画质表现,同时增强了在弱网环境和低端设备上的画质和流畅度表现。