diff --git a/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index 142aa1dcad9..5f40867b19b 100644 --- a/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -32,7 +32,7 @@
详情 -
+
弃用:
如果你需要推送 I422 格式的视频帧,请使用该方法。其他情况下,请改用
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_registervideoencodedframeobserver.dita b/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index 8f4452dbdef..ee15a38c8c5 100644 --- a/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -30,24 +30,10 @@

详情 -

如果你只想要观测编码后的视频帧 (如 h.264 格式),而不需要对视频进行解码和渲染,声网推荐你通过该方法注册一个 类。

-

如果你想获取一部分远端用户的原始视频数据 (简称为 A 组)、获取另一部分远端用户的编码后视频数据 (简称为 B 组),可参考以下步骤: - -

    -
  1. 在加入频道前调用 注册原始视频帧观测器。
  2. -
  3. 在加入频道前调用 注册编码后的视频帧观测器。
  4. -
  5. 加入频道后通过 获取 B 组用户的 ID,然后调用 设置该组用户的 encodedFrameOnly
  6. -
  7. 调用 (),开始接收所有远端用户的视频流。此时: - -
      -
    • 可通过 中的回调获取 A 组用户的原始视频数据,SDK 默认对该数据进行渲染。
    • -
    • 可通过 中的回调获取 B 组用户的已编码视频数据。
    • -
  8. -

+

如果你只想要观测编码后的视频帧 (如 H.264 格式),而不需要对视频进行解码和渲染,声网推荐你通过该方法注册一个 类。有关详细的实现步骤,详见

-
    -
  • 该方法需要在加入频道前调用。
  • -
+

该方法需要在加入频道前调用。

+
参数 diff --git a/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita b/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index d766b25831d..42b455816c3 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; @@ -26,11 +26,10 @@

如果你想要观测原始视频帧 (如 YUV 或 RGBA 格式),声网推荐你通过该方法注册一个 类。

调用该方法注册视频观测器时,你可以根据需要注册 类中的回调。在成功注册视频观测器后,SDK 会在捕捉到每个视频帧时,触发你所注册的上述回调。

-

适用场景 -

注册原始视频观测器后,你可以将获取到的原始视频数据应用于各种视频前处理场景,例如自行实现虚拟背景、美颜等场景。

+

注册原始视频观测器后,你可以将获取到的原始视频数据应用于各种视频前处理场景,例如自行实现虚拟背景、美颜等场景。有关详细的实现步骤,详见

声网在 GitHub 上提供了开源的示例项目 供你参考。

diff --git a/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita b/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita index 3dc14e20080..805162caae8 100644 --- a/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita +++ b/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita @@ -41,7 +41,8 @@

-

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

+

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

+

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

调用时机 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..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 @@

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

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

    -
      +
      • 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],每相邻两个值的音高距离相差半音。取值的绝对值越大,音调升高或降低得越多。 +
          <ph keyref="return-section-title"/> @@ -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 @@

    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_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 @@ <ph keyref="createMediaPlayer" /> - 创建媒体播放器对象。创建媒体播放器实例。 + 创建媒体播放器对象。创建媒体播放器实例。 @@ -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 @@ <ph keyref="initialize"/> - 创建并初始化 初始化 + 创建并初始化 初始化 @@ -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 @@

      调用限制 -

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

      +

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

      +

      无。

      详情 -
      +
      弃用:
      如果你需要推送 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 -

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

          +

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

          • (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 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 @@

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

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

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

            由于部分 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 @@ + + + + <ph keyref="setExternalRemoteEglContext"/> + 设置远端视频流渲染的 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 环境上下文对象。 + +
        +
        + <ph keyref="return-section-title"/> +

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

        +
          +
        • 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 参数,以获得预期的效果。
          • -

          - 声网推荐你按照以下步骤调用该方法: - -
            -
          1. 调用 加入频道时设置 autoSubscribeVideo
          2. -
          3. 在收到 回调后调用该方法,设置对指定远端用户视频流的订阅选项。
          4. -
          5. 调用 方法,开始恢复订阅指定远端用户的视频流。如果你在上一步中将 encodedFrameOnly 设置为 ,SDK 会在本地触发 回调,上报接收到的编码后视频帧信息。
          6. -
          +

          当远端发送双流时,可调用此方法来设置远端视频流的订阅选项。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 进行了策略调优,重点提升了首帧出图体验和画质表现,同时增强了在弱网环境和低端设备上的画质和流畅度表现。

        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_startaudiomixing2.dita b/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita index aae43b96e2f..80eefd803b8 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|IRtcEngine") diff --git a/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita b/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita index 76450a9476f..d940fcb420c 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; @@ -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_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_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 @@
        调用时机
          -
        • 如果你需要对本地采集的视频流进行合图,需要在 之后调用该方法。
        • +
        • 如果你需要对本地采集的视频流进行合图,需要在 之后调用该方法。
        • 如果你要将合图后的视频流发布到频道中,需要在调用 时,将 中的 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_startrtmpstreamwithouttranscoding.dita b/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita index c1790cb2470..8495e96674f 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|IRtcEngine") diff --git a/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita b/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita index 170b06ade4b..8db0c14cb14 100644 --- a/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita +++ b/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithtranscoding.dita @@ -54,7 +54,7 @@ transcoding -

    旁路推流的转码属性,详见 类。

    +

    旁路推流的转码属性,详见

    diff --git a/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index 7f82962ac54..087b600df70 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; @@ -31,7 +31,7 @@

    • 该方法仅适用于 Android 和 iOS 平台。
    • -
    • 屏幕共享流的计费标准以 中的 dimensions 值为准:
        +
      • 屏幕共享流的计费标准以 中的 dimensions 值为准:
        • 当你未传值时,以 1280 × 720 计费。
        • 当你传值时,以你传入的值计费。
      @@ -73,8 +73,8 @@ parameters screenCaptureParameters - captureParams - 屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080,即 2,073,600 像素。该像素值为计费标准。详见 + captureParams + 屏幕共享的编码参数配置。详见
    diff --git a/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita b/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita index 65df685d026..17b7cdb82bd 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|IRtcEngine") diff --git a/dita/RTC-NG/API/api_irtcengine_stopeffect.dita b/dita/RTC-NG/API/api_irtcengine_stopeffect.dita index 45ba586eb90..0e74806bcd4 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; @@ -28,11 +28,11 @@

    -

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

    +

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

    调用时机 -

    该方法需要在 之后调用。

    +

    该方法需要在 之后调用。

    该方法需要在 之后调用。

    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_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_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_irtcengine_updatescreencapture.dita b/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita index 793a52eb3df..597a2f20cf2 100644 --- a/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita +++ b/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita @@ -45,7 +45,7 @@ parameters captureParams - 屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080,即 2073600 像素。该像素值为计费标准。详见 + 屏幕共享的编码参数配置。详见
    diff --git a/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita b/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index 415aedb80da..2e6ca6d4a9e 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|IRtcEngine") @@ -45,7 +45,7 @@ screenCaptureParameters captureParams - 屏幕共享的编码参数配置。默认的分辨率为 1920 x 1080,即 2073600 像素。该像素值为计费标准。详见 。 + 屏幕共享的编码参数配置。详见 屏幕共享流的视频属性只需通过该参数设置,与 无关。 diff --git a/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita b/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita index bcd89fcccd4..1e39b022b3e 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_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_enableaudiovolumeindicationex.dita b/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita index 43a15ac7b43..cfbc90409db 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_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 133380648df..c82d5458061 100644 --- a/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita +++ b/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita @@ -36,13 +36,13 @@

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

    -

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

    -

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

    +

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

    +

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

    • 该方法是异步操作,调用返回时并没有真正退出频道。
    • -
    • 如果你调用了 ,会同时离开 加入的频道。
    • -
    • 如果你调用了 ,会同时离开 加入的频道。
    • +
    • 如果你调用了 后,会同时离开 加入的频道。
    • +
    • 如果你调用了 后,会同时离开 加入的频道。
    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/api_irtcengineex_muteremoteaudiostreamex.dita b/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita index 34ec61c2e83..7f5f824fbab 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 95da6c25c0e..124671d4d13 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 0acc2ec58cd..164d4075635 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|IRtcEngine") diff --git a/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 99533a72923..b6acd855140 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; @@ -53,7 +53,7 @@

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

    - 该方法和 的区别与联系如下: + 该方法和 的区别与联系如下:
    • 调用该方法并设置 mode 时,跟 () 的效果相同。
    • 调用该方法并设置 mode 时,跟 () 的效果相同。
    • diff --git a/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita b/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita index f9982c8dfd7..d0e57603fcf 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 9b1c2c6ec13..b7b999a66c4 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:)); @@ -49,7 +49,7 @@

        -
      • 如果发送端已调用 并将 mode 设置为 (始终不发送小流),则调用该方法不生效,你需要在发送端重新调用 修改设置。
      • +
      • 如果发送端已调用 并将 mode 设置为 (始终不发送小流),则调用该方法不生效,你需要在发送端重新调用 修改设置。
      • 观众角色的接收端调用该方法不生效。
      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/api_irtcengineex_startorupdatechannelmediarelayex.dita b/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index 1dce6a1938b..4635f2e0a6f 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|IRtcEngine") diff --git a/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita b/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita index 0108ead1738..4690318025a 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|IRtcEngine") diff --git a/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita b/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita index 87f4c2e16a7..2446559ce9f 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..3f90dbce3fe 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; @@ -43,8 +43,12 @@

      参数 - - userAudioSpectrumInfos + + data + 远端用户的音频频谱信息,详见 。数组数量等于 SDK 监测到的远端用户数量,数组为空表示没有监测到远端用户的音频频谱。 + + + userAudioSpectrumInfos AudioSpectrumInfo spectrums 远端用户的音频频谱信息,详见 。 数组数量等于 SDK 监测到的远端用户数量,数组为空表示没有监测到远端用户的音频频谱。 diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onaudiovolumeindication.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onaudiovolumeindication.dita index a29e605e485..7b0259a202e 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 4980466c30f..46c1f67bacd 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_onplaybufferupdated.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita index 8618ec6077d..8969ed7d737 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; @@ -36,8 +36,8 @@

        -
      • 当缓冲数据支持的播放时间小于阈值(默认为 0)时,返回
      • -
      • 当缓冲数据支持的播放时间大于阈值(默认为 0)时,返回
      • +
      • 当缓冲数据支持的播放时间小于阈值(默认为 0)时,返回 (6)。
      • +
      • 当缓冲数据支持的播放时间大于阈值(默认为 0)时,返回 (7)。

      diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayercachestats.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayercachestats.dita index 1ac3fbb5335..4ff35aadde5 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 58ba6a8de6a..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: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_onplayerinfoupdated.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerinfoupdated.dita index 09118a2d888..d225bdd59ed 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 f49315d3f87..eeac90e1f1f 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; @@ -42,7 +42,7 @@ 参数 - stats + stats info 媒体资源的相关信息,详见 diff --git a/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita index c94589e67c1..179d44b7fb7 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 885cf51b9f9..643ca80aeea 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 29b146f3fe7..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: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_imediaplayersourceobserver_onpreloadevent.dita b/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita index dc651eabae6..6e34f6b62ca 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 c4aae318625..c1d6d10919f 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 9378d1bde3e..3ae18402b0e 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?( @@ -51,8 +51,8 @@ reason -

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

      -

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

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

      +

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

      • (0):请求成功。
      • (1):一般错误,无明确归因。
      • @@ -73,7 +73,7 @@ list result - 当前可播放的音乐榜单列表。详见 + 当前可播放的音乐榜单列表。详见
      diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita index 88a06c76a2c..481f7f9148c 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?( @@ -40,7 +40,8 @@

      v4.1.0
      -

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

      +

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

      +

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

      参数 @@ -68,7 +69,7 @@ list result - 音乐资源列表的详细信息。详见 + 音乐资源列表的详细信息。详见
      diff --git a/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita b/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita index e022dcafdf2..eea1b955ced 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 c261d15f4f2..b655d79e83a 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_onaudioeffectfinished.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioeffectfinished.dita index c5affb1c340..1a448edea02 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_onaudiomixingstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita index b0d58d6518c..30ab27a5156 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) { @@ -43,8 +43,8 @@ reasonCode:(AgoraAudioMixingReasonCode)reasonCode; state - 音乐文件播放状态。详见 -

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

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

        + reason + 错误码。详见 +

        • (0): 正常。
        • (701): 音乐文件打开出错。
        • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita index dfccfee9d48..c320e50e5e7 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 @@ -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 2b94c0f200c..ae040d00967 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 @@ -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_oncameraexposureareachanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita index df211c53b97..f9148f1d621 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; @@ -61,9 +61,9 @@ - + rect - 镜头内表示曝光的区域。详见 + 镜头内表示曝光的区域。详见

      diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita index ea68c1cf8f9..13be6d58827 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; @@ -68,6 +68,17 @@ -

      + + + + point + 镜头内表示对焦的点。 + + + + + + +
      - \ No newline at end of file + diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita index dfeb9f96be1..0c80700184d 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; @@ -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_onclientrolechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita index 79c74cfbb74..470b4aea6b9 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita @@ -43,16 +43,17 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));

        触发时机 -

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

          +

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

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

          -

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

            +

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

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

        使用限制 -

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

        +

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

        +

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

        <ph keyref="callback-section-title"/> @@ -67,15 +68,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..41fe7647a8e 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita @@ -44,8 +44,8 @@
        触发时机 -

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

        -

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

        +

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

        +

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

        使用限制 @@ -78,8 +78,8 @@ currentRole - 当前用户角色。详见 - 当前用户角色。 + 当前用户角色。详见 + 当前用户角色。
        • (1): 主播。主播可以发流也可以收流。
        • (2): 观众。观众只能收流不能发流。
        • @@ -91,4 +91,4 @@
        - \ No newline at end of file + 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 cafbe77e94d..8ed5a00b668 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) { @@ -41,17 +41,17 @@ - + errorCode - err + err 错误码。详见 msg 错误描述。 - - err + + err error 错误码。 @@ -65,14 +65,14 @@

              • 初始化失败。请重新初始化
              • 调用方法时用户尚未加入频道。请检查方法的调用逻辑。
              • -
              • 调用 方法时用户尚未离开频道。请检查方法的调用逻辑。
              • +
              • 调用 方法时用户尚未离开频道。请检查方法的调用逻辑。
              • 请检查是否已开启音频模块。请检查程序集完整性。
            • (4): 当前状态不支持该操作。可能的原因有:
                -
              • Android 平台调用 方法时,如果设备版本低于 Android 5.0,会上报该错误码。请确认 Android 设备版本。
              • +
              • Android 平台调用 方法时,如果设备版本低于 Android 5.0,会上报该错误码。请确认 Android 设备版本。
              • 使用内置加密时,设置的加密模式不正确,或加载外部加密库失败。请检查加密的枚举值是否正确,或重新加载外部加密库。
            • (5):方法调用被拒绝。可能的原因有: @@ -93,7 +93,7 @@
              • 用户已经在频道中。建议通过 回调判断用户是否在频道中。除收到 (1) 状态外,不要再次调用该方法加入频道。
              • -
              • 用户在调用 进行通话测试后,未调用 结束当前测试就尝试加入频道。开始通话测试后,需要先调用 结束当前测试,再加入频道。
              • +
              • 用户在调用 进行通话测试后,未调用 结束当前测试就尝试加入频道。开始通话测试后,需要先调用 结束当前测试,再加入频道。
            • (18):离开频道失败。可能的原因有: @@ -125,7 +125,7 @@
            • 在控制台中启用了 App 证书,但未使用 App ID + Token 鉴权。当项目启用了 App 证书,就必须使用 Token 鉴权。
            • 生成 Token 时填入的 uid 字段,和用户加入频道时填入的 uid 不匹配。
            -
            +
            弃用:
            该枚举已废弃。请改用 回调中的 (8)。
            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_onfirstlocalvideoframe.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita index 326a6ef5561..380adf0ca4a 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 @@ -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 7d9270062e4..526aa3d3904 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) { @@ -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_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_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 b3312d0c314..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_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_onlocalvideostatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita index 80303ddd223..e74a6924fdf 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) { @@ -71,14 +71,14 @@ sourceType - source + source 视频源的类型。详见 state -

                本地视频状态,详见

                -

                +

                本地视频状态,详见

                +

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

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

                  -

                  +

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

                  +

                  • (0): 本地视频状态正常。
                  • (1): 出错原因不明确。
                  • @@ -101,7 +101,7 @@
                  • (8):找不到本地视频采集设备。需检查摄像头是否与设备正常连接、摄像头是否正常工作,或者尝试重新加入频道。
                  • (14):视频采集中断。可能的原因是:
                    • 摄像头被其他 App 占用。请提示用户检查摄像头是否被其他 App 占用。
                    • -
                    • 当前 App 已被切换到后台。可以使用前台服务通知操作系统,确保 App 在切换到后台时仍可采集视频。详见
                    • +
                    • 设备已锁屏,或当前 App 已被切换到后台。可以使用前台服务通知操作系统,确保 App 在切换到后台时仍可采集视频。详见
                  • (15):视频采集设备出错。请提示用户关闭并重新启动摄像头以恢复功能,如果该操作不能解决问题,请检查摄像头是否出现硬件故障。

                  diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita index f5725426456..232ef5cd0dd 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){ @@ -55,10 +55,10 @@ 合图失败的视频流。详见 - error + error errorCode - 本地合图出错原因。详见 - 本地合图出错原因: + 本地合图出错原因。详见 + 本地合图出错原因:

                  • 1:指定的视频源未开始进行视频采集,你需要为其创建视频轨道并开始视频采集。
                  • 2:视频源类型无效,你需要重新指定支持的视频源类型。
                  • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita index 9c5fe53db17..154c3fa3ed4 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_onrejoinchannelsuccess.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita index 49acf37b7db..0f23329be95 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_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_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_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_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 f4ff5861295..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:)); @@ -59,8 +59,8 @@ state - 当前的推流状态,详见 - 当前的推流状态: + 当前的推流状态,详见 + 当前的推流状态: @@ -82,8 +82,8 @@ reason - 推流状态改变的原因,详见 - 推流状态改变的原因。 + 推流状态改变的原因,详见 + 推流状态改变的原因。

                  • (0):推流成功。
                  • (1):参数无效。请检查输入参数是否正确。
                  • @@ -97,7 +97,7 @@
                  • (9):服务器未找到这个流。
                  • (10):推流地址格式有错误。请检查推流地址格式是否正确。
                  • (11):用户角色不是主播,该用户无法使用推流功能。请检查你的应用代码逻辑。
                  • -
                  • (13):非转码推流情况下,调用了 方法更新转码属性。请检查你的应用代码逻辑。
                  • +
                  • (13):非转码推流情况下,调用了 更新转码属性。请检查你的应用代码逻辑。
                  • (14):主播的网络出错。
                  • (16):你的项目没有使用声网推流服务的权限。请参考旁路推流中的前提条件开启推流服务。
                  • (100):推流已正常结束。当你调用 结束推流后,SDK 会返回该值。
                  • diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita index e7a7f8dd295..c9e6f7002a0 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita @@ -28,16 +28,23 @@ } UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event") void OnStreamMessage(int64 uid, int streamId, const FString& data, int length, int64 sentTs); - onStreamMessage?(connection: RtcConnection, remoteUid: number, streamId: number, data: Uint8Array, length: number, sentTs: number): void; - public virtual void OnStreamMessage(RtcConnection connection, uint remoteUid, int streamId, byte[] data, uint length, UInt64 sentTs) { } + onStreamMessage?( + connection: RtcConnection, + remoteUid: number, + streamId: number, + data: Uint8Array, + length: number, + sentTs: number + ): void; + public virtual void OnStreamMessage(RtcConnection connection, uint remoteUid, int streamId, byte[] data, ulong length, ulong sentTs) { } onStreamMessage?( - connection: RtcConnection, - remoteUid: number, - streamId: number, - data: Uint8Array, - length: number, - sentTs: number -): void; + connection: RtcConnection, + remoteUid: number, + streamId: number, + data: Uint8Array, + length: number, + sentTs: number + ): void; final void Function(RtcConnection connection, int remoteUid, int streamId, Uint8List data, int length, int sentTs)? onStreamMessage;

                    @@ -59,7 +66,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/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita index e055741497d..846a9cbec50 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_onuserenablevideo.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita index 2b519da845b..2fff2c190bb 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 @@ -80,4 +80,4 @@

                    - \ No newline at end of file + diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita index 15c70f26069..7770008dc36 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 182d53fdbd6..62da9411664 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_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/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita index 3218ede8a69..9e3d1226948 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 @@ -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/callback_ivideoframeobserver_getmirrorapplied.dita b/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita index 39e22c4a128..8633fa1804c 100644 --- a/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita +++ b/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita @@ -27,7 +27,10 @@

                    如果你希望获取的视频数据为原始视频的镜像,需要在调用 方法时注册该回调。成功注册视频数据观测器后,SDK 会在捕捉到每个视频帧时触发该回调,你需要在该回调的返回值中设置是否对原始视频数据作镜像处理。

                      -
                    • 该功能仅支持 RGBA 和 YUV420 格式的视频数据。
                    • +
                    • 在 Android 平台上,该回调支持的视频数据格式有:I420、RGBA 和 Texture。
                    • +
                    • 在 Windows 平台上,该回调支持的视频数据格式有:I420、RGBA 和 TextureBuffer。
                    • +
                    • 在 iOS 平台上,该回调支持的视频数据格式有:I420、RGBA 和 CVPixelBuffer。
                    • +
                    • 在 macOS 平台上,该回调支持的视频数据格式有:I420 和 RGBA。
                    • 该方法和 方法均支持设置镜像效果,声网建议你仅选择一种方法进行设置,同时使用两种方法会导致镜像效果叠加从而造成设置镜像失败。
                    diff --git a/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita b/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita index a2577ee8a64..2c0e6483b57 100644 --- a/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita +++ b/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita @@ -28,8 +28,10 @@

                    如果你在采集端已经根据 中的旋转信息 rotation 进行旋转,就无需调用该方法设置视频数据旋转。

                      -
                    • 该功能仅支持视频处理模式为 的场景。
                    • -
                    • 该功能仅支持 RGBA 和 YUV420 格式的视频数据。
                    • +
                    • 在 Android 平台上,该回调支持的视频数据格式有:I420、RGBA 和 Texture。
                    • +
                    • 在 Windows 平台上,该回调支持的视频数据格式有:I420、RGBA 和 TextureBuffer。
                    • +
                    • 在 iOS 平台上,该回调支持的视频数据格式有:I420、RGBA 和 CVPixelBuffer。
                    • +
                    • 在 macOS 平台上,该回调支持的视频数据格式有:I420 和 RGBA。
                    diff --git a/dita/RTC-NG/API/class_advanceoptions.dita b/dita/RTC-NG/API/class_advanceoptions.dita index 55bd1d271d5..4e4431f639d 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_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 126297193f2..021420a3e66 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; @@ -69,7 +72,7 @@ struct FAudioSpectrumData {

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

                    - + dataLength 音频频谱数据长度为 256。 diff --git a/dita/RTC-NG/API/class_audiotrackconfig.dita b/dita/RTC-NG/API/class_audiotrackconfig.dita index 95e46f8b937..7c425f5025d 100644 --- a/dita/RTC-NG/API/class_audiotrackconfig.dita +++ b/dita/RTC-NG/API/class_audiotrackconfig.dita @@ -7,27 +7,35 @@

                    public class AudioTrackConfig { + public boolean enableLocalPlayback; - - + + public boolean enableAudioProcessing; public AudioTrackConfig() { this.enableLocalPlayback = true; + this.enableAudioProcessing = false; + } + @Override + public String toString() { + return "AudioTrackConfig{" + + "enableLocalPlayback=" + enableLocalPlayback + "enableAudioProcessing" + + enableAudioProcessing + '}'; } - } +} export class AudioTrackConfig { public enableLocalPlayback: boolean = true; } - NS_SWIFT_NAME(AgoraAudioTrackConfig) __attribute__((visibility("default"))) @interface AgoraAudioTrackConfig : NSObject + NS_SWIFT_NAME(AgoraAudioTrackConfig) __attribute__((visibility("default"))) @interface AgoraAudioTrackConfig : NSObject @property (assign, nonatomic) BOOL enableLocalPlayback NS_SWIFT_NAME(enableLocalPlayback); - +@property (assign, nonatomic) BOOL enableAudioProcessing NS_SWIFT_NAME(enableAudioProcessing); @end struct AudioTrackConfig { + bool enableLocalPlayback; - - - AudioTrackConfig() - : enableLocalPlayback(true) {} + + bool enableAudioProcessing; + AudioTrackConfig() : enableLocalPlayback(true),enableAudioProcessing(false) {} }; USTRUCT(BlueprintType) struct FAudioTrackConfig @@ -84,6 +92,16 @@ class AudioTrackConfig {

                  + + enableAudioProcessing + 是否启用音频处理模块: +
                    +
                  • :启用音频处理模块,应用回声消除 (AEC)、降噪 (ANS) 和自动增益控制 (AGC) 效果。
                  • +
                  • :(默认)不启用音频处理模块。
                  • +
                  + 该参数设置仅对 类型的自定义音频采集轨道生效。 +
                  +
                  \ No newline at end of file diff --git a/dita/RTC-NG/API/class_cachestatistics.dita b/dita/RTC-NG/API/class_cachestatistics.dita index b4ac722879e..0102092600c 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_cameracapturerconfiguration.dita b/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index 62176f2f978..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 平台。 @@ -393,7 +393,7 @@ class CameraCapturerConfiguration { followEncodeDimensionRatio (可选)是否跟随 中设置的视频宽高比:
                    -
                  • :(默认) 跟随。SDK 会将采集到的视频按照已设置的视频宽高比进行裁剪,会同步改变本地预览画面、 中的视频画面
                  • +
                  • :(默认) 跟随。SDK 会将采集到的视频按照已设置的视频宽高比进行裁剪,会同步改变本地预览画面、 中的视频画面
                  • :不跟随。SDK不改变采集到的视频帧宽高比。
                  diff --git a/dita/RTC-NG/API/class_channelmediaoptions.dita b/dita/RTC-NG/API/class_channelmediaoptions.dita index f7220a95bd2..0dbd0941081 100644 --- a/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -84,6 +84,8 @@ public audioDelayMs?:number; public mediaPlayerAudioDelayMs?:number; + + public token?:string; public enableBuiltInMediaEncryption?:boolean; @@ -731,67 +733,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 enableBuiltInMediaEncryption?:boolean; - - public publishRhythmPlayerTrack?:boolean; - - public isInteractiveAudience?:boolean; - - public customVideoTrackId?:number; - - public isAudioFilterable?:boolean; - - public startPreview?:boolean; - public constructor() { - } - } + + 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() { + } +} __attribute__((visibility("default"))) @interface AgoraRtcChannelMediaOptions : NSObject @property(assign, nonatomic) BOOL publishCameraTrack; @property(assign, nonatomic) BOOL publishSecondaryCameraTrack; @@ -1501,7 +1503,7 @@ public: 该参数仅适用于 Windows 和 macOS 平台。 - + publishScreenCaptureVideo

                  设置是否发布屏幕采集的视频: @@ -1512,7 +1514,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_climaxsegment.dita b/dita/RTC-NG/API/class_climaxsegment.dita index 08a52e953d7..3ca0be03bb4 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 b1a9634ab28..9b697c79f8f 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; @@ -159,7 +169,7 @@ class ContentInspectConfig {
                    参数 - + CONTENT_INSPECT_TYPE_INVALID 0:(默认)无实际功能。请不要将 type 设为该值。 @@ -167,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 f1adda91da4..a79c6ff18fd 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; @@ -91,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_externalvideoframe.dita b/dita/RTC-NG/API/class_externalvideoframe.dita index 505c28c9634..53d5a2e5209 100644 --- a/dita/RTC-NG/API/class_externalvideoframe.dita +++ b/dita/RTC-NG/API/class_externalvideoframe.dita @@ -7,20 +7,32 @@

                        public class AgoraVideoFrame { + public static final int FORMAT_NONE = -1; + public static final int FORMAT_TEXTURE_2D = 10; + public static final int FORMAT_TEXTURE_OES = 11; + public static final int FORMAT_I420 = 1; + public static final int FORMAT_BGRA = 2; + public static final int FORMAT_NV21 = 3; + public static final int FORMAT_RGBA = 4; + public static final int FORMAT_I422 = 16; + public static final int BUFFER_TYPE_NONE = -1; + public static final int BUFFER_TYPE_BUFFER = 1; + public static final int BUFFER_TYPE_ARRAY = 2; + public static final int BUFFER_TYPE_TEXTURE = 3; public AgoraVideoFrame() { - format = 10; + format = 10; timeStamp = 0; stride = 0; height = 0; @@ -37,53 +49,78 @@ rotation = 0; alphaStitchMode = 0; } + public int format; + public long timeStamp; + public int stride; + public int height; + public int textureID; + public boolean syncMode; + public float[] transform; + public javax.microedition.khronos.egl.EGLContext eglContext10; - public android.opengl.EGLContext eglContext14; + public android.opengl.EGLContext eglContext14; + public byte[] buf; + public int cropLeft; + public int cropTop; + public int cropRight; + public int cropBottom; + public int rotation; + public int alphaStitchMode; @Override public String toString() { - return "AgoraVideoFrame{" - + "format=" + format + ", timeStamp=" + timeStamp + ", stride=" + stride - + ", height=" + height + ", textureID=" + textureID - + ", buf.length=" + (buf != null ? buf.length : 0) + ", cropLeft=" + cropLeft - + ", cropTop=" + cropTop + ", cropRight=" + cropRight + ", cropBottom=" + cropBottom - + ", rotation=" + rotation + ", alphaStitchMode=" + alphaStitchMode + '}'; + return "AgoraVideoFrame{" + + "format=" + format + ", timeStamp=" + timeStamp + ", stride=" + stride + + ", height=" + height + ", textureID=" + textureID + + ", buf.length=" + (buf != null ? buf.length : 0) + ", cropLeft=" + cropLeft + + ", cropTop=" + cropTop + ", cropRight=" + cropRight + ", cropBottom=" + cropBottom + + ", rotation=" + rotation + ", alphaStitchMode=" + alphaStitchMode + '}'; } + } - __attribute__((visibility("default"))) @interface AgoraVideoFrame : NSObject + +__attribute__((visibility("default"))) @interface AgoraVideoFrame : NSObject @property(assign, nonatomic) NSInteger format; -@property(assign, nonatomic) CMTime time; -@property(assign, nonatomic) int stride DEPRECATED_MSG_ATTRIBUTE("use strideInPixels instead"); -@property(assign, nonatomic) int strideInPixels; -@property(assign, nonatomic) int height; + +@property(assign, nonatomic) CMTime time; +@property(assign, nonatomic) int stride DEPRECATED_MSG_ATTRIBUTE("use strideInPixels instead"); + +@property(assign, nonatomic) int strideInPixels; +@property(assign, nonatomic) int height; @property(assign, nonatomic) CVPixelBufferRef _Nullable textureBuf; + @property(strong, nonatomic) IMAGE_CLASS * _Nullable image; -@property(strong, nonatomic) NSData *_Nullable dataBuf; + +@property(strong, nonatomic) NSData *_Nullable dataBuf; @property(strong, nonatomic) NSData *_Nullable alphaBuf; @property(assign, nonatomic) AgoraAlphaStitchMode alphaStitchMode; -@property(assign, nonatomic) int cropLeft; -@property(assign, nonatomic) int cropTop; -@property(assign, nonatomic) int cropRight; -@property(assign, nonatomic) int cropBottom; -@property(assign, nonatomic) int rotation; + +@property(assign, nonatomic) int cropLeft; +@property(assign, nonatomic) int cropTop; +@property(assign, nonatomic) int cropRight; +@property(assign, nonatomic) int cropBottom; +@property(assign, nonatomic) int rotation; +@property(strong, nonatomic) AgoraColorSpace *_Nullable colorSpace; + - (void)fillAlphaData; @end - struct ExternalVideoFrame { + +struct ExternalVideoFrame { ExternalVideoFrame() : type(VIDEO_BUFFER_RAW_DATA), format(VIDEO_PIXEL_DEFAULT), @@ -99,44 +136,78 @@ eglContext(NULL), eglType(EGL_CONTEXT10), textureId(0), + fenceObject(0), metadataBuffer(NULL), metadataSize(0), alphaBuffer(NULL), fillAlphaBuffer(false), - alphaStitchMode(0), + alphaStitchMode(NO_ALPHA_STITCH), d3d11Texture2d(NULL), textureSliceIndex(0){} + enum EGL_CONTEXT_TYPE { + EGL_CONTEXT10 = 0, + EGL_CONTEXT14 = 1, }; + enum VIDEO_BUFFER_TYPE { + VIDEO_BUFFER_RAW_DATA = 1, + VIDEO_BUFFER_ARRAY = 2, + VIDEO_BUFFER_TEXTURE = 3, }; + VIDEO_BUFFER_TYPE type; + VIDEO_PIXEL_FORMAT format; + void* buffer; + int stride; + int height; + int cropLeft; + int cropTop; + int cropRight; + int cropBottom; + int rotation; + long long timestamp; - void *eglContext; + + void* eglContext; + EGL_CONTEXT_TYPE eglType; + int textureId; + + long long fenceObject; + float matrix[16]; + uint8_t* metadataBuffer; + int metadataSize; + uint8_t* alphaBuffer; + bool fillAlphaBuffer; - int alphaStitchMode; + + ALPHA_STITCH_MODE alphaStitchMode; + void *d3d11Texture2d; + int textureSliceIndex; + + ColorSpace colorSpace; }; export class ExternalVideoFrame { type?: VideoBufferType; @@ -403,8 +474,8 @@ class ExternalVideoFrame { Texture 帧额外的转换。该参数仅适用于 Texture 格式的视频数据。 - eglContext11 - EGLContext11。该参数仅适用于 Texture 格式的视频数据。 + eglContext10 + EGLContext10。该参数仅适用于 Texture 格式的视频数据。 eglContext14 @@ -414,8 +485,8 @@ class ExternalVideoFrame { eglContext 该参数仅适用于 Texture 格式的视频数据。

                          -
                        • 当使用 Khronos 定义的 OpenGL 接口 (javax.microedition.khronos.egl.*)时,需要将 eglContext 设置给这个字段。
                        • -
                        • 当使用 Android 定义的 OpenGL 接口 (android.opengl.*)时,需要将 eglContext 设置给这个字段。
                        • +
                        • 当使用 Khronos 定义的 OpenGL 接口 (javax.microedition.khronos.egl.*) 时,需要将 eglContext 设置给这个字段。
                        • +
                        • 当使用 Android 定义的 OpenGL 接口 (android.opengl.*) 时,需要将 eglContext 设置给这个字段。
                        @@ -506,6 +577,10 @@ class ExternalVideoFrame { time 传入的视频帧的时间戳,以毫秒为单位。不正确的时间戳会导致丢帧或者音视频不同步。 + + + +
                        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 23656fc95ac..25786510791 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; @@ -120,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 3f74daf6ecd..4ef17912603 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; @@ -194,7 +212,7 @@ public: url

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

                      - +

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

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

                      diff --git a/dita/RTC-NG/API/class_music.dita b/dita/RTC-NG/API/class_music.dita index 22f4156aadc..3e447a36a68 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 befb62f0778..7aef845148b 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 f3b7ed1a10f..e426d55648e 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 7629d765d9e..3fbc4c0aeed 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 = 10 + + 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 65ebef71d59..162502b875b 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 1f29b4789c2..b8e9c8ccd19 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 b7d42ff35e2..e90e563370d 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_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_remoteaudiostats.dita b/dita/RTC-NG/API/class_remoteaudiostats.dita index 20f04519889..b2f8bf2c5bc 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; @@ -431,6 +433,7 @@ class RemoteAudioStats {
                  • (4):勉强能沟通但不顺畅。
                  • (5):网络质量非常差,基本不能沟通。
                  • (6):网络连接断开,完全无法沟通。
                  • +
                  • (8):网络质量检测进行中。

                  diff --git a/dita/RTC-NG/API/class_rtcengineconfig.dita b/dita/RTC-NG/API/class_rtcengineconfig.dita index 896b7f18d3b..341c2fdefc7 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 @@ -244,7 +245,7 @@ class RtcEngineContext {

                  上下文。

                  - + mNativeLibPath

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

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

            - + mAutoRegisterAgoraExtensions autoRegisterAgoraExtensions @@ -320,7 +321,7 @@ class RtcEngineContext {
        -
        +
        方法 diff --git a/dita/RTC-NG/API/class_rtcimage.dita b/dita/RTC-NG/API/class_rtcimage.dita index f59403ca47a..fb03befc63b 100644 --- a/dita/RTC-NG/API/class_rtcimage.dita +++ b/dita/RTC-NG/API/class_rtcimage.dita @@ -109,7 +109,7 @@ struct FRtcImage char* URLCharPtr = new char[url.Len() + 1]; FMemory::Memcpy(URLCharPtr, TCHAR_TO_UTF8(*url), url.Len()); - URLCharPtr[url.Len()] = '\0'; + URLCharPtr[url.Len()] = '\0'; AgoraData.url = URLCharPtr; AgoraData.x = x; AgoraData.y = y; @@ -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_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/class_segmentationproperty.dita b/dita/RTC-NG/API/class_segmentationproperty.dita index 35bc7c84699..4bfc8967518 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_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/API/class_srcinfo.dita b/dita/RTC-NG/API/class_srcinfo.dita index 5ac92c431c6..a894159f1c8 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_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 626674e9f34..8ac957f7c5f 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; } @@ -286,7 +287,7 @@ class VideoCanvas { 当视频源为合图视频流 () 时,该参数表示发布合图视频流的用户 ID。 - + subviewUid 发布某一路合图子视频流的用户 ID。 预留参数。 @@ -334,7 +335,7 @@ class VideoCanvas { sourceType 视频源的类型,详见 - + setupMode 视图设置模式。详见 视图设置模式: @@ -349,7 +350,7 @@ class VideoCanvas { 媒体播放器 ID。可通过 获取。 sourceType 时,此参数为必填项。 - + rect (可选)视频帧的展示区域。详见 。其中,widthheight 表示该区域的视频像素宽度和高度。默认值为空值 (宽或高为 0),表示展示实际分辨率的视频帧。 @@ -361,11 +362,11 @@ class VideoCanvas { cropArea (可选)视频帧的展示区域,详见 。其中,widthheight 表示该区域的视频像素宽度和高度。默认值为空值 (宽或高为 0),表示展示实际分辨率的视频帧。 - + backgroundColor 视频画布的背景颜色,格式为 RGBA。默认值为 0x00000000,代表完全透明的黑色。 - + enableAlphaMask (可选)是否开启 Alpha 遮罩渲染:
      @@ -381,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..7650c9353f4 100644 --- a/dita/RTC-NG/API/class_videoframe.dita +++ b/dita/RTC-NG/API/class_videoframe.dita @@ -7,42 +7,61 @@

        public class VideoFrame implements RefCounted { + public interface Buffer extends RefCounted { - @CalledByNative("Buffer") int getWidth(); - @CalledByNative("Buffer") int getHeight(); - @CalledByNative("Buffer") I420Buffer toI420(); - @Override @CalledByNative("Buffer") void release(); - @Override @CalledByNative("Buffer") void retain(); - @CalledByNative("Buffer") + + @CalledByNative("Buffer") int getWidth(); + + @CalledByNative("Buffer") int getHeight(); + + @CalledByNative("Buffer") I420Buffer toI420(); + + @Override @CalledByNative("Buffer") void release(); + + @Override @CalledByNative("Buffer") void retain(); + + @CalledByNative("Buffer") Buffer cropAndScale( int cropX, int cropY, int cropWidth, int cropHeight, int scaleWidth, int scaleHeight); - @CalledByNative("Buffer") @Nullable Buffer mirror(int frameRotation); - @CalledByNative("Buffer") @Nullable Buffer rotate(int frameRotation); - @CalledByNative("Buffer") + + @CalledByNative("Buffer") @Nullable Buffer mirror(int frameRotation); + + @CalledByNative("Buffer") @Nullable Buffer rotate(int frameRotation); + + @CalledByNative("Buffer") @Nullable Buffer transform(int cropX, int cropY, int cropWidth, int cropHeight, int scaleWidth, int scaleHeight, int frameRotation); } + public interface I420Buffer extends Buffer { - @CalledByNative("I420Buffer") ByteBuffer getDataY(); - @CalledByNative("I420Buffer") ByteBuffer getDataU(); - @CalledByNative("I420Buffer") ByteBuffer getDataV(); - @CalledByNative("I420Buffer") int getStrideY(); - @CalledByNative("I420Buffer") int getStrideU(); - @CalledByNative("I420Buffer") int getStrideV(); + + @CalledByNative("I420Buffer") ByteBuffer getDataY(); + + @CalledByNative("I420Buffer") ByteBuffer getDataU(); + + @CalledByNative("I420Buffer") ByteBuffer getDataV(); + @CalledByNative("I420Buffer") int getStrideY(); + @CalledByNative("I420Buffer") int getStrideU(); + @CalledByNative("I420Buffer") int getStrideV(); } + public interface I422Buffer extends Buffer { - @CalledByNative("I422Buffer") ByteBuffer getDataY(); - @CalledByNative("I422Buffer") ByteBuffer getDataU(); - @CalledByNative("I422Buffer") ByteBuffer getDataV(); - @CalledByNative("I422Buffer") int getStrideY(); - @CalledByNative("I422Buffer") int getStrideU(); - @CalledByNative("I422Buffer") int getStrideV(); - } - public interface RgbaBuffer extends Buffer { @CalledByNative("RgbaBuffer") ByteBuffer getData(); } + @CalledByNative("I422Buffer") ByteBuffer getDataY(); + @CalledByNative("I422Buffer") ByteBuffer getDataU(); + @CalledByNative("I422Buffer") ByteBuffer getDataV(); + @CalledByNative("I422Buffer") int getStrideY(); + @CalledByNative("I422Buffer") int getStrideU(); + @CalledByNative("I422Buffer") int getStrideV(); + } + public interface RgbaBuffer extends Buffer { @CalledByNative("RgbaBuffer") ByteBuffer getData(); } + public interface TextureBuffer extends Buffer { + enum Type { + OES(GLES11Ext.GL_TEXTURE_EXTERNAL_OES), + RGB(GLES20.GL_TEXTURE_2D); private final int glTarget; private Type(final int glTarget) { @@ -57,22 +76,26 @@ EGL_CONTEXT_14; } Type getType(); - @CalledByNative("TextureBuffer") int getTextureId(); + + @CalledByNative("TextureBuffer") int getTextureId(); + Matrix getTransformMatrix(); - @CalledByNative("TextureBuffer") EglBase.Context getEglBaseContext(); - @CalledByNative("TextureBuffer") Object getSourceTexturePool(); - @CalledByNative("TextureBuffer") long getNativeEglContext(); - @CalledByNative("TextureBuffer") int getEglContextType(); - @CalledByNative("TextureBuffer") float[] getTransformMatrixArray(); - @CalledByNative("TextureBuffer") int getSequence(); - @CalledByNative("TextureBuffer") boolean is10BitTexture(); + + @CalledByNative("TextureBuffer") EglBase.Context getEglBaseContext(); + @CalledByNative("TextureBuffer") Object getSourceTexturePool(); + @CalledByNative("TextureBuffer") long getNativeEglContext(); + @CalledByNative("TextureBuffer") int getEglContextType(); + @CalledByNative("TextureBuffer") float[] getTransformMatrixArray(); + + @CalledByNative("TextureBuffer") int getSequence(); + @CalledByNative("TextureBuffer") long getFenceObject(); + @CalledByNative("TextureBuffer") boolean is10BitTexture(); } public interface ColorSpace { enum Range { Invalid(0), Limited(1), - Full(2), - Derived(3); + Full(2); private final int range; private Range(int range) { this.range = range; @@ -161,32 +184,55 @@ kBackCamera, kUnspecified, } + public enum AlphaStitchMode { + ALPHA_NO_STITCH(0), + ALPHA_STITCH_UP(1), + ALPHA_STITCH_BELOW(2), + ALPHA_STITCH_LEFT(3), + ALPHA_STITCH_RIGHT(4); + private final int stitchMode; + private AlphaStitchMode(int stitchMode) { + this.stitchMode = stitchMode; + } + public int value() { + return stitchMode; + } + } + private Buffer buffer; + private int rotation; + private long timestampNs; private ColorSpace colorSpace; private SourceType sourceType; private float sampleAspectRatio; + + private AlphaStitchMode alphaStitchMode = AlphaStitchMode.ALPHA_NO_STITCH; private VideoFrameMetaInfo metaInfo = new VideoFrameMetaInfo(); + private @Nullable ByteBuffer alphaBuffer; - private int alphaStitchMode; + private long nativeAlphaBuffer; + public VideoFrame(Buffer buffer, int rotation, long timestampNs) { - this(buffer, rotation, timestampNs, new WrappedNativeColorSpace(), null, 0L, 1.0f, SourceType.kUnspecified.ordinal()); + this(buffer, rotation, timestampNs, new WrappedNativeColorSpace(), null, 0L, 1.0f, + SourceType.kUnspecified.ordinal()); } @CalledByNative public VideoFrame(Buffer buffer, int rotation, long timestampNs, ColorSpace colorSpace, - ByteBuffer alphaBuffer, float sampleAspectRatio, int sourceType) { + ByteBuffer alphaBuffer, long nativeAlphaBuffer, float sampleAspectRatio, int sourceType) { if (buffer == null) { - throw new IllegalArgumentException("buffer not allowed to be null"); + throw new IllegalArgumentException("buffer not allowed to be null"); } if (rotation % 90 != 0) { - throw new IllegalArgumentException("rotation must be a multiple of 90"); + throw new IllegalArgumentException("rotation must be a multiple of 90"); } this.buffer = buffer; this.rotation = rotation; this.timestampNs = timestampNs; this.colorSpace = colorSpace; this.alphaBuffer = alphaBuffer; + this.nativeAlphaBuffer = nativeAlphaBuffer; this.sampleAspectRatio = sampleAspectRatio; this.sourceType = SourceType.values()[sourceType]; } @@ -197,18 +243,25 @@ public float getSampleAspectRatio() { return sampleAspectRatio; } + @CalledByNative public Buffer getBuffer() { return buffer; } + @CalledByNative public int getRotation() { return rotation; } @CalledByNative public int getAlphaStitchMode() { - return alphaStitchMode; + return alphaStitchMode.value(); + } + @CalledByNative + public void setAlphaStitchMode(int stitchMode) { + alphaStitchMode = AlphaStitchMode.values()[stitchMode]; } + @CalledByNative public long getTimestampNs() { return timestampNs; @@ -217,41 +270,93 @@ public VideoFrameMetaInfo getMetaInfo() { return metaInfo; } + public int getRotatedWidth() { if (rotation % 180 == 0) { - return buffer.getWidth(); + return (alphaStitchMode == AlphaStitchMode.ALPHA_STITCH_LEFT + || alphaStitchMode == AlphaStitchMode.ALPHA_STITCH_RIGHT) + ? buffer.getWidth() / 2 + : buffer.getWidth(); } - return buffer.getHeight(); + return (alphaStitchMode == AlphaStitchMode.ALPHA_STITCH_UP + || alphaStitchMode == AlphaStitchMode.ALPHA_STITCH_BELOW) + ? buffer.getHeight() / 2 + : buffer.getHeight(); } + public int getRotatedHeight() { if (rotation % 180 == 0) { - return buffer.getHeight(); + return (alphaStitchMode == AlphaStitchMode.ALPHA_STITCH_UP + || alphaStitchMode == AlphaStitchMode.ALPHA_STITCH_BELOW) + ? buffer.getHeight() / 2 + : buffer.getHeight(); } - return buffer.getWidth(); + return (alphaStitchMode == AlphaStitchMode.ALPHA_STITCH_LEFT + || alphaStitchMode == AlphaStitchMode.ALPHA_STITCH_RIGHT) + ? buffer.getWidth() / 2 + : buffer.getWidth(); } + public void replaceBuffer(Buffer buffer, int rotation, long timestampNs) { release(); this.buffer = buffer; this.rotation = rotation; this.timestampNs = timestampNs; } + @CalledByNative public ColorSpace getColorSpace() { return colorSpace; } + public void setColorSpace(ColorSpace colorSpace) { + this.colorSpace = colorSpace; + } + @CalledByNative + private int getColorSpaceRange() { + if (colorSpace == null) { + return ColorSpace.Range.Invalid.getRange(); + } + return colorSpace.getRange().getRange(); + } + @CalledByNative + private int getColorSpaceMatrix() { + if (colorSpace == null) { + return ColorSpace.Matrix.Unspecified.getMatrix(); + } + return colorSpace.getMatrix().getMatrix(); + } + @CalledByNative + private int getColorSpaceTransfer() { + if (colorSpace == null) { + return ColorSpace.Transfer.Unspecified.getTransfer(); + } + return colorSpace.getTransfer().getTransfer(); + } + @CalledByNative + private int getColorSpacePrimary() { + if (colorSpace == null) { + return ColorSpace.Primary.Unspecified.getPrimary(); + } + return colorSpace.getPrimary().getPrimary(); + } @CalledByNative public ByteBuffer getAlphaBuffer() { return alphaBuffer; } + public void retainAlphaBuffer() { + JniCommon.nativeAddRef(nativeAlphaBuffer); + } + public void releaseAlphaBuffer() { + JniCommon.nativeReleaseRef(nativeAlphaBuffer); + } public void fillAlphaData(ByteBuffer buffer) { alphaBuffer = buffer; } - public void setAlphaStitchMode(int mode) { - this.alphaStitchMode = mode; - } + @Override public void retain() { buffer.retain(); } + @Override @CalledByNative public void release() { @@ -263,22 +368,23 @@ 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; } } - __attribute__((visibility("default"))) @interface AgoraOutputVideoFrame : NSObject + __attribute__((visibility("default"))) @interface AgoraOutputVideoFrame : NSObject + @property (nonatomic, assign) NSInteger type; @property (nonatomic, assign) int width; @property (nonatomic, assign) int height; @@ -291,12 +397,16 @@ @property (nonatomic, assign) int rotation; @property (nonatomic, assign) int64_t renderTimeMs; @property (nonatomic, assign) int avSyncType; + @property(assign, nonatomic) CVPixelBufferRef _Nullable pixelBuffer; @property (nonatomic, assign) uint8_t* _Nullable alphaBuffer; @property (nonatomic, assign) AgoraAlphaStitchMode alphaStitchMode; + @property(nonatomic, strong) NSDictionary *_Nonnull metaInfo; +@property(nonatomic, strong) AgoraColorSpace* _Nullable colorSpace; @end - struct VideoFrame { + +struct VideoFrame { VideoFrame(): type(VIDEO_PIXEL_DEFAULT), width(0), @@ -316,33 +426,57 @@ textureId(0), d3d11Texture2d(NULL), alphaBuffer(NULL), - alphaStitchMode(0), + alphaStitchMode(NO_ALPHA_STITCH), pixelBuffer(NULL), metaInfo(NULL){ memset(matrix, 0, sizeof(matrix)); } + VIDEO_PIXEL_FORMAT type; + int width; + int height; + int yStride; + int uStride; + int vStride; + uint8_t* yBuffer; + uint8_t* uBuffer; + uint8_t* vBuffer; + int rotation; + int64_t renderTimeMs; + int avsync_type; + uint8_t* metadata_buffer; + int metadata_size; + void* sharedContext; + int textureId; + void* d3d11Texture2d; + float matrix[16]; + uint8_t* alphaBuffer; - int alphaStitchMode; + + ALPHA_STITCH_MODE alphaStitchMode; + void* pixelBuffer; + IVideoFrameMetaInfo* metaInfo; + + ColorSpace colorSpace; }; USTRUCT(BlueprintType) struct FVideoFrame { @@ -608,49 +742,67 @@ class VideoFrame {

        缓冲区给出的是指向指针的指针,该接口不能修改缓冲区的指针,只能修改缓冲区的内容。

        +
        + 方法 + + + getColorSpace + 获取视频帧的色彩空间属性。 + + + setColorSpace + 设置视频帧的色彩空间属性。 + + +
        <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 数据,值为空。 @@ -727,9 +879,9 @@ class VideoFrame { pixelBuffer 将数据填充到 CVPixelBuffer。 - - colorSpace - 表示视频帧的色彩空间。详见 + + colorSpace + 视频帧的色彩空间属性,默认情况下会应用 Full Range 和 BT.709 标准配置。你可以根据自采集、自渲染的业务需求进行自定义设置,详见 sourceType diff --git a/dita/RTC-NG/API/class_virtualbackgroundsource.dita b/dita/RTC-NG/API/class_virtualbackgroundsource.dita index d24a34605bc..d2b16d43304 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); @@ -158,7 +174,7 @@ public: <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> - backgroundSourceType + backgroundSourceType background_source_type 自定义的背景。详见
          @@ -185,7 +201,7 @@ public: 该参数仅在自定义背景图类型为 时生效。 - blurDegree + blurDegree blur_degree 自定义背景图的模糊程度。详见
            @@ -197,4 +213,4 @@ public:
        - \ No newline at end of file + 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_backgroundsourcetype.dita b/dita/RTC-NG/API/enum_backgroundsourcetype.dita index 6ae3992dfe4..c83bd84fe61 100644 --- a/dita/RTC-NG/API/enum_backgroundsourcetype.dita +++ b/dita/RTC-NG/API/enum_backgroundsourcetype.dita @@ -7,7 +7,7 @@
        枚举值 - + 0: 将背景处理为 Alpha 数据,不作替换,仅分割人像和背景。设置后,你可以调用 ,实现人像画中画的效果。 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/enum_errorcodetype.dita b/dita/RTC-NG/API/enum_errorcodetype.dita index 29547c8d468..340e5e4b06e 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) 状态外,不要再次调用该方法加入频道。
          • -
          • 用户在调用 进行通话测试后,未调用 结束当前测试就尝试加入频道。开始通话测试后,需要先调用 结束当前测试,再加入频道。
          • +
          • 用户在调用 进行通话测试后,未调用 结束当前测试就尝试加入频道。开始通话测试后,需要先调用 结束当前测试,再加入频道。
          @@ -142,7 +142,7 @@
        • 在控制台中启用了 App 证书,但未使用 App ID + Token 鉴权。当项目启用了 App 证书,就必须使用 Token 鉴权。
        • 生成 Token 时填入的 uid 字段,和用户加入频道时填入的 uid 不匹配。
        -
        +
        弃用:
        该枚举已废弃。请改用 回调中的 (8)。
        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/API/enum_qualitytype.dita b/dita/RTC-NG/API/enum_qualitytype.dita index a63c2528926..49b94312fb9 100644 --- a/dita/RTC-NG/API/enum_qualitytype.dita +++ b/dita/RTC-NG/API/enum_qualitytype.dita @@ -41,7 +41,7 @@ - 8: 网络质量检测已开始还没完成。 + 8: 网络质量检测进行中。
        diff --git a/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita b/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita index a2092fd8af5..fb880ecc23f 100644 --- a/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita +++ b/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita @@ -19,20 +19,27 @@ 0: (默认) 通用场景。
        - +

        1: 会议场景。

        - +

        2: 1v1 视频通话

        + + + +

        3: 秀场直播

        +

        + +

        diff --git a/dita/RTC-NG/API/enum_videomoduleposition.dita b/dita/RTC-NG/API/enum_videomoduleposition.dita index 8c8579ed1ec..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..84f2349145c 100644 --- a/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/dita/RTC-NG/API/rtc_api_data_type.dita @@ -206,6 +206,7 @@
      • +
      • @@ -216,6 +217,7 @@
      • +
      • @@ -259,51 +261,51 @@
      • -
      • -
      • +
      • +
      • -
      • -
      • -
      • -
      • +
      • +
      • +
      • +
      • -
      • +
        • -
        • -
        • -
        • -
        • +
        • +
        • +
        • +
      • -
      • -
      • -
      • -
      • +
      • +
      • +
      • +
      • -
      • -
      • -
      • -
      • +
      • +
      • +
      • +
      • -
      • -
      • -
      • -
      • -
      • +
      • +
      • +
      • +
      • +
      • -
      • -
      • -
      • +
      • +
      • +
      • @@ -316,16 +318,16 @@
      • -
      • +
      • -
      • +
      • -
      • +
      • @@ -343,18 +345,18 @@
      • -
      • -
      • -
      • +
      • +
      • +
      • -
      • +
      • -
      • +
      • -
      • +
      @@ -1356,6 +1358,7 @@
    • +
    • diff --git a/dita/RTC-NG/API/rtc_api_overview.dita b/dita/RTC-NG/API/rtc_api_overview.dita index 4774af050a7..04ead20e2b0 100644 --- a/dita/RTC-NG/API/rtc_api_overview.dita +++ b/dita/RTC-NG/API/rtc_api_overview.dita @@ -290,7 +290,7 @@ 方法/回调 描述 - + @@ -550,14 +550,14 @@
    -
    +
    原始音频数据 方法/回调 描述 - + @@ -849,7 +849,7 @@ - + @@ -951,7 +951,7 @@ - + @@ -1121,7 +1121,7 @@ - + @@ -1137,7 +1137,7 @@ - + @@ -1313,11 +1313,15 @@ + + + (仅适用于 Android) + - + @@ -1428,34 +1432,34 @@
    -
    +
    音效文件播放 方法/回调 描述 - + - + - + - + - + - + @@ -1475,19 +1479,19 @@ - + - + - + - + @@ -1495,11 +1499,11 @@ - + - + @@ -1507,15 +1511,15 @@ - + - + - + @@ -1525,7 +1529,7 @@
    -
    +
    虚拟节拍器 @@ -1550,7 +1554,7 @@
    -
    +
    媒体播放器

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

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

    @@ -1559,9 +1563,9 @@ 方法/回调 描述 - + - + @@ -1575,11 +1579,11 @@ - + - + @@ -1658,7 +1662,7 @@
    -
    +
    <ph props="cn">版权音乐</ph>

    本组方法仅适用于 Android 和 iOS。

    @@ -1682,7 +1686,7 @@ - + @@ -1698,7 +1702,7 @@ - + @@ -1734,7 +1738,7 @@ - + @@ -1742,10 +1746,14 @@ - + + + + + @@ -1770,7 +1778,7 @@ - + @@ -1778,7 +1786,7 @@ - + @@ -1884,7 +1892,7 @@ - + @@ -1896,7 +1904,7 @@ - + @@ -1904,7 +1912,7 @@ - + @@ -2049,7 +2057,7 @@
    -
    +
    Metadata (SEI) @@ -2064,7 +2072,7 @@ - + @@ -2122,7 +2130,7 @@ - + @@ -2259,7 +2267,7 @@ (仅适用于 Android 和 iOS) - + (仅适用于 Android 和 iOS) @@ -2311,7 +2319,7 @@ (仅适用于 Android 和 iOS) - + (仅适用于 Android 和 iOS) @@ -2589,7 +2597,7 @@ (仅适用于 Android)
    -
    +
    插件相关 @@ -2604,7 +2612,7 @@ - + @@ -2612,31 +2620,31 @@ - + - + - + - + - + - + - + diff --git a/dita/RTC-NG/RTC_NG_API_Android.ditamap b/dita/RTC-NG/RTC_NG_API_Android.ditamap index 5a823f671f4..1402359fd25 100644 --- a/dita/RTC-NG/RTC_NG_API_Android.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Android.ditamap @@ -91,6 +91,10 @@ + + + + @@ -103,6 +107,15 @@ + + + + + + + + + @@ -195,6 +208,11 @@ + + + + + @@ -278,6 +296,7 @@ + @@ -297,6 +316,12 @@ + + + + + + @@ -326,36 +351,15 @@ - - - - - - - - - - - - - - - - - - - - - - - + + @@ -392,6 +396,7 @@ + @@ -513,20 +518,20 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + + @@ -623,9 +628,9 @@ - + - + diff --git a/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap b/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap index ee09bb5749b..9885a2e2e6d 100644 --- a/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap @@ -97,6 +97,10 @@ + + + + @@ -109,6 +113,12 @@ + + + + + + @@ -317,6 +327,12 @@ + + + + + + @@ -346,26 +362,6 @@ - - - - - - - - - - - - - - - - - - - - @@ -531,20 +527,20 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + + diff --git a/dita/RTC-NG/RTC_NG_API_CPP.ditamap b/dita/RTC-NG/RTC_NG_API_CPP.ditamap index e7f27c551b8..046d9cfa99b 100644 --- a/dita/RTC-NG/RTC_NG_API_CPP.ditamap +++ b/dita/RTC-NG/RTC_NG_API_CPP.ditamap @@ -399,6 +399,7 @@ + diff --git a/dita/RTC-NG/RTC_NG_API_Flutter.ditamap b/dita/RTC-NG/RTC_NG_API_Flutter.ditamap index 45aa0e30ca7..6a7db2377bf 100644 --- a/dita/RTC-NG/RTC_NG_API_Flutter.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Flutter.ditamap @@ -97,6 +97,10 @@ + + + + @@ -109,6 +113,12 @@ + + + + + + @@ -305,6 +315,12 @@ + + + + + + @@ -334,26 +350,6 @@ - - - - - - - - - - - - - - - - - - - - @@ -506,20 +502,20 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + + diff --git a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap index 8e919efbb33..fee50b54fe3 100644 --- a/dita/RTC-NG/RTC_NG_API_Harmony.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Harmony.ditamap @@ -21,34 +21,34 @@ - + - + - + - + - + - - - + + + - + - + @@ -63,17 +63,17 @@ - + - + - + @@ -82,26 +82,26 @@ - + - + - + - - - + + + - + - + - + @@ -112,26 +112,26 @@ - - - + + + - - + + - + - + - + @@ -139,21 +139,21 @@ - + - + - + - - + + @@ -171,33 +171,33 @@ - - - - - - + + + + + + - - - - - + + + + + - - - - - - - - + + + + + + + + - + - + @@ -230,7 +230,7 @@ - + @@ -250,26 +250,26 @@ - + - + - + - - + + - + @@ -281,14 +281,14 @@ - + - + - + @@ -297,14 +297,14 @@ - - - - - - - - + + + + + + + + @@ -312,49 +312,47 @@ - + - + - + - + - + - - - + + + - + - + - - + - - + @@ -388,7 +386,7 @@ - + @@ -402,43 +400,42 @@ - - + + - + - + - - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - + + @@ -446,22 +443,20 @@ - + - + - + - - - + @@ -471,7 +466,7 @@ - + @@ -483,7 +478,7 @@ - + @@ -494,23 +489,23 @@ - + - - - + + + - - + + - - - - - - - - + + + + + + + + @@ -528,31 +523,33 @@ - + + - + - + - + - + - + + - - + + @@ -574,21 +571,21 @@ - + - + - + - + - - + + @@ -606,10 +603,10 @@ - - - - + + + + @@ -620,16 +617,16 @@ - + - + - + @@ -641,31 +638,31 @@ - + - - - - + + + + - - + + - + - + - - + + @@ -676,7 +673,7 @@ - + @@ -684,7 +681,7 @@ - + @@ -699,11 +696,11 @@ - + - + @@ -711,12 +708,10 @@ - - - - - + + + diff --git a/dita/RTC-NG/RTC_NG_API_Unreal.ditamap b/dita/RTC-NG/RTC_NG_API_Unreal.ditamap index af24969b303..2f4cb93f10e 100644 --- a/dita/RTC-NG/RTC_NG_API_Unreal.ditamap +++ b/dita/RTC-NG/RTC_NG_API_Unreal.ditamap @@ -93,6 +93,10 @@ + + + + @@ -105,6 +109,12 @@ + + + + + + @@ -313,6 +323,12 @@ + + + + + + @@ -342,26 +358,6 @@ - - - - - - - - - - - - - - - - - - - - @@ -525,20 +521,20 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + + 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-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap index bf4073b8d0e..4500cb04a5b 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -2611,6 +2611,13 @@ + + + + setExternalRemoteEglContext + + + @@ -11807,6 +11814,13 @@ + + + + APPLICATION_SCENARIO_LIVESHOW + + + 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..42890708875 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 + + + @@ -75,14 +83,14 @@ - + IAudioEffectManager - + IAudioFrameObserver @@ -103,7 +111,7 @@ - + IMediaPlayerCacheManager @@ -117,7 +125,7 @@ - + IMediaPlayerVideoFrameObserver @@ -152,7 +160,7 @@ - + IMetadataObserver @@ -166,7 +174,7 @@ - + IVideoFrameObserver @@ -187,7 +195,7 @@ - + IBaseSpatialAudioEngine @@ -201,28 +209,28 @@ - + AudioParams - + IMusicContentCenterEventHandler - + IAgoraMusicPlayer - + IAgoraMusicContentCenter @@ -239,7 +247,7 @@ - + create @@ -289,7 +297,7 @@ - + @@ -389,7 +397,7 @@ - + @@ -428,14 +436,14 @@ - getPlaySrc [1/2] + getPlaySrc - + - getPlaySrc + getPlaySrc [2/2] @@ -474,7 +482,7 @@ - + getMediaPlayerCacheManager @@ -545,13 +553,6 @@ - - - open [1/2] - - - - open @@ -593,14 +594,14 @@ - + registerAudioFrameObserver - + registerVideoFrameObserver @@ -628,7 +629,7 @@ - + selectAudioTrack @@ -740,13 +741,6 @@ - - - - openWithCustomSource - - - @@ -840,13 +834,6 @@ - - - - enableAudioQualityIndication - - - @@ -882,7 +869,7 @@ - + adjustUserPlaybackSignalVolume @@ -989,7 +976,7 @@ - + setVideoScenario @@ -1017,7 +1004,6 @@ - @@ -1025,13 +1011,6 @@ - - - - setRemoteRenderMode [1/2] - - - @@ -1046,20 +1025,6 @@ - - - - CreateRendererView - - - - - - - CreateTextureView - - - @@ -1209,7 +1174,7 @@ - + adjustUserPlaybackSignalVolumeEx @@ -1223,7 +1188,7 @@ - + createDataStreamEx [1/2] @@ -1237,7 +1202,7 @@ - + enableAudioVolumeIndicationEx @@ -1287,14 +1252,14 @@ - + muteRemoteAudioStreamEx - + muteRemoteVideoStreamEx @@ -1329,7 +1294,7 @@ - + setRemoteRenderModeEx @@ -1343,7 +1308,7 @@ - + setRemoteVideoStreamTypeEx @@ -1406,14 +1371,14 @@ - + takeSnapshotEx - + updateChannelMediaOptionsEx @@ -1427,84 +1392,84 @@ - + startRtmpStreamWithoutTranscodingEx - + startRtmpStreamWithTranscodingEx - + updateRtmpTranscodingEx - + stopRtmpStreamEx - + startOrUpdateChannelMediaRelayEx - + pauseAllChannelMediaRelayEx - + muteLocalAudioStreamEx - + muteLocalVideoStreamEx - + muteAllRemoteAudioStreamsEx - + muteAllRemoteVideoStreamsEx - + stopChannelMediaRelayEx - + resumeAllChannelMediaRelayEx @@ -1527,7 +1492,7 @@ - + updateScreenCaptureParameters @@ -1564,14 +1529,14 @@ - + setAudioMixingPlaybackSpeed - + @@ -1621,14 +1586,14 @@ - + getAudioMixingPlayoutVolume - + getAudioMixingPublishVolume @@ -1672,7 +1637,7 @@ - + getAudioEffectManager @@ -2045,7 +2010,7 @@ - + startRtmpStreamWithoutTranscoding @@ -2278,14 +2243,14 @@ - + pauseAllChannelMediaRelay - + resumeAllChannelMediaRelay @@ -2359,7 +2324,7 @@ - + isCameraFaceDetectSupported @@ -2375,7 +2340,7 @@ - + setEnableSpeakerphone @@ -2443,8 +2408,8 @@ - - + + enableDualStreamMode @@ -2458,21 +2423,15 @@ - - - - setDualStreamMode [1/2] - - - - + + setDualStreamMode - + setDualStreamModeEx @@ -2504,24 +2463,10 @@ - - - - startEchoTest [1/3] - - - - - - - startEchoTest [2/3] - - - - startEchoTest [3/3] + startEchoTest @@ -2569,15 +2514,15 @@ - + + + - pushExternalVideoFrameById [1/2] + pushExternalVideoFrameById - - - + @@ -2727,7 +2672,7 @@ - + @@ -2743,7 +2688,7 @@ - + @@ -2789,7 +2734,7 @@ - + @@ -2839,31 +2784,31 @@ - + - onEvent + onEventWithContext - + - onStarted + onStartedWithContext - + - onStopped + onStoppedWithContext - + - onError + onErrorWithContext @@ -2891,7 +2836,7 @@ - + @@ -2945,20 +2890,6 @@ - - - - setEncryptionMode - - - - - - - setEncryptionSecret - - - @@ -3058,7 +2989,7 @@ - + isCameraZoomSupported @@ -3079,7 +3010,7 @@ - + isCameraExposurePositionSupported @@ -3093,7 +3024,7 @@ - + isCameraAutoFocusFaceModeSupported @@ -3121,21 +3052,21 @@ - + setCameraExposurePosition - + setCameraTorchOn - + setCameraAutoFocusFaceModeEnabled @@ -3181,7 +3112,7 @@ - + @@ -3252,7 +3183,7 @@ - + @@ -3260,17 +3191,17 @@ - + open2 - + - stop + stop [2/2] @@ -3344,6 +3275,13 @@ + + + + destroyMusicPlayer + + + @@ -3414,8 +3352,15 @@ + + + + setPlayMode + + + - + @@ -3460,7 +3405,7 @@ - + enableContentInspect @@ -3546,7 +3491,7 @@ - + getErrorDescription @@ -3560,7 +3505,7 @@ - + getSdkVersion @@ -3609,7 +3554,7 @@ - + setLogFile @@ -3623,7 +3568,7 @@ - + setLogFilter @@ -3717,7 +3662,7 @@ - + onUserMuteAudio @@ -3759,21 +3704,21 @@ - + onTokenPrivilegeWillExpire - + onRequestToken - + onLocalUserRegistered @@ -3838,14 +3783,14 @@ - + onFirstLocalVideoFrame - + onAudioPublishStateChanged @@ -3861,7 +3806,7 @@ - + onAudioSubscribeStateChanged @@ -3875,7 +3820,7 @@ - + onFirstRemoteVideoFrame @@ -3903,14 +3848,14 @@ - + onUserEnableVideo - + onUserMuteVideo @@ -3924,7 +3869,7 @@ - + onVideoSubscribeStateChanged @@ -4005,42 +3950,42 @@ - + onMetaData - + onPlayerCacheStats - + onPlayerEvent - + onPlayerPlaybackStats - + onPlayerStateChanged - + onPositionChanged @@ -4061,14 +4006,14 @@ - + onPlayBufferUpdated - + onPreloadEvent @@ -4082,14 +4027,14 @@ - + onPlayerSrcInfoChanged - + onPlayerInfoUpdated @@ -4122,13 +4067,6 @@ - - - - onAudioMixingFinished - - - @@ -4136,7 +4074,7 @@ - + onAudioEffectFinished @@ -4177,7 +4115,7 @@ - + onChannelMediaRelayStateChanged @@ -4260,7 +4198,7 @@ - + @@ -4397,7 +4335,7 @@ - + @@ -4420,11 +4358,11 @@ - + - onCameraFocusAreaChanged + onCameraFocusPointChanged @@ -4435,7 +4373,7 @@ - + onCameraReady @@ -4459,7 +4397,7 @@ - + @@ -4484,7 +4422,7 @@ - + @@ -4492,7 +4430,7 @@ - + onTranscodedStreamLayoutInfo @@ -4553,7 +4491,7 @@ - + AdvancedAudioOptions @@ -4770,7 +4708,7 @@ - + AgoraVideoFrame @@ -4784,7 +4722,7 @@ - + AgoraFocalLengthInfo @@ -5043,6 +4981,13 @@ + + + + ScreenCaptureParameters + + + @@ -5123,7 +5068,7 @@ - UserAudioSpectrumInfo + AudioSpectrumInfo @@ -5822,31 +5767,38 @@ + + + + ContentInspectType + + + - CONTENT_INSPECT_TYPE_INVALID + INVALID - CONTENT_INSPECT_TYPE_MODERATION + MODERATION - CONTENT_INSPECT_TYPE_SUPERVISE + SUPERVISE - CONTENT_INSPECT_TYPE_IMAGE_MODERATION + IMAGE_MODERATION @@ -6168,28 +6120,28 @@ - AUDIO_DUAL_MONO_STEREO + STEREO - AUDIO_DUAL_MONO_L + L - AUDIO_DUAL_MONO_R + R - AUDIO_DUAL_MONO_MIX + MIX @@ -6228,94 +6180,108 @@ + + + + AudioMixingReason + + + - 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 + + + + + + + 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 @@ -6763,21 +6729,21 @@ - AUDIO_SAMPLE_RATE_32000 + TYPE_32000 - AUDIO_SAMPLE_RATE_44100 + TYPE_44100 - AUDIO_SAMPLE_RATE_48000 + TYPE_48000 @@ -6865,6 +6831,13 @@ + + + + ConnectionChangedReason + + + @@ -7159,220 +7132,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 @@ -7649,31 +7636,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 @@ -7831,6 +7825,13 @@ + + + + ERR_INIT_NET_ENGINE + + + @@ -8398,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 @@ -8545,6 +8560,27 @@ + + + + SCREEN_CAPTURE_STOPPED_BY_USER + + + + + + + SCREEN_CAPTURE_INTERRUPTED_BY_OTHER + + + + + + + SCREEN_CAPTURE_STOPPED_BY_CALL + + + @@ -8933,105 +8969,105 @@ - PLAYER_EVENT_UNKNOWN + UNKNOWN - PLAYER_EVENT_SEEK_BEGIN + SEEK_BEGIN - PLAYER_EVENT_SEEK_COMPLETE + SEEK_COMPLETE - PLAYER_EVENT_SEEK_ERROR + SEEK_ERROR - PLAYER_EVENT_AUDIO_TRACK_CHANGED + AUDIO_TRACK_CHANGED - PLAYER_EVENT_BUFFER_LOW + BUFFER_LOW - PLAYER_EVENT_BUFFER_RECOVER + BUFFER_RECOVER - PLAYER_EVENT_FREEZE_START + FREEZE_START - PLAYER_EVENT_FREEZE_STOP + FREEZE_STOP - PLAYER_EVENT_SWITCH_BEGIN + SWITCH_BEGIN - PLAYER_EVENT_SWITCH_COMPLETE + SWITCH_COMPLETE - PLAYER_EVENT_SWITCH_ERROR + SWITCH_ERROR - PLAYER_EVENT_FIRST_DISPLAYED + FIRST_DISPLAYED - PLAYER_EVENT_REACH_CACHE_FILE_MAX_COUNT + REACH_CACHE_FILE_MAX_COUNT - PLAYER_EVENT_REACH_CACHE_FILE_MAX_SIZE + REACH_CACHE_FILE_MAX_SIZE @@ -9066,70 +9102,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 @@ -9325,60 +9361,88 @@ - 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 + + + + + + + MusicPlayMode + + + + + + + ORIGINAL + + + + + + + ACCOMPANY + + + + + + + LEAD_SING + + + + PreloadState @@ -9462,6 +9526,13 @@ + + + + PermissionType + + + @@ -9749,38 +9820,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 @@ -10429,31 +10507,38 @@ + + + + StreamSubscribeState + + + - SUB_STATE_IDLE + IDLE - SUB_STATE_NO_SUBSCRIBED + NO_SUBSCRIBED - SUB_STATE_SUBSCRIBING + SUBSCRIBING - SUB_STATE_SUBSCRIBED + SUBSCRIBED @@ -10478,13 +10563,6 @@ - - - - VIDEO_BUFFER_RAW_DATA - - - @@ -10506,6 +10584,34 @@ + + + + VideoBufferType + + + + + + + RAW_DATA + + + + + + + ARRAY + + + + + + + TEXTURE + + + @@ -11612,6 +11718,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/keys-rtc-ng-api-ios.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap index 1bdc38893e8..fac4aadfa53 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap @@ -10912,6 +10912,13 @@ + + + + AgoraApplicationLiveShowScenario + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap index dd3da6e473e..02b1a5f7dc3 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap @@ -1058,6 +1058,20 @@ + + + + setLocalRenderTargetFps + + + + + + + setRemoteRenderTargetFps + + + @@ -1556,6 +1570,13 @@ + + + + setExternalMediaProjection + + + @@ -2507,6 +2528,29 @@ + + + + + startLocalAudioMixer + + + + + + + stopLocalAudioMixer + + + + + + + updateLocalAudioMixerConfiguration + + + + @@ -2715,6 +2759,13 @@ + + + + setExternalRemoteEglContext + + + @@ -4824,6 +4875,69 @@ + + + + AudioSourceType + + + + + + + AUDIO_SOURCE_MICROPHONE + + + + + + + AUDIO_SOURCE_CUSTOM + + + + + + + AUDIO_SOURCE_MEDIA_PLAYER + + + + + + + AUDIO_SOURCE_LOOPBACK_RECORDING + + + + + + + AUDIO_SOURCE_MIXED_STREAM + + + + + + + AUDIO_SOURCE_REMOTE_USER + + + + + + + AUDIO_SOURCE_REMOTE_CHANNEL + + + + + + + AUDIO_SOURCE_UNKNOWN + + + @@ -5090,6 +5204,13 @@ + + + + LocalAudioMixerConfiguration + + + @@ -5153,6 +5274,13 @@ + + + + MixedAudioStream + + + @@ -6016,6 +6144,13 @@ + + + + PREFER_COMPRESSION_AUTO + + + @@ -9838,6 +9973,13 @@ + + + + QUALITY_DETECTING + + + @@ -10672,6 +10814,13 @@ + + + + APPLICATION_SCENARIO_LIVESHOW + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap index 1b4ef97a989..251e3519f5a 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap @@ -10357,6 +10357,13 @@ + + + + AgoraApplicationLiveShowScenario + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap index 38c5a447f70..3e3b3e0b4ec 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-android.ditamap @@ -101,6 +101,13 @@ + + + + 自定义视频数据处理 + + + @@ -125,13 +132,6 @@ - - - - VideoColorSpace - - - @@ -167,5 +167,12 @@ + + + + MediaProjection + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-cpp.ditamap index 28aaff82664..bf8ea4c0ead 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-cpp.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-cpp.ditamap @@ -88,6 +88,13 @@ + + + + 自定义视频数据处理 + + + 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..9ea613c5a56 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 - + 音频路由 @@ -17,14 +17,14 @@ - + 视频属性 - + 使用 Token 鉴权 @@ -66,7 +66,7 @@ - + 屏幕共享 @@ -104,13 +104,6 @@ - - - - VideoColorSpace - - - diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-ios.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-ios.ditamap index 909e190e4fe..c51a8e5398f 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-ios.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-ios.ditamap @@ -102,6 +102,13 @@ + + + + 自定义视频数据处理 + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-links-macos.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links-macos.ditamap index 5ea909f6766..865016c494b 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links-macos.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links-macos.ditamap @@ -74,6 +74,13 @@ + + + + 自定义视频数据处理 + + + diff --git a/dita/RTC-NG/config/keys-rtc-ng-links.ditamap b/dita/RTC-NG/config/keys-rtc-ng-links.ditamap index 5611004f6b7..d7e13d4377c 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-links.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-links.ditamap @@ -90,6 +90,27 @@ + + + + 视频 1v1 通话 + + + + + + + 秀场直播 + + + + + + + VideoColorSpace + + + @@ -106,7 +127,7 @@ - + 计费说明 diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index d189da546bc..7f878735f07 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,11 +2266,11 @@ - + - - - + + + @@ -2278,35 +2278,35 @@ - + - - + + - - + + - + - - - - - - - - - + + + + + + + + + - - + + @@ -2326,8 +2326,8 @@ - - + + @@ -2342,23 +2342,23 @@ - + - + - - + + - - + + - - + + - - + + @@ -2374,15 +2374,15 @@ - + - - - - - - + + + + + + @@ -2390,10 +2390,10 @@ - + - + @@ -2405,47 +2405,47 @@ - - + + - - - - - - + + + + + + - - + - + + - - + + - + - + - - - - - - + + + + + + - + @@ -2456,46 +2456,46 @@ - + - + - + - + - - - - - + + + + + - + - + - + - - + + - + @@ -2503,38 +2503,38 @@ - + - - + + - + - + - + - + @@ -2555,23 +2555,23 @@ - - + + - + - - - + + + - + - + @@ -2580,32 +2580,33 @@ - + - + - + - - - - + + + + - + - - - - - + + + + + - + + @@ -2624,7 +2625,7 @@ - + @@ -2633,18 +2634,18 @@ - - + + - - + + - - + + @@ -2655,12 +2656,12 @@ - + - - - - + + + + @@ -2681,13 +2682,13 @@ - - + + - + - + @@ -2696,10 +2697,10 @@ - - + + - + @@ -2707,10 +2708,10 @@ - + - + @@ -2793,7 +2794,7 @@ - + @@ -3201,41 +3202,41 @@ - + - + - + - + - - - - - - - + + + + + + + - + - + - - - + + + diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita index 825c52c1ec6..5ca874679b2 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita @@ -46,7 +46,7 @@ zones - Sound insulation area settings. See . When you set this parameter to , it means clearing all sound insulation zones.On the Windows platform, it is necessary to ensure that the number of members in the zones array is equal to the value of zoneCount; otherwise, it may cause a crash. + Sound insulation area settings. See . When you set this parameter to , it means clearing all sound insulation zones.On the Windows platform, it is necessary to ensure that the number of members in the zones array is equal to the value of zoneCount; otherwise, it may cause a crash. zoneCount diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita index 6c307b430ff..c53783c01c4 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita @@ -32,7 +32,7 @@

    Details -
    +
    Deprecated:
    If you need to push video frames in I422 format, you need to use this method; otherwise, use .
    diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita index 50ba2659373..6a6d28f28b3 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita index d173c514261..cdcff658f94 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita @@ -30,20 +30,10 @@

    Details -

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

    -

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

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

    +

    If you only want to observe encoded video frames (such as H.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method. For detailed implementation steps, please refer to .

    -
      -
    • Call this method before joining a channel.
    • -
    +

    Call this method before joining a channel.

    +
    Parameters diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita index b1d8860bbcb..8b4f79df006 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita +++ b/en-US/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; @@ -26,11 +26,10 @@

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

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

    -

    Applicable scenarios -

    After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself.

    +

    After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself. For detailed implementation steps, please refer to .

    Agora provides an open source sample project on GitHub for your reference.

    diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita index 7d1367767d7..4cad6e202ce 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_setexternalvideosource.dita @@ -41,7 +41,8 @@

    -

    After calling this method to enable an external video source, you can call to push external video data to the SDK.

    +

    After calling this method to enable an external video source, you can call to push external video data to the SDK.

    +

    After calling this method to enable an external video source, you can call to push external video data to the SDK.

    Call timing diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita index f1c93eea3a8..1a4e73114c1 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustplayoutvolume.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita index 5a186d2b161..c1ef7522929 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_adjustpublishsignalvolume.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_getduration.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getduration.dita index e96b18ff592..62a92e710ed 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getduration.dita +++ b/en-US/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: Failure. See for details and resolution suggestions.
  • The total duration (ms) of the media file.

    -
      +
      • If the method call succeeds, the SDK returns the total duration(ms) of the media file.
      • < 0: Failure. See for details and resolution suggestions.
    diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getmediaplayerid.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getmediaplayerid.dita index 2e46694ed6d..040b5e66daf 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getmediaplayerid.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita index 4b50dae42a8..5cfdb3134cc 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getmute.dita +++ b/en-US/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") @@ -43,7 +43,7 @@

  • 0: Success.
  • < 0: Failure. See for details and resolution suggestions.
  • -
      +
      • : Reports whether the media resource is muted.
      • : Reports whether the media resource is muted.
    diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita index 543ba8080f9..1f8031578e4 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita +++ b/en-US/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") @@ -42,7 +42,7 @@

  • 0: Success.
  • < 0: Failure. See for details and resolution suggestions.
  • -

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

      +

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

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

    diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita index 1c5a05423d9..ee88b0cb3b9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita index f0d26bdbb22..73b55fc7767 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita index f33aa8f952d..baae46914df 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getpublishsignalvolume.dita +++ b/en-US/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: Success.
  • < 0: Failure. See for details and resolution suggestions.
  • -
      +
      • ≥ 0: The remote playback volume.
      • < 0: Failure. See for details and resolution suggestions.
    diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getstate.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getstate.dita index be2d8f69cb7..15c89442e03 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getstate.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita index 34a3b96dc01..0e732095124 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreamcount.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita index 057f61bd2c2..74b8f0ead71 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getstreaminfo.dita +++ b/en-US/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 The index of the media stream. This parameter needs to be less than the count parameter of . - The index of the media stream. This parameter must be less than the return value of . + The index of the media stream. This parameter must be less than the return value of . info diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita index 300e99453c5..3aa1d15a4e3 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita index 47a1e828ec3..2fd75613045 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_open.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita index 5afe98595db..1faa659d767 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithmediasource.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita index 77f451f49f3..685fb532187 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita index aad566ba837..fa7764aa871 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_play.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita index 39c5f7f0930..84126f06452 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita index 45a7777dc88..520ee67f8c8 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_preloadsrc.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita index 2c62fbcddd3..2c8c3d4c237 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver2.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita index f2a50b96f9a..1efb08f59ab 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registerplayersourceobserver.dita +++ b/en-US/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 @@

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

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

    -
      +
      • 0: Success.
      • < 0: Failure. See for details and resolution suggestions.
      diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita index 3995bba98d9..32440e33a9f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita index 545412ebd82..7ecc871b961 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_resume.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita index d1e4ff2afaa..41d7993ee25 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_seek.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita index fde50ad5649..ed10f5d6df0 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_selectaudiotrack.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita index 8915f1b8e4e..6d638bebc51 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_selectmultiaudiotrack.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita index cafb4c78afd..b463081ae45 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiodualmonomode.dita +++ b/en-US/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,7 +38,7 @@ mode - The channel mode. See .

        + The channel mode. See .
        • (0): Original mode.
        • (1): Left channel mode. This mode replaces the audio of the right channel with the audio of the left channel, which means the user can only hear the audio of the left channel.
        • (2): Right channel mode. This mode replaces the audio of the left channel with the audio of the right channel, which means the user can only hear the audio of the right channel.
        • diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita index 252b47a2349..2377cbd19d6 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setaudiopitch.dita +++ b/en-US/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 @@

          Parameters - + + + pitch + Sets the pitch of the local music file by the chromatic scale. The default value is 0, which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between consecutive values is a chromatic value. The greater the absolute value of this parameter, the higher or lower the pitch of the local music file. +
          <ph keyref="return-section-title"/> @@ -44,4 +48,4 @@
        • < 0: Failure. See for details and resolution suggestions.
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita index f281bf20dfa..318a911e801 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setloopcount.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita index de0a75ef2f1..f6e0465ea6e 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita index d941c2ab88b..5f555d6ee40 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita index 275fee09c2e..93109388547 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setplayeroption2.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita index 54477fa0c1e..de1980909bd 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita +++ b/en-US/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

      Sets the render mode of the view. See .

      Sets the render mode of the view:

        diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita index 9c7ebcdf393..c1d212059b8 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_setview.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita index 0257a757cb3..930eae46b70 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_stop.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita index 4d5698ee04b..5bf67c40f1d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita index bbe9f21d5a8..9c493a444ad 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unloadsrc.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita index ab17093aaf0..5381347c620 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregisterplayersourceobserver.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imediarecorder_enablemainqueuedispatch.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_enablemainqueuedispatch.dita index 5935f98a089..55aae955583 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_enablemainqueuedispatch.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_enablemainqueuedispatch.dita @@ -1,12 +1,12 @@ - <ph keyref="enableMainQueueDispatch" /> + <ph keyref="enableMainQueueDispatch_IMediaRecorder"/> Enables/Disables dispatching delegate methods to the main queue. - + @@ -25,7 +25,7 @@

        Details -

        If disabled, the app should dispatch UI operations to the main queue.

        +

        If disabled, the app should dispatch UI operations to the main queue.

        Parameters @@ -34,8 +34,8 @@ enabled
          -
        • : Dispatch delegate methods to the main queue.
        • -
        • : Do not dispatch delegate methods to the main queue.
        • +
        • : Dispatch delegate methods to the main queue.
        • +
        • : Do not dispatch delegate methods to the main queue.
        @@ -44,8 +44,8 @@ Returns
        • 0: Success.
        • -
        • < 0: Failure.
        • +
        • < 0: Failure. See for details and resolution suggestions.
        - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_removealllisteners.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_removealllisteners.dita index 44a2ac1905b..6b8fb80f9e3 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_removealllisteners.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_removealllisteners.dita @@ -1,12 +1,12 @@ - <ph keyref="removeAllListeners_IMediaRecorder" /> + <ph keyref="removeAllListeners_IMediaRecorder"/> Removes all listeners for the specified event. - + @@ -30,9 +30,9 @@ Parameters - - + +
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita index 3499845d43d..c048b42c02f 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita @@ -39,7 +39,7 @@ Parameters - callback + callback delegate The callbacks for recording audio and video streams. See . diff --git a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita index 9b5bb73379e..c8a1826e2c7 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_createmusicplayer.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita index 2c4241b039e..9b944770280 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_destroy.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita index eefa4ced277..70b607fbea7 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getcaches.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita index 2b96817082a..2ea8b2aea23 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getlyric.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccharts.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccharts.dita index 37f3bbf0ebf..5183a0b8d9c 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccharts.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccollectionbymusicchartid2.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccollectionbymusicchartid2.dita index 330aae2961c..8f81b8a45bc 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getmusiccollectionbymusicchartid2.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_initialize.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_initialize.dita index 39a11390276..bbee0de6908 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_initialize.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_ispreloaded.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_ispreloaded.dita index 2f46b96ce41..0797a220e56 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_ispreloaded.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_registereventhandler.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_registereventhandler.dita index 7b23415e97c..ee569c9b150 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_registereventhandler.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_removecache.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_removecache.dita index 63db586172d..427eea660ef 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_removecache.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_renewtoken.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_renewtoken.dita index 8080d8540a6..d6a41a4ce2e 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_renewtoken.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_searchmusic2.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_searchmusic2.dita index efae2ecadbb..1848ae77264 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_searchmusic2.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_imusiccontentcenter_unregistereventhandler.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_unregistereventhandler.dita index 3c8cdf4a10b..9af5ddb839f 100644 --- a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_unregistereventhandler.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita index 046da6426ff..7ed3cd71c84 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_adjustrecordingsignalvolume.dita @@ -26,7 +26,7 @@

      -

      If you only need to mute the audio signal, Agora recommends that you use instead.

      +

      If you only need to mute the audio signal, Agora recommends that you use instead.

      Call timing @@ -58,4 +58,4 @@
    • < 0: Failure. See for details and resolution suggestions.
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita index fa3634f69f8..1dd1e40cb40 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita b/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita index e50940a13a3..78580300ac6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_clearvideowatermarks.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita index c136755b929..e688fcfb017 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita @@ -30,7 +30,7 @@

    To publish a custom video source, see the following steps:

    1. Call this method to create a video track and get the video track ID.
    2. Call to join the channel. In , set customVideoTrackId to the video track ID that you want to publish, and set publishCustomVideoTrack to .
    3. -
    4. Call and specify videoTrackId as the video track ID set in step 2. You can then publish the corresponding custom video source in the channel.
    5. +
    6. Call and specify videoTrackId as the video track ID set in step 2. You can then publish the corresponding custom video source in the channel.

    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita index e020f04dced..f08590cdd26 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita @@ -27,7 +27,7 @@

    -

    Compared to , this method does not guarantee the reliability of data transmission. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.

    +

    Compared to , this method does not guarantee the reliability of data transmission. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.

    Call timing diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita index 69fa4c62ebe..2dd904a641b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita @@ -2,7 +2,7 @@ <ph keyref="createMediaPlayer" /> - Creates a media player object. Creates a media player instance. + Creates a media player object. Creates a media player instance. @@ -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/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita index 002d7fd5da7..edc8ca96d8e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroycustomvideotrack.dita @@ -30,7 +30,7 @@ video_track_id - videoTrackId + videoTrackId The video track ID returned by calling the method.

    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita index f3f6502c803..1b33cfa2d8e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroymediaplayer.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita b/en-US/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita index f8507be2bb4..2dc54686933 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita @@ -38,8 +38,9 @@ Parameters - mediaRecorder - The recording object to be destroyed. + mediaRecorder + recorder + 待销毁的 对象。

    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita index 75d90f09440..6f41b52b945 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablecontentinspect.dita +++ b/en-US/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") @@ -41,7 +41,10 @@

    Restrictions -

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

    +
      +
    • Before calling this method, ensure that you have contacted to activate the video screenshot upload service.
    • +
    • When the video moderation module is set to video moderation via Agora self-developed extension(), the video screenshot and upload dynamic library is required. Deleting this library disables the screenshot and upload feature.
    • +
    Parameters @@ -55,8 +58,7 @@ config - Screenshot and upload configuration. See .When the video moderation module is set to video moderation via Agora self-developed extension(), the video screenshot and upload dynamic library is required. Deleting this library disables the screenshot and upload feature. - + Screenshot and upload configuration. See .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita index a279d9a3bad..92c60810914 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita @@ -47,7 +47,7 @@
    • This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
    • -
    • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
    • +
    • If you need to enable dual video streams in a multi-channel scenario, you can call the method.
    • You can call this method either before or after joining a channel.
    @@ -76,4 +76,4 @@
  • < 0: Failure. See for details and resolution suggestions.
  • - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita index 8fba4bd0bb1..1701e0720b5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita index 488d0cdbdad..07698ac4441 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablefacedetection.dita @@ -49,7 +49,7 @@ enable - enabled + enabled Whether to enable face detection for the local user:

    • : Enable face detection.
    • : (Default) Disable face detection.
    • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index 1c8bc6ebf25..69d9f8583d2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/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") @@ -56,7 +56,7 @@ includeAudioFilters - The audio filter types of in-ear monitoring. See . + The audio filter types of in-ear monitoring. See . The audio filter types of in-ear monitoring:

      • (1 << 0): No audio filter added to in-ear monitoring.
      • (1 << 1): Add vocal effects audio filter to in-ear monitoring. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects. This enumerator supports combination using the bitwise OR operator (|).
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita index 84e94ccbaa5..416d38f403c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinstantmediarendering.dita @@ -39,7 +39,7 @@
      Call timing -

      Agora recommends that you call this method before joining a channel.

      +

      Call this method before joining a channel.

      Restrictions diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita index 17bd429f6af..7e914640742 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelocalaudio.dita @@ -34,7 +34,7 @@
      Applicable scenarios -

      This method does not affect receiving the remote audio streams, and () is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.

      +

      This method does not affect receiving the remote audio streams. () is suitable for scenarios where the user wants to receive remote audio streams without sending locally captured audio.

      Call timing diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita index e04af26c525..921ca27d290 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita @@ -29,7 +29,7 @@
      Details

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

      -

      Both this method and enable/disable virtual background, but this method allows you to specify the media source to which the virtual background is applied.

      +

      Both this method and enable/disable virtual background, but this method allows you to specify the media source to which the virtual background is applied.

      Call this method after calling or .

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita index 0abc78c7a07..a37a4d3845c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingplayoutvolume.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita index 448ff6b9937..546a6225443 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getaudiomixingpublishvolume.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita index 26a1669344a..5ca2d1a95c7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getcallid.dita @@ -26,7 +26,7 @@

      -

      When a user joins a channel on a client, a callId is generated to identify the call from the client. You can call this method to get the callId parameter, and pass it in when calling methods such as and .

      +

      When a user joins a channel on a client, a callId is generated to identify the call from the client. You can call this method to get callId, and pass it in when calling methods such as and .

      Call timing diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita index 6a54fb71181..738b8fb1026 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita index 82d2b7add0f..220155a8068 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getconnectionstate.dita @@ -25,6 +25,7 @@ Future<ConnectionStateType> getConnectionState();

      +
      Call timing

      This method can be called either before or after joining the channel.

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita b/en-US/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita index d6be7080d09..0165ecded3a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita +++ b/en-US/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 - The error code or warning code reported by the SDK. + error + The error code reported by the SDK.

      Returns -

      The specific error or warning description.

      +

      The specific error description.

      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita index c9f8ff09961..4e7c1ab4830 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita @@ -37,7 +37,7 @@
      Returns -

      The native handle of the SDK.

      +

      The native handle of the SDK.

      • 0: Success.
      • < 0: Failure. See for details and resolution suggestions.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getversion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getversion.dita index 524e1984459..734171a2018 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getversion.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita index 6158786ca4d..8a6dc4455c0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita @@ -2,7 +2,7 @@ <ph keyref="initialize"/> - Creates and initializes . Initializes . + Creates and initializes . Initializes . @@ -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 @@

        Call timing

        Before calling other APIs, you must call and to create and initialize the object.

        -

        Before calling other APIs, you must call this method to create the object.

        +

        Before calling other APIs, you must call this method to create the object.

        Restrictions @@ -45,7 +47,7 @@ context - config + config

        Configurations for the instance. See .

        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita index dc8d7fa7c4a..1a6f2705289 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita index f8538e58767..c000d56690e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita index acf851bb8f7..e9e34c44a78 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita +++ b/en-US/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") diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita index 1c03b0c5eca..6a5c609c500 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita index f51be5d5d4c..d8491c274d3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita +++ b/en-US/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") diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita index 95aabeeeeb2..e141152103c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita @@ -72,7 +72,7 @@ uid - The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit signed integer. The value range is from -231-1 to 231-1. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so. + The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit signed integer. The value range is from -231 to 231-1. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so. diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index 08d801dfcce..6042c627122 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -95,10 +95,10 @@ uid - The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit signed integer. The value range is from -231-1 to 231-1. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so. + The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit signed integer. The value range is from -231 to 231-1. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so. - options + options mediaOptions The channel media options. See . @@ -116,7 +116,7 @@

      • -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in is invalid. You need to pass in a valid parameter and join the channel again.
      • -3: Fails to initialize the object. You need to reinitialize the object.
      • -7: The object has not been initialized. You need to initialize the object before calling this method.
      • -
      • -8: The internal state of the object is wrong. The typical cause is that after calling to start a call loop test, you call this method to join the channel without calling to stop the test. You need to call before calling this method.
      • +
      • -8: The internal state of the object is wrong. The typical cause is that after calling to start a call loop test, you call this method to join the channel without calling to stop the test. You need to call before calling this method.
      • -17: The request to join the channel is rejected. The typical cause is that the user is already in the channel. Agora recommends that you use the callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the (1) state.
      • -102: The channel name is invalid. You need to pass in a valid channel name in channelId to rejoin the channel.
      • -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
      • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita index 12bc5d1e9bd..3da2503a92a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_leavechannel2.dita @@ -28,8 +28,8 @@

        After calling this method, the SDK terminates the audio and video interaction, leaves the current channel, and releases all resources related to the session.

        -

        After joining a channel, you must call this method or to end the call, otherwise, the next call cannot be started. If you have called to join multiple channels, calling this method will leave all the channels you joined.

        -

        After joining the channel, you must call this method to end the call; otherwise, the next call cannot be started. If you have called to join multiple channels, calling this method will leave all the channels you joined.

        +

        After joining a channel, you must call this method or to end the call, otherwise, the next call cannot be started. If you have called to join multiple channels, calling this method will leave all the channels you joined.

        +

        After joining the channel, you must call this method to end the call; otherwise, the next call cannot be started. If you have called to join multiple channels, calling this method will leave all the channels you joined.

        This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita index 04643b87d58..443f0c78cb2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremoteaudiostream.dita @@ -44,7 +44,7 @@ Parameters - uid + uid The user ID of the specified user. diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita index b354e77d83f..d4e1fb18354 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteremotevideostream.dita @@ -45,7 +45,7 @@ userId - uid + uid The user ID of the specified user. @@ -67,4 +67,4 @@
      • < 0: Failure. See for details and resolution suggestions.
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita index 20cc25a6e00..82568a4ae9e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pauseallchannelmediarelay.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita index e628152e73b..cd19bbf5157 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect3.dita @@ -78,7 +78,8 @@

      Restrictions -

      If you need to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call to preload the file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures.

      +

      If you need to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call to preload the file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures.

      +

      None.

      Details -
      +
      Deprecated:
      If you need to push video frames in I422 format, you need to use this method; otherwise, use .
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita index b0bddd39432..062381f606d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe3.dita +++ b/en-US/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 @@ Details

      -

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

      +

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

      Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe4.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe4.dita index 9c73ace4559..04496b67fb8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe4.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe4.dita @@ -26,7 +26,7 @@
      Details

      -

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

      +

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

      Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita b/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita index 8ffef744b4e..31aaeb73a70 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_renewtoken.dita @@ -39,13 +39,6 @@ Restrictions

      None.

      -
      Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita index 7cb6f6d28db..fc75926bd52 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_resumeallchannelmediarelay.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita index 96a75c3d481..2d077584c74 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_selectaudiotrack.dita +++ b/en-US/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); Parameters - index + index audioIndex The audio track you want to specify. The value should be greater than 0 and less than that of returned by . diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendcustomreportmessage.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendcustomreportmessage.dita index 94c5e7c9db2..fa36105d640 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendcustomreportmessage.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendcustomreportmessage.dita @@ -53,7 +53,7 @@

      Details -

      Agora supports reporting and analyzing customized messages. This function is in the beta stage with a free trial. The ability provided in its beta test version is reporting a maximum of 10 message pieces within 6 seconds, with each message piece not exceeding 256 bytes and each string not exceeding 100 bytes. To try out this function, contact and discuss the format of customized messages with us.

      +

      Agora supports reporting and analyzing customized messages. This function is in the beta stage with a free trial. The ability provided in its beta test version is reporting a maximum of 10 message pieces within 6 seconds, with each message piece not exceeding 256 bytes and each string not exceeding 100 bytes. To try out this function, contact and discuss the format of customized messages with us.

      \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita index d5f8debb791..43f511d6413 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendstreammessage.dita @@ -37,9 +37,8 @@ Details

      After calling , you can call this method to send data stream messages to all users in the channel.

      The SDK has the following restrictions on this method:

        -
      • Each user can have up to five data streams simultaneously.
      • -
      • Up to 60 packets can be sent per second in a data stream with each packet having a maximum size of 1 KB.
      • -
      • Up to 30 KB of data can be sent per second in a data stream.
      • +
      • Each client within the channel can have up to 5 data channels simultaneously, with a total shared packet bitrate limit of 30 KB/s for all data channels.
      • +
      • Each data channel can send up to 60 packets per second, with each packet being a maximum of 1 KB.

      A successful method call triggers the callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the callback on the remote client.

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingplaybackspeed.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingplaybackspeed.dita index 46bc64ba893..828086482e7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingplaybackspeed.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita index 1075fa1dc19..7cf1afbc2fb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioprofile.dita @@ -60,7 +60,7 @@ profile -

      The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See .

        +

        The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See .

        • (0): The default value.
        • @@ -85,4 +85,4 @@
        • < 0: Failure. See for details and resolution suggestions.
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita index a6790a390cc..87ba42b0b4e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudioscenario.dita @@ -42,7 +42,7 @@ scenario - The audio scenarios. Under different audio scenarios, the device uses different volume types. See .
        + The audio scenarios. Under different audio scenarios, the device uses different volume types. See .
        • (0): (Default) Automatic scenario, where the SDK chooses the appropriate audio quality according to the user role and audio route.
        • (3): High-quality audio scenario, where users mainly play music.
        • (5): Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone.
        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita index 3d202c15d3e..2b71401bb50 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita index 6cf9d7e455c..5ae38ecc6b0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita @@ -36,10 +36,10 @@

          Call this method before enabling local camera capture, such as before calling and .

          - <ph>Restrictions</ph> + Restrictions

          To adjust the camera focal length configuration, It is recommended to call first to check the device's focal length capabilities, and then configure based on the query results.

          Due to limitations on some Android devices, even if you set the focal length type according to the results returned in , the settings may not take effect.

          -

          None.

          +

          None.

          Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita index ee0b5f0ba07..a66b7eb569e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita index ac30f02d4a2..81ab19e25cf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposureposition.dita +++ b/en-US/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 @@

          Parameters - + positionXinView The horizontal coordinate of the touchpoint in the view. - + positionYinView The vertical coordinate of the touchpoint in the view. diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita index 095240c51b1..2cb07d28aeb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerafocuspositioninpreview.dita @@ -44,11 +44,11 @@
          Parameters - + positionX The horizontal coordinate of the touchpoint in the view. - + positionY The vertical coordinate of the touchpoint in the view. diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita index b62dd166b0b..76118e6c923 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameratorchon.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita index d208785c657..a8c6ee2cf6e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcamerazoomfactor.dita +++ b/en-US/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 @@ Parameters - factor + factor zoomFactor The camera zoom factor. For devices that do not support ultra-wide-angle, the value ranges from 1.0 to the maximum zoom factor; for devices that support ultra-wide-angle, the value ranges from 0.5 to the maximum zoom factor. You can get the maximum zoom factor supported by the device by calling the method. diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita index 25b547f2e41..0bf3eb6e9f5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita @@ -34,7 +34,7 @@

          By default,the SDK sets the user role as audience. You can call this method to set the user role as host. The user role (roles) determines the users' permissions at the SDK level, including whether they can publish audio and video streams in a channel.

          -

          The difference between this method and is that, the former supports setting the audienceLatencyLevel. audienceLatencyLevel needs to be used together with role to determine the level of service that users can enjoy within their permissions. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. Latency of different levels differ in billing. See .

          +

          The difference between this method and is that, the former supports setting the audienceLatencyLevel. audienceLatencyLevel needs to be used together with role to determine the level of service that users can enjoy within their permissions. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. Latency of different levels differs in billing. See .

          Call timing diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita index 2e5bfb44046..4b305bd25ee 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcloudproxy.dita @@ -33,7 +33,7 @@

          To change the cloud proxy type that has been set, call the () first, and then call the to set the proxyType you want.

            -
          • Agora recommends that you call this method after joining a channel.
          • +
          • Agora recommends that you call this method before joining a channel.
          • When a user is behind a firewall and uses the Force UDP cloud proxy, the services for Media Push and cohosting across channels are not available.
          • When you use the Force TCP cloud proxy, note that an error would occur when calling the method to play online music files in the HTTP protocol. The services for Media Push and cohosting across channels use the cloud proxy with the TCP protocol.
          diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita index baad2290254..9c2cc1170a8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdefaultaudioroutetospeakerphone.dita @@ -45,15 +45,15 @@
          Call timing -

          Call this method before joining a channel. If you need to change the audio route after joining a channel, call .

          +

          Call this method before joining a channel. If you need to change the audio route after joining a channel, call .

          Restrictions

          None.

          Parameters @@ -74,4 +74,4 @@
        • < 0: Failure. See for details and resolution suggestions.
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita index 672bb945a84..c289cdc2ad2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita @@ -33,7 +33,7 @@

      The SDK defaults to enabling low-quality video stream adaptive mode () on the sender side, which means the sender does not actively send low-quality video stream. The receiving end with the role of the host can initiate a low-quality video stream request by calling , and upon receiving the request, the sending end automatically starts sending low-quality stream.

      • If you want to modify this behavior, you can call this method and set mode to (never send low-quality video streams) or (always send low-quality video streams).
      • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

      - The difference and connection between this method and is as follows:
        + The difference and connection between this method and is as follows:
        • When calling this method and setting mode to , it has the same effect as ().
        • When calling this method and setting mode to , it has the same effect as ().
        • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita index ec180be2205..a4d2b511926 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita @@ -44,8 +44,8 @@

      -

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

      - The difference and connection between this method and is as follows:
        +

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

        + The difference and connection between this method and is as follows:
        • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
        • When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
        • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
        • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita index 05eb51bff00..919ee6b18ff 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setenablespeakerphone.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita index 51065ed30b9..8f536b5b392 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita @@ -34,7 +34,7 @@

          Restrictions -

          This method takes effect only after the Agora hybrid cloud solution is deployed. You can contact to get to know more about the Agora hybrid cloud solution.

          +

          This method takes effect only after the Agora hybrid cloud solution is deployed. You can contact to get to know more about the Agora hybrid cloud solution.

          Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita index 6f21e6941ea..d051a310096 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita index 3603ee9b20f..592088ff0fc 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita @@ -53,14 +53,14 @@ Parameters - renderMode + renderMode mode

          The local video display mode. See .

          The local video display mode.

          • (1): Hidden mode. Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
          • (2): Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.
          • -
          • (3): Adaptive mode.
            +
          • (3): Adaptive mode.
            Deprecated:
            This enumerator is deprecated and not recommended for use.
            diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita index c2be738b465..1a6bc2f5323 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setparameters.dita @@ -37,7 +37,7 @@ Parameters - parameters + parameters options Pointer to the set parameters in a JSON string. diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita index 16128db628a..eb91c8cdf16 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setplaybackaudioframebeforemixingparameters.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita index 6cc6a5f2f80..dc534709bfd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype.dita @@ -49,8 +49,8 @@ streamType -

            The default video-stream type. See .

            -

            The default video-stream type:

              +

              The default video-stream type. See .

              +

              The default video-stream type:

              • (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
              • (1): Low-quality stream, that is, a low-resolution and low-bitrate video stream.

              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita index 0638265c3f6..4a82db698d9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita @@ -51,11 +51,11 @@ userId - uid + uid The user ID of the remote user. - renderMode + renderMode mode

              The rendering mode of the remote user view. For details, see .

              @@ -65,7 +65,7 @@
              - mirrorMode + mirrorMode mirror

              The mirror mode of the remote user view. See .

              diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita index 5afdddc02f0..c7911511111 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita @@ -59,8 +59,8 @@ streamType -

              The video stream type, see .

              -

              The video stream type:

                +

                The video stream type, see .

                +

                The video stream type:

                • 0: High-quality video stream.
                • 1: Low-quality video stream.

                diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita index c037d9d19d2..dd6c296a7ef 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremotevideosubscriptionoptions.dita @@ -35,19 +35,12 @@
            Details -

            When a remote user has enabled dual-stream mode, you can call this method to choose the option for subscribing to the video streams sent by the remote user.

            -

            -

              -
            • If you only register one object, the SDK subscribes to the raw video data and encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
            • -
            • If you only register one object, the SDK only subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
            • -
            • If you register one object and one object successively, the SDK subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to ).
            • -
            • If you call this method first with the options parameter set, and then register one or object, you need to call this method again and set the options parameter as described in the above two items to get the desired results.
            • -

            - Agora recommends the following steps:
              -
            1. Set autoSubscribeVideo to when calling to join a channel.
            2. -
            3. Call this method after receiving the callback to set the subscription options for the specified remote user's video stream.
            4. -
            5. Call the method to resume subscribing to the video stream of the specified remote user. If you set encodedFrameOnly to in the previous step, the SDK triggers the callback locally to report the received encoded video frame information.
            6. -
            +

            When a remote user has enabled dual-stream mode, you can call this method to choose the option for subscribing to the video streams sent by the remote user. The default subscription behavior of the SDK for remote video streams depends on the type of registered video observer:

              +
            • If the observer is registered, the default is to subscribe to both raw data and encoded data.
            • +
            • If the observer is registered, the default is to subscribe only to the encoded data.
            • +
            • If both types of observers are registered, the default behavior follows the last registered video observer. For example, if the last registered observer is the observer, the default is to subscribe to both raw data and encoded data.
            • +
            If you want to modify the default behavior, or set different subscription options for different uids, you can call this method to set it. For detailed implementation steps, please refer to .

            +
          Parameters diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita index dda5daa1fd3..5f0ef8a4cc7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita @@ -44,7 +44,7 @@ Parameters - canvas + canvas remote

          The remote video view and settings. See .

          diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita index 275ca568fbb..4bb596d551b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita @@ -41,7 +41,7 @@
          Restrictions
            -
          • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, and the mirroring settings fail.
          • +
          • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, and the mirroring settings fail.
          • The config specified in this method is the maximum value under ideal network conditions. If the video engine cannot render the video using the specified config due to unreliable network conditions, the parameters further down the list are considered until a successful configuration is found.
          diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita index 9ffa25cf184..bdd6d71d4a9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita index dae0c085bcb..a9661f22c76 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiomixing2.dita +++ b/en-US/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|IRtcEngine") diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita index c5a8c3e9ef5..820c33d175e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita +++ b/en-US/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; @@ -42,7 +42,7 @@ quality - Audio recording quality. See .

            + Audio recording quality. See .
            • 0: Low quality. The sample rate is 32 kHz, and the file size is around 1.2 MB after 10 minutes of recording.
            • 1: Medium quality. The sample rate is 32 kHz, and the file size is around 2 MB after 10 minutes of recording.
            • 2: High quality. The sample rate is 32 kHz, and the file size is around 3.75 MB after 10 minutes of recording.
            • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index e3ba321ab83..bf45cfd5c7b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -53,7 +53,7 @@ sourceType

              The type of the video source. See .

              -
                +
                • On iOS devices, you can capture video from up to 2 cameras, provided the device has multiple cameras or supports external cameras.
                • On Android devices, you can capture video from up to 4 cameras, provided the device has multiple cameras or supports external cameras.
                • On the desktop platforms, you can capture video from up to 4 cameras.
                • diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita index 6d96033ce6d..2cb050ea915 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startlastmileprobetest.dita @@ -38,7 +38,7 @@
          Call timing
            -
          • If you need to mix the locally collected video streams, you need to call this method after or .
          • +
          • If you need to mix the locally collected video streams, you need to call this method after or .
          • If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in to when calling or .
          @@ -58,6 +58,7 @@
        • On the macOS platform, it supports up to 4 video streams captured by cameras + 1 screen sharing stream.
        • On Android and iOS platforms, it supports video streams captured by up to 2 cameras (the device itself needs to support dual cameras or supports external cameras) + 1 screen sharing stream.
        • On the Android platform, it supports up to 2 video streams captured by cameras (the device itself needs to support dual cameras or support external cameras) + 1 screen sharing stream.
        • +
        • On the HarmonyOS platform, it supports up to 2 video streams captured by cameras (the device itself needs to support dual cameras or support external cameras) + 1 screen sharing stream.
        • On the iOS platform, it supports up to 2 video streams captured by cameras (the device itself needs to support dual cameras or support external cameras) + 1 screen sharing stream.
      • When configuring the local video mixing, it is necessary to ensure that the layer number of the video stream capturing the portrait is greater than the layer number of the screen sharing stream. Otherwise, the portrait will be covered by the screen sharing and will not be displayed in the final mixed video stream.
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita index d3858703eb9..e14191f6abf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startpreview.dita @@ -34,7 +34,7 @@ Restrictions
      • The local preview enables the mirror mode by default.
      • -
      • After leaving the channel, local preview remains enabled. You need to call to disable local preview.
      • +
      • After leaving the channel, local preview remains enabled. You need to call to disable local preview.
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita index bd301db535c..15f828bdc59 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita +++ b/en-US/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|IRtcEngine") diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index f3546e99407..0c67be986c5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/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; @@ -31,7 +31,7 @@

      • This method is for Android and iOS only.
      • -
      • The billing for the screen sharing stream is based on the dimensions in :
          +
        • The billing for the screen sharing stream is based on the dimensions in :
          • When you do not pass in a value, Agora bills you at 1280 × 720.
          • When you pass in a value, Agora bills you at that value.
        @@ -72,8 +72,8 @@ parameters screenCaptureParameters - captureParams - The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See . + captureParams + The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita b/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita index 24678f3b0d6..c86e4d54c87 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita @@ -49,7 +49,6 @@

      Media device states:

      • 0: The device is ready for use.
      • -
      • 1: The device is in use.
      • 3: The device is plugged in.
      • 8: The devive is disconnected.

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita index 64086887c59..4cf22b40cf7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopaudiorecording.dita +++ b/en-US/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|IRtcEngine") diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita index ee455b25258..3a41921ff42 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopeffect.dita +++ b/en-US/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; @@ -28,11 +28,11 @@

      -

      When you no longer need to play the audio effect, you can call this method to stop the playback. If you only need to pause the playback, call .

      +

      When you no longer need to play the audio effect, you can call this method to stop the playback. If you only need to pause the playback, call .

      Call timing -

      Call this method after .

      +

      Call this method after .

      Call this method after the , or .

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita index deb5e9f62d2..6b4deac0f81 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_stopscreencapture.dita @@ -34,7 +34,7 @@ Applicable scenarios

      If you start screen capture by calling , , or , you need to call this method to stop screen capture.

      If you start screen capture by calling , , or , you need to call this method to stop screen capture.

      -

      If you start screen capture by calling , you need to call this method to stop screen capture.

      +

      If you start screen capture by calling , you need to call this method to stop screen capture.

      If you start screen capture by calling or , you need to call this method to stop screen capture.

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita index b3ffdc87e69..bb546860460 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_takesnapshot.dita @@ -60,6 +60,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

    Ensure that the path you specify exists and is writable. diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita index ef39cef47f7..1f049f9e0fa 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatechannelmediaoptions.dita @@ -29,7 +29,7 @@ Parameters - options + options mediaOptions The channel media options. See . diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita index 5006b7a96b3..98008c024cd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita +++ b/en-US/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|IRtcEngine") @@ -45,7 +45,7 @@ screenCaptureParameters captureParams - The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .The video properties of the screen sharing stream only need to be set through this parameter, and are unrelated to . + The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .The video properties of the screen sharing stream only need to be set through this parameter, and are unrelated to .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita index 60c8c0c345e..5be14ba77bf 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_adjustuserplaybacksignalvolumeex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita index 70f210def55..0a3722cf852 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita index 90897baccaa..2c39cc9bdca 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita @@ -35,7 +35,7 @@

    -

    Compared to , this method does not guarantee the reliability of data transmission. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.

    +

    Compared to , this method does not guarantee the reliability of data transmission. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.

    Call timing diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita index 813c4c432de..c1fbb651c77 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_enableaudiovolumeindicationex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_getconnectionstateex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_getconnectionstateex.dita index d1d2461806e..80a02ec08a3 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_getconnectionstateex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_getconnectionstateex.dita @@ -26,6 +26,7 @@ Future<ConnectionStateType> getConnectionStateEx(RtcConnection connection);

    +
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index bb62e37db65..c79b576cce0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita @@ -84,9 +84,9 @@ - eventHandler + eventHandler delegate - The callback class of . See . You can get the callback events of multiple channels through the eventHandlerdelegate object passed in this parameter. + The callback class of . See . You can get the callback events of multiple channels through the eventHandlerdelegate object passed in this parameter. diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita index 5728d019b0a..3b7dcfd2ca8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_leavechannelex2.dita @@ -36,13 +36,13 @@

    After calling this method, the SDK terminates the audio and video interaction, leaves the current channel, and releases all resources related to the session.

    -

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

    -

    After calling to join a channel, you must call this method to end the call, otherwise, the next call cannot be started.

    +

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

    +

    After calling to join a channel, you must call this method to end the call, otherwise, the next call cannot be started.

    • This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
    • -
    • If you call or , you will leave all the channels you have joined by calling , , or .
    • -
    • If you call , you will leave all the channels you have joined by calling or .
    • +
    • If you call or , you will leave all the channels you have joined by calling , , or .
    • +
    • If you call , you will leave all the channels you have joined by calling or .
    diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita index e37793cf33a..94fb09abba2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita index 308cfc12ca8..be188984c4c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremotevideostreamsex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita index 8eac22aaec8..9313c999870 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalaudiostreamex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita index eeb1f3054fe..e3b65e1624c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_mutelocalvideostreamex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita index 80a5f0b4c5d..d352053250b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremoteaudiostreamex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita index cce88870313..70ca8f88127 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteremotevideostreamex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita index 6bd5b69a4b1..8f99bf9e33d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_sendstreammessageex.dita +++ b/en-US/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|IRtcEngine") diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 7402a9fe07b..38c489d4b6f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/en-US/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; @@ -52,7 +52,7 @@

    The SDK defaults to enabling low-quality video stream adaptive mode () on the sender side, which means the sender does not actively send low-quality video stream. The receiving end with the role of the host can initiate a low-quality video stream request by calling , and upon receiving the request, the sending end automatically starts sending low-quality stream.

    • If you want to modify this behavior, you can call this method and set mode to (never send low-quality video streams) or (always send low-quality video streams).
    • If you want to restore the default behavior after making changes, you can call this method again with mode set to .

    - The difference and connection between this method and is as follows:
      + The difference and connection between this method and is as follows:
      • When calling this method and setting mode to , it has the same effect as ().
      • When calling this method and setting mode to , it has the same effect as ().
      • Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita index 8f0ad20a08a..d94d4cbf565 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremoterendermodeex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita index 75d3c6f124d..0f7a34a72ad 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideostreamtypeex.dita +++ b/en-US/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:)); @@ -49,7 +49,7 @@

        -
      • If the publisher has already called and set mode to (never send low-quality video stream), calling this method will not take effect, you should call again on the sending end and adjust the settings.
      • +
      • If the publisher has already called and set mode to (never send low-quality video stream), calling this method will not take effect, you should call again on the sending end and adjust the settings.
      • Calling this method on the receiving end of the audience role will not take effect.
      diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita index 7c368097b74..02b483d68f7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita @@ -51,7 +51,7 @@ remote - canvas + canvas

      The remote video view settings. See .

      diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index 753248ce3ea..1ce68b688b2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/en-US/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|IRtcEngine") diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita index d68bf96bd89..fb275c08d64 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_takesnapshotex.dita +++ b/en-US/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|IRtcEngine") diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita index cd5c768bfc8..d78d089850b 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita index 53b4441e582..9a048f52678 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita index d18fa029d42..c393c0ea4d6 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita +++ b/en-US/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; @@ -43,11 +43,15 @@

      Parameters - - userAudioSpectrumInfos + + data + The audio spectrum information of the remote user. See . The number of arrays is the number of remote users monitored by the SDK. If the array is null, it means that no audio spectrum of remote users is detected. + + + userAudioSpectrumInfos AudioSpectrumInfo spectrums - The audio spectrum information of the remote user, see . The number of arrays is the number of remote users monitored by the SDK. If the array is null, it means that no audio spectrum of remote users is detected. + The audio spectrum information of the remote user. See . The number of arrays is the number of remote users monitored by the SDK. If the array is null, it means that no audio spectrum of remote users is detected. spectrumNumber diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onaudiovolumeindication.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onaudiovolumeindication.dita index 95b7be21b01..10175967fe0 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onaudiovolumeindication.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita index 368dc306a7d..e60c3556a69 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita index ea3ec3afdc4..1c2cfb7f347 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplaybufferupdated.dita +++ b/en-US/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; @@ -30,8 +30,8 @@

      When playing online media resources, the SDK triggers this callback every two seconds to report the playback duration that the currently buffered data can support.

        -
      • When the playback duration supported by the buffered data is less than the threshold (0 by default), the SDK returns .
      • -
      • When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns .
      • +
      • When the playback duration supported by the buffered data is less than the threshold (0 by default), the SDK returns (6).
      • +
      • When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns (7).

      diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayercachestats.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayercachestats.dita index 16df2ae6063..f0d286d8f8d 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayercachestats.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita index 3f3b4ff990e..2f5fef7fa9f 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita +++ b/en-US/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:number,message:string) => void (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didOccurEvent:(AgoraMediaPlayerEvent)eventCode elapsedTime:(NSInteger)elapsedTime diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerinfoupdated.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerinfoupdated.dita index a361cf88893..55b91a31a6c 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerinfoupdated.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita index a3eb3eb2f6b..2c3e115e291 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerplaybackstats.dita +++ b/en-US/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; @@ -42,7 +42,7 @@ Parameters - stats + stats info The statistics of the media file. See . diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita index 7d792b559df..867f6b7121d 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersrcinfochanged.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersrcinfochanged.dita index 0c6b6606490..30dc0992bdf 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersrcinfochanged.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita index b537415e827..59e26c62862 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita @@ -14,7 +14,7 @@

      void onPositionChanged(long positionMs, long timestampMs); - + 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/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita index 1c5f457ea7e..20427f7059e 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onlyricresult.dita b/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onlyricresult.dita index 9f6de69cc94..8b446dee886 100644 --- a/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onlyricresult.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita b/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita index 2e621b16ee0..645c370dd9d 100644 --- a/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusicchartsresult.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita b/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita index 4d0a505f73b..ed8ad261bf4 100644 --- a/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onmusiccollectionresult.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita b/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita index 69683bbacbf..67e6cf127c9 100644 --- a/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onpreloadevent.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onsongsimpleinforesult.dita b/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onsongsimpleinforesult.dita index 2e5b1e6e6df..557286b13e3 100644 --- a/en-US/dita/RTC-NG/API/callback_imusiccontentcentereventhandler_onsongsimpleinforesult.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioeffectfinished.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioeffectfinished.dita index db323003c6a..cc73f8d204b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioeffectfinished.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita index 7f9c83faef6..3e8bd51e6c8 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita +++ b/en-US/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) { @@ -43,7 +43,7 @@ reasonCode:(AgoraAudioMixingReasonCode)reasonCode; state - The playback state of the music file. See .

      + The playback state of the music file. See .

      • (710): The music file is playing.
      • (711): The music file pauses playing.
      • @@ -56,8 +56,8 @@ reasonCode:(AgoraAudioMixingReasonCode)reasonCode; reasonCode - reason - Error code. See .

        + reason + Error code. See .

        • (0): No error.
        • (701): The SDK cannot open the music file.
        • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita index 8faf49f2eef..a8602418801 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita +++ b/en-US/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 @@ -61,7 +61,7 @@ elapseSinceLastState:(int)elapseSinceLastState; - channel + channel channelId The channel name. @@ -79,4 +79,4 @@ elapseSinceLastState:(int)elapseSinceLastState;

      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita index bf9107cce63..4eef2bce802 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita +++ b/en-US/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 @@ -67,7 +67,7 @@ elapseSinceLastState:(int)elapseSinceLastState; - channel + channel channelId The channel name. @@ -77,8 +77,8 @@ elapseSinceLastState:(int)elapseSinceLastState; oldState - The previous subscribing status. See . - The previous subscription status.

        + The previous subscribing status. See . + The previous subscription status.
        • (0): The initial subscribing state after joining the channel.
        • (1): Fails to subscribe to the remote stream. Possible reasons:
          • The remote user:
              @@ -98,8 +98,8 @@ elapseSinceLastState:(int)elapseSinceLastState; newState - The current subscribing status. See . - The current subscribing status.
                + The current subscribing status. See . + The current subscribing status.
                • (0): The initial subscribing state after joining the channel.
                • (1): Fails to subscribe to the remote stream. Possible reasons:
                  • The remote user:
                      @@ -123,4 +123,4 @@ elapseSinceLastState:(int)elapseSinceLastState;
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita index e3a53bb435f..60a61dab1bf 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita +++ b/en-US/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; @@ -61,9 +61,9 @@ - + rect - The focus rectangle in the local preview. See . + The focus rectangle in the local preview. See .

      diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita index 2694e80421a..34fe126fb10 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita +++ b/en-US/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; @@ -68,6 +68,17 @@ -

      + + + + point + The focus point within the camera frame. + + + + + + +
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita index f97242e8716..91f31e9ab68 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita +++ b/en-US/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; @@ -49,7 +49,7 @@ channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state state -

      The state code. See .

      +

      The state code. See .

      The state code:

      • (0): The SDK is initializing.
      • (1): The SDK tries to relay the media stream to the destination channel.
      • @@ -61,7 +61,7 @@ channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state code -

        The error code of the channel media relay. See .

        +

        The error code of the channel media relay. See .

        The error code of the channel media relay.

        • (0): Everything is normal.
        • (1): An error occurs in the server response.
        • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita index 4ca3440040a..09d8023b7b9 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita @@ -39,18 +39,21 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));

      +
      +
      Trigger timing -

      This callback will be triggered in any of the following situations:

        +

        This callback will be triggered in any of the following situations:

        • Calling or to set the user role or audience latency level after joining a channel
        • Calling or and set the user role to AUDIENCE before joining a channel.

        -

        This callback will be triggered in any of the following situations:

          +

          This callback will be triggered in any of the following situations:

          • Calling to set the user role or audience latency level after joining a channel.
          • Calling to set the user role to AUDIENCE before joining a channel.

      Restrictions -

      This callback will not be triggered when you call or and set the user role to BROADCASTER before joining a channel.

      +

      This callback will not be triggered when you call or and set the user role to BROADCASTER before joining a channel.

      +

      This callback will not be triggered when you call and set the user role to BROADCASTER before joining a channel.

      <ph keyref="callback-section-title"/> @@ -65,13 +68,13 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:)); oldRole - Role that the user switches from: .
        + Role that the user switches from: .
        newRole - Role that the user switches to: .
          + Role that the user switches to: .
          diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita index 169b4493683..ed0dc58d144 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita @@ -44,8 +44,8 @@
      Trigger timing -

      The SDK triggers this callback when the local user calls or after joining a channel to switch the user role but the switching fails.

      -

      The SDK triggers this callback when the local user calls after joining a channel to switch the user role but the switching fails.

      +

      The SDK triggers this callback when the local user calls or after joining a channel to switch the user role but the switching fails.

      +

      The SDK triggers this callback when the local user calls after joining a channel to switch the user role but the switching fails.

      Restrictions @@ -74,8 +74,8 @@ currentRole - Current user role. See . - Current user role.
        + Current user role. See . + Current user role.
        • (1): Host. A host can both send and receive streams.
        • (2): Audience. An audience member can only receive streams.
        @@ -86,4 +86,4 @@
      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita index 6ee935f8e56..123ad62ab8a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita @@ -56,20 +56,20 @@ state -

      The current connection state. See .

      -
        +

        The current connection state. See .

        +
        • (1): The SDK is disconnected from Agora's edge server.
        • (2): The SDK is connecting to Agora's edge server.
        • (3): The SDK is connected to Agora's edge server.
        • -
        • (4): The SDK keeps reconnecting to the Agora edge server.
        • +
        • (4): The SDK tries to reconnect to the Agora edge server.
        • (5): The SDK fails to connect to Agora's edge server.
        reason -

        The reason for a connection state change. See .

        -

        +

        The reason for a connection state change. See .

        +

        • (0): The SDK is connecting to Agora's edge server.
        • (1): The SDK has joined the channel successfully.
        • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita index a8174173f0b..af8a0df8f4d 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita @@ -50,11 +50,11 @@ connection The connection information. See . - + errorType Details about the error type. See . - + errorType Error types.
          • (0): Internal reasons.
          • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita index 6013ed9ff4d..bd73d8c98d1 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita +++ b/en-US/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) { @@ -41,17 +41,17 @@ - + errorCode - err + err Error code. See . msg The error message. - - err + + err error Error code. @@ -62,11 +62,11 @@

          • (3): The SDK is not ready. Possible reasons include the following:
            • The initialization of fails. Reinitialize the .
            • No user has joined the channel when the method is called. Please check your code logic.
            • -
            • The user has not left the channel when the or method is called. Please check your code logic.
            • +
            • The user has not left the channel when the or method is called. Please check your code logic.
            • The audio module is disabled. The program is not complete.
          • (4): does not support the request. Possible reasons include the following:
              -
            • The method is called on devices running versions earlier than Android 5.0. Check the Android version.
            • +
            • The method is called on devices running versions earlier than Android 5.0. Check the Android version.
            • The built-in encryption mode is incorrect, or the SDK fails to load the external encryption library. Check the encryption mode setting, or reload the external encryption library.
          • (5): The request is rejected. Possible reasons include the following:
              @@ -81,7 +81,7 @@
            • (10): A timeout occurs. Some API calls require the SDK to return the execution result. This error occurs if the SDK takes too long (more than 10 seconds) to return the result.
            • (17): The request to join the channel is rejected. Possible reasons include the following:
              • The user is already in the channel. Agora recommends that you use the callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the (1) state.
              • -
              • After calling for the call test, the user tries to join the channel without calling to end the current test. To join a channel, the call test must be ended by calling .
              • +
              • After calling for the call test, the user tries to join the channel without calling to end the current test. To join a channel, the call test must be ended by calling .
            • (18): Fails to leave the channel. Possible reasons include the following:
              • The user has left the channel before calling the method. Stop calling this method to clear this error.
              • @@ -104,7 +104,7 @@
              • App Certificate is enabled in Agora Console, but the code still uses App ID for authentication. Once App Certificate is enabled for a project, you must use token-based authentication.
              • The uid used to generate the token is not the same as the uid used to join the channel.
              -
              +
              Deprecated:
              This enumerator is deprecated. Use (8) in the callback instead.
              diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita index 1c8926bc953..77b69c5fb00 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita @@ -70,12 +70,12 @@ - imageWidth + imageWidth width The width (px) of the video image captured by the local camera. - imageHeight + imageHeight height The height (px) of the video image captured by the local camera. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita index 2e5955bf138..21d67ff6c8f 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita +++ b/en-US/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 @@ -67,11 +67,11 @@ size The size of the first local video frame. - + width The width (px) of the first local video frame. - + height The height (px) of the first local video frame. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita index 5c2b9f24eb2..a24e974b9b1 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita +++ b/en-US/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) { @@ -55,7 +55,7 @@ - uid + uid remoteUid userId The user ID of the remote user sending the video stream. @@ -68,11 +68,11 @@ connection The connection information. See . - + width The width (px) of the video stream. - + height The height (px) of the video stream. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita index 73a085b7928..02f438b90fe 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita index da181d26958..06924d5ea30 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita @@ -40,7 +40,7 @@ quality - The last-mile network quality. See .

                + The last-mile network quality. See .
                diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita index 85acf839977..a4662f68b4d 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita @@ -33,8 +33,8 @@
              Trigger timing -

              The SDK triggers this callback after you call , , , or to leave a channel.

              -

              The SDK triggers this callback after you call or to leave a channel.

              +

              The SDK triggers this callback after you call , , , or to leave a channel.

              +

              The SDK triggers this callback after you call or to leave a channel.

              Restrictions diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita index e4c14478930..e957166a80c 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita @@ -53,8 +53,8 @@ state - The state of the local audio. See . - The state of the local audio.
                + The state of the local audio. See . + The state of the local audio.
                • (0): The local video is in the initial state.
                • (1): The local video capturing device starts successfully.
                • (2): The first video frame is successfully encoded.
                • @@ -63,8 +63,8 @@ reason - Reasons for local audio state changes. See . - Reasons for local audio state changes.
                    + Reasons for local audio state changes. See . + Reasons for local audio state changes.
                    • (0): The local video is normal.
                    • (1): No specified reason for the local audio failure. Remind your users to try to rejoin the channel.
                    • (2): No permission to use the local video capturing device. Remind your users to grant permission.
                    • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita index cc0e31fbdc3..54913cf300f 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita +++ b/en-US/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) { @@ -69,14 +69,14 @@ sourceType - source + source The type of the video source. See . state -

                      The state of the local video, see .

                      -

                      +

                      The state of the local video, see .

                      +

                      • (0): The local video is in the initial state.
                      • (1): The local video capturing device starts successfully.
                      • @@ -88,8 +88,8 @@ reason -

                        The reasons for changes in local video state. See .

                        -

                        +

                        The reasons for changes in local video state. See .

                        +

                        • (0): The local video is normal.
                        • (1): No specified reason for the local video failure.
                        • @@ -99,7 +99,7 @@
                        • (8): Fails to find a local video capture device. Remind the user to check whether the camera is connected to the device properly or the camera is working properly, and then to rejoin the channel.
                        • (14): Video capture is interrupted. Possible reasons include the following:
                          • The camera is being used by another app. Prompt the user to check if the camera is being used by another app.
                          • -
                          • The current app has been switched to the background. You can use foreground services to notify the operating system and ensure that the app can still collect video when it switches to the background. See .
                          • +
                          • The device is locked, or the current app has been switched to the background. You can use foreground services to notify the operating system and ensure that the app can still collect video when it switches to the background. See .
                        • (15): The video capture device encounters an error. Prompt the user to close and restart the camera to restore functionality. If this operation does not solve the problem, check if the camera has a hardware failure.

                        diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita index 8fcb75861a0..710f36c7266 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita +++ b/en-US/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){ @@ -55,10 +55,10 @@ The video streams that cannot be mixed during video mixing. See . - error + error errorCode - The reason for local video mixing error. See . - The reason for local video mixing error:

                          + The reason for local video mixing error. See . + The reason for local video mixing error:
                          • 1: The selected video source has not started video capture. You need to create a video track for it and start video capture.
                          • 2: The video source type is invalid. You need to re-specify the supported video source type.
                          • 3: The image path is invalid. You need to re-specify the correct image path.
                          • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita index c9695b6f45b..327c62df971 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita @@ -47,7 +47,7 @@

                            This callback reports the last mile network conditions of each user in the channel. Last mile refers to the connection between the local device and Agora's edge server.

                            The SDK triggers this callback once every two seconds. If a channel includes multiple users, the SDK triggers this callback as many times.

                            This callback provides feedback on network quality through sending and receiving broadcast packets within the channel. Excessive broadcast packets can lead to broadcast storms. To prevent broadcast storms from causing a large amount of data transmission within the channel, this callback supports feedback on the network quality of up to 4 remote hosts simultaneously by default.

                            - txQuality is UNKNOWNUnknown when the user is not sending a stream; rxQuality is UNKNOWNUnknown when the user is not receiving a stream.
              + txQuality is UNKNOWNUnknown when the user is not sending a stream; rxQuality is UNKNOWNUnknown when the user is not receiving a stream.
              <ph keyref="callback-section-title" /> @@ -68,13 +68,13 @@ txQuality - Uplink network quality rating of the user in terms of the transmission bit rate, packet loss rate, average RTT (Round-Trip Time) and jitter of the uplink network. This parameter is a quality rating helping you understand how well the current uplink network conditions can support the selected video encoder configuration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 × 480 and a frame rate of 15 fps in the LIVE_BROADCASTING profile, but might be inadequate for resolutions higher than 1280 × 720. See .
                + Uplink network quality rating of the user in terms of the transmission bit rate, packet loss rate, average RTT (Round-Trip Time) and jitter of the uplink network. This parameter is a quality rating helping you understand how well the current uplink network conditions can support the selected video encoder configuration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 × 480 and a frame rate of 15 fps in the LIVE_BROADCASTING profile, but might be inadequate for resolutions higher than 1280 × 720. See .
                rxQuality - Downlink network quality rating of the user in terms of packet loss rate, average RTT, and jitter of the downlink network. See .
                  + Downlink network quality rating of the user in terms of packet loss rate, average RTT, and jitter of the downlink network. See .
                  diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita index 5fb45bcdeb5..f466a39b52c 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita @@ -41,8 +41,8 @@ permission type permissionType - The type of the device permission. See . - The type of the device permission.
                    + The type of the device permission. See . + The type of the device permission.
                    • (0): Permission for the audio capture device.
                    • (1): Permission for the camera.
                    • (2): Permission for screen sharing.
                    • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita index 3cd440b0c7a..d8509427f09 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita +++ b/en-US/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) { @@ -31,6 +31,8 @@ onRejoinChannelSuccess;

                      +
                      +
                      Trigger timing

                      When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection.

                      diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita index 50f0d4f678b..7dab554c89d 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita @@ -72,8 +72,8 @@ state - The state of the remote audio. See . - Remote audio states.
                        + The state of the remote audio. See . + Remote audio states.
                        • (0): The remote audo is in the initial state. The SDK reports this state in the case of , , or .
                        • (1): The first remote audio packet is received.
                        • (2): The remote audio stream is decoded and plays normally. The SDK reports this state in the case of , or .
                        • @@ -83,8 +83,8 @@ reason - The reason of the remote audio state change. See . - Remote audio state reasons.
                            + The reason of the remote audio state change. See . + Remote audio state reasons.
                            • (0): The SDK reports this reason when the audio state changes.
                            • (1): Network congestion.
                            • (2): Network recovery.
                            • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita index d96452ce048..dcd6d035509 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita @@ -72,8 +72,8 @@ state -

                              The state of the remote video. See .

                              -

                              The state of the remote video:

                                +

                                The state of the remote video. See .

                                +

                                The state of the remote video:

                                • (0): The remote video is in the initial state. This state is reported in the case of (3), (5), or (7).
                                • (1): The first remote video packet is received.
                                • (2): The remote video stream is decoded and plays normally. This state is reported in the case of (2), (4), (6), or (9).
                                • @@ -85,8 +85,8 @@ reason -

                                  The reason for the remote video state change. See .

                                  -

                                  Remote audio state reasons:

                                    +

                                    The reason for the remote video state change. See .

                                    +

                                    Remote audio state reasons:

                                    • (0): Internal reasons.
                                    • (1): Network congestion.
                                    • (2): Network recovery.
                                    • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita index ffdd51880e9..8e6dc3bc30b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita index b92381c7d13..178939b46c8 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita @@ -39,8 +39,8 @@ eventCode event - The event code of Media Push. See . - The event code of Media Push.

                                        + The event code of Media Push. See . + The event code of Media Push.
                                        • (1): An error occurs when you add a background image or a watermark image in the Media Push.
                                        • (2): The streaming URL is already being used for Media Push. If you want to start new streaming, use a new streaming URL.
                                        • (3): The feature is not supported.
                                        • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita index 96f0ca6f0ff..58ab0ec1897 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita +++ b/en-US/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:)); @@ -59,8 +59,8 @@ state - The current state of the Media Push. See . - The current state of the Media Push:

                                            + The current state of the Media Push. See . + The current state of the Media Push:
                                            • (0): The Media Push has not started or has ended.
                                            • (1): The streaming server and CDN server are being connected.
                                            • (2): The Media Push publishes. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state.
                                            • @@ -74,8 +74,8 @@ reason - Reasons for the changes in the Media Push status. See . - Reasons for the changes in the Media Push status:
                                                + Reasons for the changes in the Media Push status. See . + Reasons for the changes in the Media Push status:
                                                • (0): The Media Push publishes successfully.
                                                • (1): Invalid argument used. Check the parameter setting.
                                                • (2): The Media Push is encrypted and cannot be published.
                                                • @@ -88,7 +88,7 @@
                                                • (9): Agora's server fails to find the media stream of Media Push.
                                                • (10): The format of the media push URL is not supported. Check whether the URL format is correct.
                                                • (11): The user role is not host, so the user cannot use the Media Push function. Check your application code logic.
                                                • -
                                                • (13): The or method is called to update the transcoding configuration in a scenario where there is Media Push without transcoding. Check your application code logic.
                                                • +
                                                • (13): The method is called to update the transcoding configuration in a scenario where there is Media Push without transcoding. Check your application code logic.
                                                • (14): Errors occurred in the host's network.
                                                • (16): Your project does not have permission to use Media Push service. Refer to Media Push to enable the Media Push permission.
                                                • (100): The Media Push has been stopped normally. After you call to stop the Media Push, the SDK returns this value.
                                                • diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita index 68fde6731c5..c604293ec9f 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita @@ -28,16 +28,23 @@ } UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event") void OnStreamMessage(int64 uid, int streamId, const FString& data, int length, int64 sentTs); - onStreamMessage?(connection: RtcConnection, remoteUid: number, streamId: number, data: Uint8Array, length: number, sentTs: number): void; - public virtual void OnStreamMessage(RtcConnection connection, uint remoteUid, int streamId, byte[] data, uint length, UInt64 sentTs) { } + onStreamMessage?( + connection: RtcConnection, + remoteUid: number, + streamId: number, + data: Uint8Array, + length: number, + sentTs: number + ): void; + public virtual void OnStreamMessage(RtcConnection connection, uint remoteUid, int streamId, byte[] data, ulong length, ulong sentTs) { } onStreamMessage?( - connection: RtcConnection, - remoteUid: number, - streamId: number, - data: Uint8Array, - length: number, - sentTs: number -): void; + connection: RtcConnection, + remoteUid: number, + streamId: number, + data: Uint8Array, + length: number, + sentTs: number + ): void; final void Function(RtcConnection connection, int remoteUid, int streamId, Uint8List data, int length, int sentTs)? onStreamMessage;

                                                  @@ -57,7 +64,7 @@ - uid + uid userId remoteUid The ID of the remote user sending the message. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita index 13a77ac772e..affcca08378 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita @@ -67,7 +67,7 @@ The connection information. See . - uid + uid userId remoteUid The ID of the remote user sending the message. @@ -78,8 +78,8 @@ code - error - The error code. See . + error + Error code. See . missed diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita index 5ac52ce57a5..d16dc7e4c38 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita index c1018791488..ad8363af645 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita +++ b/en-US/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 @@ -78,4 +78,4 @@

                                                  - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita index f2923fdb16f..018f03521d7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita index 5f9ad181668..14a4b3165a0 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita index a7b43322b45..807bdf63ea8 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita @@ -70,11 +70,11 @@ size Video dimensions. - + width The width (pixels) of the video stream. - + height The height (pixels) of the video stream. diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita index 445feb751be..05df9d98ffe 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosubscribestatechanged.dita +++ b/en-US/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 @@ -78,8 +78,8 @@ oldState - The previous subscribing status. See . - The previous subscription status.

                                                    + The previous subscribing status. See . + The previous subscription status.
                                                    • (0): The initial subscribing state after joining the channel.
                                                    • (1): Fails to subscribe to the remote stream. Possible reasons:
                                                      • The remote user:
                                                          @@ -99,8 +99,8 @@ newState - The current subscribing status. See . - The current subscribing status.
                                                            + The current subscribing status. See . + The current subscribing status.
                                                            • (0): The initial subscribing state after joining the channel.
                                                            • (1): Fails to subscribe to the remote stream. Possible reasons:
                                                              • The remote user:
                                                                  @@ -124,4 +124,4 @@
                                                  - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita index d4fcaec3e12..bb42c41a609 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita @@ -27,7 +27,10 @@

                                                  If the video data you want to obtain is a mirror image of the original video, you need to register this callback when calling . After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. You need to set whether or not to mirror the video frame in the return value of this callback.

                                                    -
                                                  • This function only supports video data in RGBA and YUV420.
                                                  • +
                                                  • On the Android platform, the supported video data formats for this callback are: I420, RGBA, and Texture.
                                                  • +
                                                  • On the Windows platform, the supported video data formats for this callback are: I420, RGBA, and TextureBuffer.
                                                  • +
                                                  • On the iOS platform, the supported video data formats for this callback are: I420, RGBA, and CVPixelBuffer.
                                                  • +
                                                  • On the macOS platform, the supported video data formats for this callback are: I420 and RGBA.
                                                  • Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, and the mirroring settings fail.
                                                  diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita index 7a4ef1f9366..7accb677bc1 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita @@ -28,8 +28,10 @@

                                                  If the video has been rotated according to rotation in on the capture device, you do not need to call this method to set the video rotation.

                                                    -
                                                  • This function only applies to the scenarios where the video processing mode is .
                                                  • -
                                                  • This function only supports video data in RGBA and YUV420.
                                                  • +
                                                  • On the Android platform, the supported video data formats for this callback are: I420, RGBA, and Texture.
                                                  • +
                                                  • On the Windows platform, the supported video data formats for this callback are: I420, RGBA, and TextureBuffer.
                                                  • +
                                                  • On the iOS platform, the supported video data formats for this callback are: I420, RGBA, and CVPixelBuffer.
                                                  • +
                                                  • On the macOS platform, the supported video data formats for this callback are: I420 and RGBA.
                                                  diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita index 15bff4355fb..a8c760ff7f5 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita @@ -33,7 +33,7 @@

                                                  You can get raw video data collected by the local device through this callback and preprocess it as needed. Once the preprocessing is complete, you can directly modify videoFrame in this callback, and set the return value to to send the modified video data to the SDK.

                                                  -

                                                  If you need to send the preprocessed data to the SDK, you need to call (0) first to set the video processing mode to read and write mode.

                                                  +

                                                  If you need to send the preprocessed data to the SDK, you need to call first to set the video processing mode to read and write mode ().

                                                  You can get raw video data collected by the local device through this callback.

                                                  @@ -49,7 +49,7 @@
                                                  Restrictions
                                                    -
                                                  • The video data you get here is the raw video data, that is, video data that has not undergone preprocessing such as watermarking, cropping, and rotation.
                                                  • +
                                                  • The video data you get here is the raw video data, that is, video data that has not undergone preprocessing such as watermarking, cropping, and rotation.
                                                  • If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
                                                  • It is recommended that you ensure the modified parameters in videoFrame are consistent with the actual situation of the video frames in the video frame buffer. Otherwise, it may cause unexpected rotation, distortion, and other issues in the local preview and remote video display.
                                                  • It's recommended that you implement this callback through the C++ API.
                                                  • diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodevideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodevideoframe.dita index 826ac95d2fa..67dc5ceec3e 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodevideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodevideoframe.dita @@ -35,6 +35,7 @@

                                                    After processing, you can send the processed video data back to the SDK in this callback.

                                                      +
                                                    • If you need to send the preprocessed data to the SDK, you need to call first to set the video processing mode to read and write mode ().
                                                    • To get the video data captured from the second screen before encoding, you need to set (1 << 2) as a frame position through .
                                                    • To get the video data captured from the second screen before encoding, you need to set (1 << 2) as a frame position through the position parameter of the method.
                                                    • It's recommended that you implement this callback through the C++ API.
                                                    • diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita index 18cd010edd4..abf0d59863c 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita @@ -39,6 +39,7 @@

                                                      After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. In this callback, you can get the video data sent from the remote end before rendering, and then process it according to the particular scenarios.

                                                        +
                                                      • If you need to send the preprocessed data to the SDK, you need to call first to set the video processing mode to read and write mode ().
                                                      • If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
                                                      • It's recommended that you implement this callback through the C++ API.
                                                      • Due to framework limitations, this callback does not support sending processed video data back to the SDK.
                                                      • diff --git a/en-US/dita/RTC-NG/API/class_advanceoptions.dita b/en-US/dita/RTC-NG/API/class_advanceoptions.dita index c2311788d56..dbf7bd0e25c 100644 --- a/en-US/dita/RTC-NG/API/class_advanceoptions.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita index 2a2610db9aa..44887c4bbb9 100644 --- a/en-US/dita/RTC-NG/API/class_audioparams.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_audiospectrumdata.dita b/en-US/dita/RTC-NG/API/class_audiospectrumdata.dita index 36225f86763..72afb7170d1 100644 --- a/en-US/dita/RTC-NG/API/class_audiospectrumdata.dita +++ b/en-US/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; @@ -69,7 +72,7 @@ struct FAudioSpectrumData {

                                                        The audio spectrum data. Agora divides the audio frequency into 256 frequency domains, and reports the energy value of each frequency domain through this parameter. The value range of each energy type is [-300, 1] and the unit is dBFS.

                                                        - + dataLength The audio spectrum data length is 256. diff --git a/en-US/dita/RTC-NG/API/class_cachestatistics.dita b/en-US/dita/RTC-NG/API/class_cachestatistics.dita index cbab42329af..a935b0fc071 100644 --- a/en-US/dita/RTC-NG/API/class_cachestatistics.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index 0ec7fb61dce..271a1008927 100644 --- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita +++ b/en-US/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 (Optional) The camera direction. See .This parameter is for Android and iOS only. @@ -386,7 +386,7 @@ class CameraCapturerConfiguration { followEncodeDimensionRatio (Optional) Whether to follow the video aspect ratio set in :
                                                          -
                                                        • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
                                                        • +
                                                        • : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
                                                        • : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
                                                        diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita index 832882cf544..b9ab3cbb782 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita @@ -84,6 +84,8 @@ public audioDelayMs?:number; public mediaPlayerAudioDelayMs?:number; + + public token?:string; public enableBuiltInMediaEncryption?:boolean; @@ -731,67 +733,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 enableBuiltInMediaEncryption?:boolean; - - public publishRhythmPlayerTrack?:boolean; - - public isInteractiveAudience?:boolean; - - public customVideoTrackId?:number; - - public isAudioFilterable?:boolean; - - public startPreview?:boolean; - public constructor() { - } - } + + 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() { + } +}
                                                        __attribute__((visibility("default"))) @interface AgoraRtcChannelMediaOptions : NSObject @property(assign, nonatomic) BOOL publishCameraTrack; @property(assign, nonatomic) BOOL publishSecondaryCameraTrack; @@ -1494,7 +1496,7 @@ public: This is for Windows and macOS only. - + publishScreenCaptureVideo

                                                        Whether to publish the video captured from the screen:

                                                          @@ -1504,7 +1506,7 @@ public: This parameter is for Android and iOS only. As of v4.0.0, the parameter name is changed from publishScreenTrack to publishScreenCaptureVideo. - + publishScreenCaptureAudio

                                                          Whether to publish the audio captured from the screen:

                                                            @@ -1576,8 +1578,7 @@ public: publishCustomAudioTrackId - The ID of the custom audio source to publish. The default value is 0.

                                                            If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.

                                                            -
                                                            + The ID of the custom audio track to be published. The default value is 0. You can obtain the custom audio track ID through the method.
                                                            publishCustomVideoTrack diff --git a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita index d1e37e14d4b..0d6d9b08dd3 100644 --- a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita @@ -153,20 +153,20 @@ public: setSrcChannelInfo Sets the information of the source channel. See . - + setDestChannelInfo Sets the information of the target channel. See . - - removeDestChannelInfo + + removeDestChannelInfo removeDestinationInfoForChannelName Deletes the information of target channel. See . - + getSrcChannelMediaInfo Gets the information of the source channel. See . - + getDestChannelMediaInfos Gets the information of the target channel. See . @@ -176,7 +176,7 @@ public: <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - srcInfo + srcInfo sourceInfo

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

                                                              @@ -190,7 +190,7 @@ public: - destInfos + destInfos destinationInfos

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

                                                                diff --git a/en-US/dita/RTC-NG/API/class_clientroleoptions.dita b/en-US/dita/RTC-NG/API/class_clientroleoptions.dita index 934b5559e83..c8e3fccccff 100644 --- a/en-US/dita/RTC-NG/API/class_clientroleoptions.dita +++ b/en-US/dita/RTC-NG/API/class_clientroleoptions.dita @@ -80,7 +80,7 @@ public: audienceLatencyLevel - The latency level of an audience member in interactive live streaming. See .
                                                                  + The latency level of an audience member in interactive live streaming. See .
                                                                  • (1): Low latency.
                                                                  • (2): (Default) Ultra low latency.
                                                                  diff --git a/en-US/dita/RTC-NG/API/class_climaxsegment.dita b/en-US/dita/RTC-NG/API/class_climaxsegment.dita index 95963c6d407..5c7ff264eb7 100644 --- a/en-US/dita/RTC-NG/API/class_climaxsegment.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita index 67d968f15af..097469cf022 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita +++ b/en-US/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; @@ -159,7 +169,7 @@ class ContentInspectConfig {
                                                                  Parameters - + CONTENT_INSPECT_TYPE_INVALID 0: (Default) No actual function. Do not set type to this value. @@ -167,11 +177,11 @@ class ContentInspectConfig { CONTENT_INSPECT_TYPE_MODERATION 1: Video content moderation. The SDK takes screenshots and inspect videos sent by local users, and uploads the screenshots and moderation results. - + CONTENT_INSPECT_TYPE_SUPERVISE 2: Video screenshot and upload via Agora self-developed extension. The SDK takes screenshots of videos sent by local users and upload them. - + CONTENT_INSPECT_TYPE_IMAGE_MODERATION 3: Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them. diff --git a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita index 23604f684ca..18e8b968e1e 100644 --- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita +++ b/en-US/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; @@ -91,8 +96,8 @@ public: type - Types of functional module. See . - + Types of functional module. See . +

                                                                  Types of functional modules:

                                                                  • (0): (Default) This module has no actual function. Do not set to this value.
                                                                  • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
                                                                  • diff --git a/en-US/dita/RTC-NG/API/class_encryptionconfig.dita b/en-US/dita/RTC-NG/API/class_encryptionconfig.dita index 3629200181b..c397ee3ca5e 100644 --- a/en-US/dita/RTC-NG/API/class_encryptionconfig.dita +++ b/en-US/dita/RTC-NG/API/class_encryptionconfig.dita @@ -169,7 +169,7 @@ class EncryptionConfig { This parameter takes effect only in or encrypted mode. In this case, ensure that this parameter is not 0. - + datastreamEncryptionEnabled Whether to enable data stream encryption:
                                                                    • : Enable data stream encryption.
                                                                    • diff --git a/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita b/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita index c206aa61300..486968d3a2d 100644 --- a/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita +++ b/en-US/dita/RTC-NG/API/class_lastmileproberesult.dita @@ -144,10 +144,10 @@ public: state

                                                                      The status of the last-mile network tests. See .

                                                                      -

                                                                      The status of the last-mile network tests, which includes:

                                                                        +

                                                                        The status of the last-mile network test, which includes:

                                                                        • (1): The last-mile network probe test is complete.
                                                                        • -
                                                                        • (2): The last-mile network probe test is incomplete because the bandwidth estimation is not available due to limited test resources. Probably due to limited test resources.
                                                                        • -
                                                                        • (3): The last-mile network probe test is not carried out. Probably due to poor network conditions.
                                                                        • +
                                                                        • (2): The last-mile network probe test is incomplete because bandwidth prediction is not conducted. One possible reason is that testing resources were temporarily limited.
                                                                        • +
                                                                        • (3): The last-mile network probe test is not conducted. Probably due to poor network conditions.

                                                                        diff --git a/en-US/dita/RTC-NG/API/class_livestreamadvancedfeature.dita b/en-US/dita/RTC-NG/API/class_livestreamadvancedfeature.dita index 570391983b9..1a988e72ef0 100644 --- a/en-US/dita/RTC-NG/API/class_livestreamadvancedfeature.dita +++ b/en-US/dita/RTC-NG/API/class_livestreamadvancedfeature.dita @@ -85,7 +85,7 @@ public:

                                                                  -

                                                                  If you want to enable the advanced features of streaming with transcoding, contact .

                                                                  +

                                                                  If you want to enable the advanced features of streaming with transcoding, contact .

                                                                  <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_localvideostats.dita b/en-US/dita/RTC-NG/API/class_localvideostats.dita index 079b921e1e7..0a0ba4771c4 100644 --- a/en-US/dita/RTC-NG/API/class_localvideostats.dita +++ b/en-US/dita/RTC-NG/API/class_localvideostats.dita @@ -545,7 +545,7 @@ public: codecType - The codec type of the local video. See .

                                                                  + The codec type of the local video. See .

                                                                  • (1): VP8.
                                                                  • (2): H.264.
                                                                  • diff --git a/en-US/dita/RTC-NG/API/class_logconfig.dita b/en-US/dita/RTC-NG/API/class_logconfig.dita index d3ca4b6bcf4..7c324f61f10 100644 --- a/en-US/dita/RTC-NG/API/class_logconfig.dita +++ b/en-US/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; @@ -118,7 +125,7 @@ public:
                                                                • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log.

                                                                -

                                                                The default path is /storage/emulated/0/Android/data/<packagename>/files/agorasdk.log.

                                                                +

                                                                The default path is /storage/emulated/0/Android/data/<packagename>/files/agorasdk.log.

                                                                The default path is AppSandbox/Library/caches/agorasdk.log.

                                                                The default log directory is:

                                                                • If Sandbox is enabled: AppSandbox/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.
                                                                • diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita index 85084d5b4d2..713c648f64a 100644 --- a/en-US/dita/RTC-NG/API/class_mediasource.dita +++ b/en-US/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; @@ -194,7 +212,7 @@ public: url

                                                                  The URL of the media file to be played.

                                                                  - +

                                                                  If you open a common media resource, pass in the value to url. If you open a custom media resource, pass in the value to playerOnReadCallback and playerOnSeekCallback. Agora recommends that you do not pass in values to all these parameters in one call; otherwise, this call may fail.

                                                                  If you open a common media resource, pass in the value to url. If you open a custom media resource, pass in the value to provider. Agora recommends that you do not pass in values to both parameters in one call; otherwise, this call may fail.

                                                                  diff --git a/en-US/dita/RTC-NG/API/class_music.dita b/en-US/dita/RTC-NG/API/class_music.dita index 35cc497ddc6..6455a8bc5c4 100644 --- a/en-US/dita/RTC-NG/API/class_music.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_musiccacheinfo.dita b/en-US/dita/RTC-NG/API/class_musiccacheinfo.dita index eb71c715c3c..0dd394ae316 100644 --- a/en-US/dita/RTC-NG/API/class_musiccacheinfo.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita b/en-US/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita index 03e016f62c6..b44354be4da 100644 --- a/en-US/dita/RTC-NG/API/class_musiccontentcenterconfiguration.dita +++ b/en-US/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 = 10 + + 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/en-US/dita/RTC-NG/API/class_playerplaybackstats.dita b/en-US/dita/RTC-NG/API/class_playerplaybackstats.dita index f9177d14e17..bfae51a8133 100644 --- a/en-US/dita/RTC-NG/API/class_playerplaybackstats.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_playerstreaminfo.dita b/en-US/dita/RTC-NG/API/class_playerstreaminfo.dita index 184c77b360f..022d3b4c653 100644 --- a/en-US/dita/RTC-NG/API/class_playerstreaminfo.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_playerupdatedinfo.dita b/en-US/dita/RTC-NG/API/class_playerupdatedinfo.dita index 750c29358b4..8e03f7c9e31 100644 --- a/en-US/dita/RTC-NG/API/class_playerupdatedinfo.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_recorderinfo.dita b/en-US/dita/RTC-NG/API/class_recorderinfo.dita index e7e94c29c7d..a94fecd0e34 100644 --- a/en-US/dita/RTC-NG/API/class_recorderinfo.dita +++ b/en-US/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 The absolute path of the recording file. @@ -110,4 +110,4 @@ struct FRecorderInfo {
                                                  - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita index ac8803463eb..0a5826a74c4 100644 --- a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita +++ b/en-US/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; @@ -431,6 +433,7 @@ class RemoteAudioStats {
                                                • (4): Users cannot communicate smoothly.
                                                • (5): The quality is so bad that users can barely communicate.
                                                • (6): The network is down, and users cannot communicate at all.
                                                • +
                                                • (8): The last-mile probe test is in progress.

                                                diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita index b880199928d..4e67bc7ec9e 100644 --- a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita +++ b/en-US/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 @@ -244,7 +245,7 @@ class RtcEngineContext {

                                                The context.

                                                - + mNativeLibPath

                                                Specifies the storage directory for the .so files. The storage directory must be a valid and private directory of the app, which can be obtained using Context.getDir().

                                                @@ -258,17 +259,17 @@ class RtcEngineContext {
                                              • Ensure the specified directory exists; otherwise, the initialization fails.
                                              - + channelProfile mChannelProfile - + audioScenario mAudioScenario - + areaCode mAreaCode The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation. @@ -284,12 +285,12 @@ class RtcEngineContext {
                                            - + mExtensionList Extension libraries. - - mExtensionObserver + + mExtensionObserver eventDelegate The instance. @@ -297,7 +298,7 @@ class RtcEngineContext { mediaFilterExtensions The instance. - + mDomainLimit domainLimit @@ -307,7 +308,7 @@ class RtcEngineContext {

                                          - + mAutoRegisterAgoraExtensions autoRegisterAgoraExtensions @@ -318,7 +319,7 @@ class RtcEngineContext {
                                          -
                                          +
                                          Method diff --git a/en-US/dita/RTC-NG/API/class_rtcimage.dita b/en-US/dita/RTC-NG/API/class_rtcimage.dita index 86c49af3738..f23ec8c6df1 100644 Binary files a/en-US/dita/RTC-NG/API/class_rtcimage.dita and b/en-US/dita/RTC-NG/API/class_rtcimage.dita differ diff --git a/en-US/dita/RTC-NG/API/class_screenaudioparameters.dita b/en-US/dita/RTC-NG/API/class_screenaudioparameters.dita index 2a371569fdc..b1e5d8a948a 100644 --- a/en-US/dita/RTC-NG/API/class_screenaudioparameters.dita +++ b/en-US/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 Audio sample rate (Hz). The default value is 16000. - + channels The number of audio channels. The default value is 2, which means stereo. @@ -135,7 +140,7 @@ public: captureSignalVolume The volume of the captured system audio. The value range is [0, 100]. The default value is 100. - + allowCaptureCurrentApp Whether to capture audio from the current app:
                                          • : (Default) Caputre audio from the current app.
                                          • diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita index 0cde1347382..0699096900f 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita +++ b/en-US/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; @@ -213,7 +220,7 @@ public:
                                          • Due to system limitations, capturing system audio is only applicable to Android API level 29 and later (that is, Android 10 and later).
                                          • To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
                                          - + audioParams The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is . @@ -225,7 +232,7 @@ public:
                                        Due to system limitations, the capture screen is only applicable to Android API level 21 and above, that is, Android 5 and above.
                                        - + videoParams The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is . diff --git a/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita b/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita index 8f948b2ddca..ebefd864bfa 100644 --- a/en-US/dita/RTC-NG/API/class_screenvideoparameters.dita +++ b/en-US/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 The video encoding dimension. The default value is 1280 × 720. If the aspect ratio of dimensions is different from that of the screen, the SDK adjusts the video encoding resolution according to the following rules (take the dimensions of 1280 × 720 as an example):
                                          @@ -170,7 +175,7 @@ public:
                                        • The value of this parameter does not indicate the orientation mode of the output video. For how to set the video orientation, see .
                                        • Whether the 720p resolution or above can be supported depends on the device. If the device cannot support 720p, the frame rate will be lower than the set value.
                                        - When setting the encoding resolution in the scenario of sharing documents (), choose one of the following two methods:
                                          + When setting the encoding resolution in the scenario of sharing documents (), choose one of the following two methods:
                                          • If you require the best image quality, it is recommended to set the encoding resolution to be the same as the capture resolution.
                                          • If you wish to achieve a relative balance between image quality, bandwidth, and system performance, then:
                                            • When the capture resolution is greater than 1920 × 1080, it is recommended that the encoding resolution is not less than 1920 × 1080.
                                            • @@ -179,7 +184,7 @@ public:
                                            - + width The width (px) of the video encoding resolution. The default value is 1280. If the aspect ratio of width to height is different from that of the screen, the SDK adjusts the video encoding resolution according to the following rules (take width × height of 1280 × 720 as an example):
                                            • When the width and height of the screen are both lower than those of dimensions, the SDK uses the resolution of the screen for video encoding. For example, if the screen is 640 × 360, the SDK uses 640 × 360 for video encoding.
                                            • @@ -200,7 +205,7 @@ public:
                                            - + height The height (px) of the video encoding resolution. The default value is 720. If the aspect ratio of width to height is different from that of the screen, the SDK adjusts the video encoding resolution according to the following rules (take width × height of 1280 × 720 as an example):
                                            • When the width and height of the screen are both lower than those of dimensions, the SDK uses the resolution of the screen for video encoding. For example, if the screen is 640 × 360, the SDK uses 640 × 360 for video encoding.
                                            • @@ -222,15 +227,15 @@ public: - frameRate - frameRate + frameRate + frameRate The video encoding frame rate (fps). The default value is 15. bitrate The video encoding bitrate (Kbps). - + contentHint The content hint for screen sharing. See .
                                              • (0): (Default) No content hint.
                                              • diff --git a/en-US/dita/RTC-NG/API/class_segmentationproperty.dita b/en-US/dita/RTC-NG/API/class_segmentationproperty.dita index c0c3a8b1ce5..9b49842ef25 100644 --- a/en-US/dita/RTC-NG/API/class_segmentationproperty.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita index 411c37fd1da..4618df961af 100644 --- a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita @@ -118,7 +118,7 @@ public: The video dimension. See . The default value is 50% of the high-quality video stream. - bitrate + bitrate kBitrate Video receive bitrate (Kbps), represented by an instantaneous value. This parameter does not need to be set. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you set. diff --git a/en-US/dita/RTC-NG/API/class_srcinfo.dita b/en-US/dita/RTC-NG/API/class_srcinfo.dita index c4096fbead0..9909b303c50 100644 --- a/en-US/dita/RTC-NG/API/class_srcinfo.dita +++ b/en-US/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/en-US/dita/RTC-NG/API/class_transcodinguser.dita b/en-US/dita/RTC-NG/API/class_transcodinguser.dita index 6f8de28e79d..e22a221aff5 100644 --- a/en-US/dita/RTC-NG/API/class_transcodinguser.dita +++ b/en-US/dita/RTC-NG/API/class_transcodinguser.dita @@ -212,21 +212,21 @@ public:

                                                The user ID of the host.

                                                - + x

                                                The x coordinate (pixel) of the host's video on the output video frame (taking the upper left corner of the video frame as the origin). The value range is [0, width], where width is the width set in .

                                                - + y The y coordinate (pixel) of the host's video on the output video frame (taking the upper left corner of the video frame as the origin). The value range is [0, height], where height is the height set in . - + width The width (pixel) of the host's video. - + height

                                                The height (pixel) of the host's video.

                                                diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita index 8bbfcfc680e..8b3aa2f5c0a 100644 --- a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita +++ b/en-US/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 -

                                                Audio spectrum information of the remote user. See .

                                                +

                                                Audio spectrum information of the remote user. See .

                                        - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_videocanvas.dita b/en-US/dita/RTC-NG/API/class_videocanvas.dita index 5df29363315..8c3ad15af9e 100644 --- a/en-US/dita/RTC-NG/API/class_videocanvas.dita +++ b/en-US/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; } @@ -285,7 +286,7 @@ class VideoCanvas { When the video source is a mixed video stream ( ), this parameter represents the ID of the user who publishes the mixed video stream.
                                        - + subviewUid The ID of the user who publishes a specific sub-video stream within the mixed video stream. Reserved for future use.This parameter is for Android and iOS only. @@ -329,7 +330,7 @@ class VideoCanvas { sourceType The type of the video source. See . - + setupMode Setting mode of the view. See . Setting mode of the view.
                                          @@ -343,7 +344,7 @@ class VideoCanvas { The ID of the media player. You can get the Device ID by calling . This parameter is required when sourceType is . - + rect (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. @@ -355,11 +356,11 @@ class VideoCanvas { cropArea (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed. - + backgroundColor The background color of the video canvas in RGBA format. The default value is 0x00000000, which represents completely transparent black. - + enableAlphaMask (Optional) Whether to enable alpha mask rendering:
                                          • : Enable alpha mask rendering.
                                          • @@ -374,7 +375,7 @@ class VideoCanvas { Reserved. - + position The observation position of the video frame in the video link. See . diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 73c787d8153..6111f0a70cf 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -570,7 +570,7 @@ public: dimensions -

                                            The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.

                                            +

                                            The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.

                                            Users can set the resolution by themselves, or directly select the desired resolution from the following list:

                                            • : The video resolution is 120 × 120.
                                            • : The video resolution is 160 × 120.
                                            • diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita index a478bc371d9..600f6e824de 100644 --- a/en-US/dita/RTC-NG/API/class_videoframe.dita +++ b/en-US/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; @@ -611,43 +611,48 @@ class VideoFrame {
                                              <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> - - type - The pixel format. See . + + type + The video type. See . + + + format + type + The pixel format. See . - + width The width of the video, in pixels. - + height The height of the video, in pixels. - + yStride For YUV data, the line span of the Y buffer; for RGBA data, the total data length.When dealing with video data, it is necessary to process the offset between each line of pixel data based on this parameter, otherwise it may result in image distortion. - + uStride For YUV data, the line span of the U buffer; for RGBA data, the value is 0.When dealing with video data, it is necessary to process the offset between each line of pixel data based on this parameter, otherwise it may result in image distortion. - + vStride For YUV data, the line span of the V buffer; for RGBA data, the value is 0.When dealing with video data, it is necessary to process the offset between each line of pixel data based on this parameter, otherwise it may result in image distortion. - + yBuffer For YUV data, the pointer to the Y buffer; for RGBA data, the data buffer. - + uBuffer For YUV data, the pointer to the U buffer; for RGBA data, the value is 0. - + vBuffer For YUV data, the pointer to the V buffer; for RGBA data, the value is 0. @@ -746,7 +751,8 @@ class VideoFrame {

                                              The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait).

                                              By setting this parameter, you can render the video background into various effects, such as transparent, solid color, image, video, etc.

                                              - In custom video rendering scenarios, ensure that both the video frame and alphaBuffer are of the Full Range type; other types may cause abnormal alpha data rendering. +
                                              • In custom video rendering scenarios, ensure that both the video frame and alphaBuffer are of the Full Range type; other types may cause abnormal alpha data rendering.
                                              • +
                                              • Make sure that alphaBufferalphaBuf is exactly the same size as the video frame (width × height), otherwise it may cause the app to crash.
                                              @@ -762,7 +768,7 @@ class VideoFrame { metaInfo -

                                              The meta information in the video frame. To use this parameter, please contact .

                                              +

                                              The meta information in the video frame. To use this parameter, contact .

                                              diff --git a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita index b7b7cdf42e4..e641868b103 100644 --- a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita +++ b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita @@ -119,12 +119,7 @@ public: streamType type - The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See . - The video stream type that you want to subscribe to:
                                                -
                                              • (0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
                                              • -
                                              • (1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
                                              • -
                                              -
                                              + The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See .
                                              encodedFrameOnly diff --git a/en-US/dita/RTC-NG/API/class_virtualbackgroundsource.dita b/en-US/dita/RTC-NG/API/class_virtualbackgroundsource.dita index 9e844214984..e1bef0fb006 100644 --- a/en-US/dita/RTC-NG/API/class_virtualbackgroundsource.dita +++ b/en-US/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); @@ -158,7 +174,7 @@ public: <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> - backgroundSourceType + backgroundSourceType background_source_type The custom background. See .
                                              • (0): Process the background as alpha data without replacement, only separating the portrait and the background. After setting this value, you can call to implement the picture-in-picture effect.
                                              • @@ -181,7 +197,7 @@ public: The local absolute path of the custom background image. Supports PNG, JPG, MP4, AVI, MKV, and FLV formats. If the path is invalid, the SDK will use either the original background image or the solid color image specified by color.This parameter takes effect only when the type of the custom background image is or . - blurDegree + blurDegree blur_degree The degree of blurring applied to the custom background image. See .
                                                • (1): The degree of blurring applied to the custom background image is low. The user can almost see the background clearly.
                                                • @@ -192,4 +208,4 @@ public:
                                      - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/enum_audioscenariotype.dita b/en-US/dita/RTC-NG/API/enum_audioscenariotype.dita index 068b5dbd7fc..f0bf71b8ab9 100644 --- a/en-US/dita/RTC-NG/API/enum_audioscenariotype.dita +++ b/en-US/dita/RTC-NG/API/enum_audioscenariotype.dita @@ -21,7 +21,7 @@ - 7: Real-time chorus scenario, where users have good network conditions and require ultra-low latency.Before using this enumeration, you need to call to see whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (isLowLatencyAudioSupported = ). + 7: Real-time chorus scenario, where users have good network conditions and require ultra-low latency.Before using this enumeration, you need to call to see whether the audio device supports ultra-low-latency capture and playback. To experience ultra-low latency, you need to ensure that your audio device supports ultra-low latency (isLowLatencyAudioSupported is ). diff --git a/en-US/dita/RTC-NG/API/enum_backgroundsourcetype.dita b/en-US/dita/RTC-NG/API/enum_backgroundsourcetype.dita index fc67f03a683..00ca8b70c21 100644 --- a/en-US/dita/RTC-NG/API/enum_backgroundsourcetype.dita +++ b/en-US/dita/RTC-NG/API/enum_backgroundsourcetype.dita @@ -7,7 +7,7 @@
                                      Enumerator - + 0: Process the background as alpha data without replacement, only separating the portrait and the background. After setting this value, you can call to implement the picture-in-picture effect. diff --git a/en-US/dita/RTC-NG/API/enum_errorcodetype.dita b/en-US/dita/RTC-NG/API/enum_errorcodetype.dita index 6c137d0b747..26709bab79c 100644 --- a/en-US/dita/RTC-NG/API/enum_errorcodetype.dita +++ b/en-US/dita/RTC-NG/API/enum_errorcodetype.dita @@ -27,7 +27,7 @@ 3: The SDK is not ready. Possible reasons include the following:
                                      • The initialization of fails. Reinitialize the .
                                      • No user has joined the channel when the method is called. Check the code logic.
                                      • -
                                      • The user has not left the channel when the or method is called. Check the code logic.
                                      • +
                                      • The user has not left the channel when the or method is called. Check the code logic.
                                      • The audio module is disabled.
                                      • The program is not complete.
                                      @@ -35,7 +35,7 @@ 4: The does not support the request. Possible reasons include the following:
                                        -
                                      • The method is called on devices running versions earlier than Android 5.0. Check the Android version.
                                      • +
                                      • The method is called on devices running versions earlier than Android 5.0. Check the Android version.
                                      • The built-in encryption mode is incorrect, or the SDK fails to load the external encryption library. Check the encryption mode setting, or reload the external encryption library.
                                      @@ -71,7 +71,7 @@ 17: The request to join the channel is rejected. Possible reasons include the following:
                                      • The user is already in the channel. Agora recommends that you use the callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the (1) state.
                                      • -
                                      • After calling for the call test, the user tries to join the channel without calling to end the current test. To join a channel, the call test must be ended by calling .
                                      • +
                                      • After calling for the call test, the user tries to join the channel without calling to end the current test. To join a channel, the call test must be ended by calling .
                                      @@ -125,7 +125,7 @@
                                    • App Certificate is enabled in Agora Console, but the code still uses App ID for authentication. Once App Certificate is enabled for a project, you must use token-based authentication.
                                    • The uid used to generate the token is not the same as the uid used to join the channel.
                                    -
                                    +
                                    Deprecated:
                                    This enumerator is deprecated. Use (8) in the callback instead.
                                    diff --git a/en-US/dita/RTC-NG/API/enum_localvideostreamreason.dita b/en-US/dita/RTC-NG/API/enum_localvideostreamreason.dita index af03b62c287..8fde8a39f99 100644 --- a/en-US/dita/RTC-NG/API/enum_localvideostreamreason.dita +++ b/en-US/dita/RTC-NG/API/enum_localvideostreamreason.dita @@ -46,7 +46,7 @@ 7: (iOS only) The current app window is running in Slide Over, Split View, or Picture in Picture mode, and another app is occupying the camera. Prompt the user that the app cannot capture video properly when it is running in Slide Over, Split View, or Picture in Picture mode and another app is occupying the camera. 7: Reserved. - + 8: Fails to find a local video capture device. Remind the user to check whether the camera is connected to the device properly or the camera is working properly, and then to rejoin the channel. @@ -130,6 +130,18 @@ 30: (Windows and macOS only)The displayer used for screen capture is disconnected. + + + 31: User has stopped screen sharing. + + + + 32: The screen sharing process has been interrupted by another screen sharing process. + + + + 33: The screen sharing process was interrupted by a system call. + 101: The current video capture device is unavailable due to excessive system pressure. diff --git a/en-US/dita/RTC-NG/API/enum_qualitytype.dita b/en-US/dita/RTC-NG/API/enum_qualitytype.dita index 07f4b5d6da2..ee4f463a9e1 100644 --- a/en-US/dita/RTC-NG/API/enum_qualitytype.dita +++ b/en-US/dita/RTC-NG/API/enum_qualitytype.dita @@ -41,7 +41,7 @@ - 8: Detecting the network quality. + 8: The last-mile network probe test is in progress.
                      diff --git a/en-US/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita b/en-US/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita index 2f0f5d29730..f93dd28224d 100644 --- a/en-US/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita +++ b/en-US/dita/RTC-NG/API/enum_videoapplicationscenariotype.dita @@ -19,14 +19,14 @@ 0: (Default) The general scenario. - +

                      1: The meeting scenario.

                      - +

                      2: 1v1 video call scenario.

                      diff --git a/en-US/dita/RTC-NG/API/enum_videocodectype.dita b/en-US/dita/RTC-NG/API/enum_videocodectype.dita index 236ec8a46b1..520e3fd3286 100644 --- a/en-US/dita/RTC-NG/API/enum_videocodectype.dita +++ b/en-US/dita/RTC-NG/API/enum_videocodectype.dita @@ -25,10 +25,7 @@
                      - -

                      6: Generic.

                      -

                      This type is used for transmitting raw video data, such as encrypted video frames. The SDK returns this type of video frames in callbacks, and you need to decode and render the frames yourself.

                      -
                      + 6: Generic. This type is used for transmitting raw video data, such as encrypted video frames. The SDK returns this type of video frames in callbacks, and you need to decode and render the frames yourself.
                      @@ -36,8 +33,7 @@ - 20: Generic JPEG.

                      This type consumes minimum computing resources and applies to IoT devices.

                      -
                      + 20: Generic JPEG. This type consumes minimum computing resources and applies to IoT devices.
                      diff --git a/en-US/dita/RTC-NG/API/enum_videomoduleposition.dita b/en-US/dita/RTC-NG/API/enum_videomoduleposition.dita index 23ebc446d14..9972e3293bd 100644 --- a/en-US/dita/RTC-NG/API/enum_videomoduleposition.dita +++ b/en-US/dita/RTC-NG/API/enum_videomoduleposition.dita @@ -10,15 +10,15 @@ - 1: The location of the locally collected video data after preprocessing corresponds to the callback. The observed video here has the effect of video pre-processing, which can be verified by enabling image enhancement, virtual background, or watermark. + 1: The location of the locally collected video data after preprocessing corresponds to the callback. The observed video here has the effect of video pre-processing, which can be verified by enabling image enhancement, virtual background, or watermark. - 2: The pre-renderer position, which corresponds to the video data in the callback. + 2: The pre-renderer position, which corresponds to the video data in the callback. - 4: The pre-encoder position, which corresponds to the video data in the callback. The observed video here has the effects of video pre-processing and encoding pre-processing.
                        + 4: The pre-encoder position, which corresponds to the video data in the callback. The observed video here has the effects of video pre-processing and encoding pre-processing.
                        • To verify the pre-processing effects of the video, you can enable image enhancement, virtual background, or watermark.
                        • To verify the pre-encoding processing effect, you can set a lower frame rate (for example, 5 fps).
                        diff --git a/en-US/dita/RTC-NG/API/rtc_api_data_type.dita b/en-US/dita/RTC-NG/API/rtc_api_data_type.dita index b484daa0fd0..c99dc107ae1 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_data_type.dita @@ -259,51 +259,51 @@
                      • -
                      • -
                      • +
                      • +
                      • -
                      • -
                      • -
                      • -
                      • +
                      • +
                      • +
                      • +
                      • -
                      • +
                        • -
                        • -
                        • -
                        • -
                        • +
                        • +
                        • +
                        • +
                      • -
                      • -
                      • -
                      • -
                      • +
                      • +
                      • +
                      • +
                      • -
                      • -
                      • -
                      • -
                      • +
                      • +
                      • +
                      • +
                      • -
                      • -
                      • -
                      • -
                      • -
                      • +
                      • +
                      • +
                      • +
                      • +
                      • -
                      • -
                      • -
                      • +
                      • +
                      • +
                      • @@ -316,16 +316,16 @@
                      • -
                      • +
                      • -
                      • +
                      • -
                      • +
                      • @@ -343,18 +343,18 @@
                      • -
                      • -
                      • -
                      • +
                      • +
                      • +
                      • -
                      • +
                      • -
                      • +
                      • -
                      • +
                      @@ -1356,6 +1356,7 @@
                    • +
                    • diff --git a/en-US/dita/RTC-NG/API/rtc_api_overview.dita b/en-US/dita/RTC-NG/API/rtc_api_overview.dita index bbc00d5e03b..64106493783 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_overview.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_overview.dita @@ -290,7 +290,7 @@ Method / Callback Description - + @@ -550,14 +550,14 @@
              -
              +
              Raw audio data Method / Callback Description - + @@ -849,7 +849,7 @@ - + @@ -951,9 +951,9 @@ - + - (For Windows and macOS only) +
              @@ -968,6 +968,10 @@ + + + + @@ -1117,7 +1121,7 @@ - + @@ -1133,7 +1137,7 @@ - + @@ -1313,7 +1317,7 @@ - + @@ -1424,34 +1428,34 @@
              -
              +
              Audio effect file playback Method / Callback Description - + - + - + - + - + - + @@ -1471,19 +1475,19 @@ - + - + - + - + @@ -1491,11 +1495,11 @@ - + - + @@ -1503,15 +1507,15 @@ - + - + - + @@ -1521,7 +1525,7 @@
              -
              +
              Virtual metronome @@ -1546,7 +1550,7 @@
              -
              +
              Media player

              For more methods about the media player, see Built-in Media Player.

              For more methods about the media player, see .

              @@ -1555,9 +1559,9 @@ Method / Callback Description - + - + @@ -1571,11 +1575,11 @@ - + - + @@ -1654,7 +1658,7 @@
              -
              +
              <ph props="cn">DRM-protected music</ph>

              This group of methods is for Android and iOS only.

              @@ -1678,7 +1682,7 @@ - + @@ -1694,7 +1698,7 @@ - + @@ -1730,7 +1734,7 @@ - + @@ -1738,10 +1742,14 @@ - + + + + + @@ -1766,7 +1774,7 @@ - + @@ -1774,7 +1782,7 @@ - + @@ -1880,7 +1888,7 @@ - + @@ -1892,7 +1900,7 @@ - + @@ -1900,7 +1908,7 @@ - + @@ -2045,7 +2053,7 @@
              -
              +
              Metadata (SEI) @@ -2060,7 +2068,7 @@ - + @@ -2118,7 +2126,7 @@ - + @@ -2255,7 +2263,7 @@ (For Android and iOS only) - + (For Android and iOS only) @@ -2307,7 +2315,7 @@ (For Android and iOS only) - + (For Android and iOS only) @@ -2585,7 +2593,7 @@ (For Android only)
              -
              +
              Extension @@ -2600,7 +2608,7 @@ - + @@ -2608,31 +2616,31 @@ - + - + - + - + - + - + - + diff --git a/en-US/dita/RTC-NG/API/rtc_api_sunset.dita b/en-US/dita/RTC-NG/API/rtc_api_sunset.dita index fcb4c9403d4..5ccc07ad90d 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_sunset.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_sunset.dita @@ -7,8 +7,9 @@ Deprecated APIs

              The deprecated APIs are expected to be officially deleted in approximately one year. Agora recommends that you promptly replace them with the recommended APIs to avoid any impact on your online services.

              -
              +
              + @@ -84,12 +85,6 @@ - v4.0.0 - - - - Use the logConfig parameter in - v4.0.0 - @@ -108,6 +103,18 @@ v4.0.0 + + + + + v4.0.0 + + + + + + v4.0.0 + @@ -126,10 +133,34 @@ v4.0.0 + + + + Use the contextconfig parameter in . + v4.0.0 + + + + + Use the contextconfig parameter in . + v4.0.0 + - Use the logConfig parameter in + Use the contextconfig parameter in . + v4.0.0 + + + + + Use the contextconfig parameter in . + v4.0.0 + + + + + v4.0.0 @@ -138,6 +169,12 @@ or v4.0.0 + + + + + v4.0.0 + @@ -186,181 +223,344 @@ - v4.0.0 - - -
              -
              -
              - - - - - - - - - - API - Description - Alternative API - Deprecated version - - - - - - - - v4.4.0 - - - - - - v4.4.0 - - - - - - v4.4.0 - - - - - - v4.4.0 - - - - - - v4.3.1 - - - - - - v4.2.0 - - - - - - v4.2.0 - - - - - v4.2.0 - - - - - - + + + v4.0.0 - - - Use the logConfig parameter in + + + v4.0.0 - - - - + + + + v4.0.0 - - - - + + + + v4.0.0 - - - - + + + + v4.0.0 - - - - or + + + + v4.0.0 - - - - + + + + v4.0.0 - - - + + + v4.0.0 - - - Use the logConfig parameter in + + + v4.0.0 - - - or - v4.0.0 - - - - - - v4.0.0 - - - - - - - v4.0.0 - - - - - - - v4.0.0 - - - - - - - v4.0.0 - - - - - - - v4.0.0 - - - - - - - v4.0.0 - - - - - - + + + v4.0.0
              +
              + + + + + + + + + + + API + Description + Alternative API + Deprecated version + + + + + + + + v4.4.0 + + + + + + v4.4.0 + + + + + + v4.4.0 + + + + + + v4.4.0 + + + + + + v4.3.1 + + + + + + v4.2.0 + + + + + + v4.2.0 + + + + + + v4.2.0 + + + + + - + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + or + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + Use the contextconfig parameter in . + v4.0.0 + + + + + Use the contextconfig parameter in . + v4.0.0 + + + + + Use the contextconfig parameter in . + v4.0.0 + + + + + Use the contextconfig parameter in . + v4.0.0 + + + + + + v4.0.0 + + + + + or + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + + + - + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + + + + v4.0.0 + + + +
              +
              Deleted APIs @@ -466,7 +666,7 @@ Occurs when the extension runs incorrectly. v4.4.0 - + diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap index 8795eee2fe2..42890708875 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-harmony.ditamap @@ -23,6 +23,14 @@ + + + + API 列表 + API List + + + @@ -75,14 +83,14 @@ - + IAudioEffectManager - + IAudioFrameObserver @@ -103,7 +111,7 @@ - + IMediaPlayerCacheManager @@ -117,7 +125,7 @@ - + IMediaPlayerVideoFrameObserver @@ -152,7 +160,7 @@ - + IMetadataObserver @@ -166,7 +174,7 @@ - + IVideoFrameObserver @@ -187,7 +195,7 @@ - + IBaseSpatialAudioEngine @@ -201,28 +209,28 @@ - + AudioParams - + IMusicContentCenterEventHandler - + IAgoraMusicPlayer - + IAgoraMusicContentCenter @@ -239,7 +247,7 @@ - + create @@ -289,7 +297,7 @@ - + @@ -389,7 +397,7 @@ - + @@ -428,14 +436,14 @@ - getPlaySrc [1/2] + getPlaySrc - + - getPlaySrc + getPlaySrc [2/2] @@ -474,7 +482,7 @@ - + getMediaPlayerCacheManager @@ -545,13 +553,6 @@ - - - open [1/2] - - - - open @@ -593,14 +594,14 @@ - + registerAudioFrameObserver - + registerVideoFrameObserver @@ -628,7 +629,7 @@ - + selectAudioTrack @@ -740,13 +741,6 @@ - - - - openWithCustomSource - - - @@ -840,13 +834,6 @@ - - - - enableAudioQualityIndication - - - @@ -882,7 +869,7 @@ - + adjustUserPlaybackSignalVolume @@ -989,7 +976,7 @@ - + setVideoScenario @@ -1017,7 +1004,6 @@ - @@ -1025,13 +1011,6 @@ - - - - setRemoteRenderMode [1/2] - - - @@ -1046,20 +1025,6 @@ - - - - CreateRendererView - - - - - - - CreateTextureView - - - @@ -1209,7 +1174,7 @@ - + adjustUserPlaybackSignalVolumeEx @@ -1223,7 +1188,7 @@ - + createDataStreamEx [1/2] @@ -1237,7 +1202,7 @@ - + enableAudioVolumeIndicationEx @@ -1287,14 +1252,14 @@ - + muteRemoteAudioStreamEx - + muteRemoteVideoStreamEx @@ -1329,7 +1294,7 @@ - + setRemoteRenderModeEx @@ -1343,7 +1308,7 @@ - + setRemoteVideoStreamTypeEx @@ -1406,14 +1371,14 @@ - + takeSnapshotEx - + updateChannelMediaOptionsEx @@ -1427,84 +1392,84 @@ - + startRtmpStreamWithoutTranscodingEx - + startRtmpStreamWithTranscodingEx - + updateRtmpTranscodingEx - + stopRtmpStreamEx - + startOrUpdateChannelMediaRelayEx - + pauseAllChannelMediaRelayEx - + muteLocalAudioStreamEx - + muteLocalVideoStreamEx - + muteAllRemoteAudioStreamsEx - + muteAllRemoteVideoStreamsEx - + stopChannelMediaRelayEx - + resumeAllChannelMediaRelayEx @@ -1527,7 +1492,7 @@ - + updateScreenCaptureParameters @@ -1564,14 +1529,14 @@ - + setAudioMixingPlaybackSpeed - + @@ -1621,14 +1586,14 @@ - + getAudioMixingPlayoutVolume - + getAudioMixingPublishVolume @@ -1672,7 +1637,7 @@ - + getAudioEffectManager @@ -2045,7 +2010,7 @@ - + startRtmpStreamWithoutTranscoding @@ -2278,14 +2243,14 @@ - + pauseAllChannelMediaRelay - + resumeAllChannelMediaRelay @@ -2359,7 +2324,7 @@ - + isCameraFaceDetectSupported @@ -2375,7 +2340,7 @@ - + setEnableSpeakerphone @@ -2443,8 +2408,8 @@ - - + + enableDualStreamMode @@ -2458,21 +2423,15 @@ - - - - setDualStreamMode [1/2] - - - - + + setDualStreamMode - + setDualStreamModeEx @@ -2504,24 +2463,10 @@ - - - - startEchoTest [1/3] - - - - - - - startEchoTest [2/3] - - - - startEchoTest [3/3] + startEchoTest @@ -2569,15 +2514,15 @@ - + + + - pushExternalVideoFrameById [1/2] + pushExternalVideoFrameById - - - + @@ -2727,7 +2672,7 @@ - + @@ -2743,7 +2688,7 @@ - + @@ -2789,7 +2734,7 @@ - + @@ -2839,31 +2784,31 @@ - + - onEvent + onEventWithContext - + - onStarted + onStartedWithContext - + - onStopped + onStoppedWithContext - + - onError + onErrorWithContext @@ -2891,7 +2836,7 @@ - + @@ -2945,20 +2890,6 @@ - - - - setEncryptionMode - - - - - - - setEncryptionSecret - - - @@ -3058,7 +2989,7 @@ - + isCameraZoomSupported @@ -3079,7 +3010,7 @@ - + isCameraExposurePositionSupported @@ -3093,7 +3024,7 @@ - + isCameraAutoFocusFaceModeSupported @@ -3121,21 +3052,21 @@ - + setCameraExposurePosition - + setCameraTorchOn - + setCameraAutoFocusFaceModeEnabled @@ -3181,7 +3112,7 @@ - + @@ -3252,7 +3183,7 @@ - + @@ -3260,17 +3191,17 @@ - + open2 - + - stop + stop [2/2] @@ -3344,6 +3275,13 @@ + + + + destroyMusicPlayer + + + @@ -3414,8 +3352,15 @@ + + + + setPlayMode + + + - + @@ -3460,7 +3405,7 @@ - + enableContentInspect @@ -3546,7 +3491,7 @@ - + getErrorDescription @@ -3560,7 +3505,7 @@ - + getSdkVersion @@ -3609,7 +3554,7 @@ - + setLogFile @@ -3623,7 +3568,7 @@ - + setLogFilter @@ -3717,7 +3662,7 @@ - + onUserMuteAudio @@ -3759,21 +3704,21 @@ - + onTokenPrivilegeWillExpire - + onRequestToken - + onLocalUserRegistered @@ -3838,14 +3783,14 @@ - + onFirstLocalVideoFrame - + onAudioPublishStateChanged @@ -3861,7 +3806,7 @@ - + onAudioSubscribeStateChanged @@ -3875,7 +3820,7 @@ - + onFirstRemoteVideoFrame @@ -3903,14 +3848,14 @@ - + onUserEnableVideo - + onUserMuteVideo @@ -3924,7 +3869,7 @@ - + onVideoSubscribeStateChanged @@ -4005,42 +3950,42 @@ - + onMetaData - + onPlayerCacheStats - + onPlayerEvent - + onPlayerPlaybackStats - + onPlayerStateChanged - + onPositionChanged @@ -4061,14 +4006,14 @@ - + onPlayBufferUpdated - + onPreloadEvent @@ -4082,14 +4027,14 @@ - + onPlayerSrcInfoChanged - + onPlayerInfoUpdated @@ -4122,13 +4067,6 @@ - - - - onAudioMixingFinished - - - @@ -4136,7 +4074,7 @@ - + onAudioEffectFinished @@ -4177,7 +4115,7 @@ - + onChannelMediaRelayStateChanged @@ -4260,7 +4198,7 @@ - + @@ -4397,7 +4335,7 @@ - + @@ -4420,11 +4358,11 @@ - + - onCameraFocusAreaChanged + onCameraFocusPointChanged @@ -4435,7 +4373,7 @@ - + onCameraReady @@ -4459,7 +4397,7 @@ - + @@ -4484,7 +4422,7 @@ - + @@ -4492,7 +4430,7 @@ - + onTranscodedStreamLayoutInfo @@ -4553,7 +4491,7 @@ - + AdvancedAudioOptions @@ -4770,7 +4708,7 @@ - + AgoraVideoFrame @@ -4784,7 +4722,7 @@ - + AgoraFocalLengthInfo @@ -5043,6 +4981,13 @@ + + + + ScreenCaptureParameters + + + @@ -5123,7 +5068,7 @@ - UserAudioSpectrumInfo + AudioSpectrumInfo @@ -5822,31 +5767,38 @@ + + + + ContentInspectType + + + - CONTENT_INSPECT_TYPE_INVALID + INVALID - CONTENT_INSPECT_TYPE_MODERATION + MODERATION - CONTENT_INSPECT_TYPE_SUPERVISE + SUPERVISE - CONTENT_INSPECT_TYPE_IMAGE_MODERATION + IMAGE_MODERATION @@ -6168,28 +6120,28 @@ - AUDIO_DUAL_MONO_STEREO + STEREO - AUDIO_DUAL_MONO_L + L - AUDIO_DUAL_MONO_R + R - AUDIO_DUAL_MONO_MIX + MIX @@ -6228,94 +6180,108 @@ + + + + AudioMixingReason + + + - 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 + + + + + + + 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 @@ -6763,21 +6729,21 @@ - AUDIO_SAMPLE_RATE_32000 + TYPE_32000 - AUDIO_SAMPLE_RATE_44100 + TYPE_44100 - AUDIO_SAMPLE_RATE_48000 + TYPE_48000 @@ -6865,6 +6831,13 @@ + + + + ConnectionChangedReason + + + @@ -7159,220 +7132,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 @@ -7649,31 +7636,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 @@ -7831,6 +7825,13 @@ + + + + ERR_INIT_NET_ENGINE + + + @@ -8398,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 @@ -8545,6 +8560,27 @@ + + + + SCREEN_CAPTURE_STOPPED_BY_USER + + + + + + + SCREEN_CAPTURE_INTERRUPTED_BY_OTHER + + + + + + + SCREEN_CAPTURE_STOPPED_BY_CALL + + + @@ -8933,105 +8969,105 @@ - PLAYER_EVENT_UNKNOWN + UNKNOWN - PLAYER_EVENT_SEEK_BEGIN + SEEK_BEGIN - PLAYER_EVENT_SEEK_COMPLETE + SEEK_COMPLETE - PLAYER_EVENT_SEEK_ERROR + SEEK_ERROR - PLAYER_EVENT_AUDIO_TRACK_CHANGED + AUDIO_TRACK_CHANGED - PLAYER_EVENT_BUFFER_LOW + BUFFER_LOW - PLAYER_EVENT_BUFFER_RECOVER + BUFFER_RECOVER - PLAYER_EVENT_FREEZE_START + FREEZE_START - PLAYER_EVENT_FREEZE_STOP + FREEZE_STOP - PLAYER_EVENT_SWITCH_BEGIN + SWITCH_BEGIN - PLAYER_EVENT_SWITCH_COMPLETE + SWITCH_COMPLETE - PLAYER_EVENT_SWITCH_ERROR + SWITCH_ERROR - PLAYER_EVENT_FIRST_DISPLAYED + FIRST_DISPLAYED - PLAYER_EVENT_REACH_CACHE_FILE_MAX_COUNT + REACH_CACHE_FILE_MAX_COUNT - PLAYER_EVENT_REACH_CACHE_FILE_MAX_SIZE + REACH_CACHE_FILE_MAX_SIZE @@ -9066,70 +9102,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 @@ -9325,60 +9361,88 @@ - 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 + + + + + + + MusicPlayMode + + + + + + + ORIGINAL + + + + + + + ACCOMPANY + + + + + + + LEAD_SING + + + + PreloadState @@ -9462,6 +9526,13 @@ + + + + PermissionType + + + @@ -9749,38 +9820,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 @@ -10429,31 +10507,38 @@ + + + + StreamSubscribeState + + + - SUB_STATE_IDLE + IDLE - SUB_STATE_NO_SUBSCRIBED + NO_SUBSCRIBED - SUB_STATE_SUBSCRIBING + SUBSCRIBING - SUB_STATE_SUBSCRIBED + SUBSCRIBED @@ -10478,13 +10563,6 @@ - - - - VIDEO_BUFFER_RAW_DATA - - - @@ -10506,6 +10584,34 @@ + + + + VideoBufferType + + + + + + + RAW_DATA + + + + + + + ARRAY + + + + + + + TEXTURE + + + @@ -11612,6 +11718,62 @@ + + + + VideoTranscoderError + + + + + + + OK + + + + + + + VIDEO_SOURCE_NOT_READY + + + + + + + INVALID_VIDEO_SOURCE_TYPE + + + + + + + INVALID_IMAGE_PATH + + + + + + + UNSUPPORT_IMAGE_FORMAT + + + + + + + INVALID_LAYOUT + + + + + + + INTERNAL + + + diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap index dd3da6e473e..32493d241d6 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-java.ditamap @@ -9838,6 +9838,13 @@ + + + + QUALITY_DETECTING + + +