diff --git a/.gitignore b/.gitignore index 229edee4af4..687620415da 100644 --- a/.gitignore +++ b/.gitignore @@ -6,11 +6,14 @@ logs/ node_modules/ out/ temp/ +bin/ .DS_Store *.xpr .vscode/settings.json .vscode/extensions.json +*.py +*.project .specstory/** dita/RTC-NG/.cursorindexingignore diff --git a/dita/RTC-AIDOC/API/api_imediaplayer_getaudiobufferdelay.dita b/dita/RTC-AIDOC/API/api_imediaplayer_getaudiobufferdelay.dita new file mode 100644 index 00000000000..e6085502c8c --- /dev/null +++ b/dita/RTC-AIDOC/API/api_imediaplayer_getaudiobufferdelay.dita @@ -0,0 +1,53 @@ + + + + <ph keyref="getAudioBufferDelay"/> + 获取播放媒体文件时的音频缓冲延迟。获取你播放媒体文件时的音频缓冲延迟。获取播放媒体文件时的音频缓冲延迟。 + + + + + + + + +
+

+ virtual int getAudioBufferDelay(int32_t& delayMs) = 0; + - (NSInteger)getAudioBufferDelay NS_SWIFT_NAME(getAudioBufferDelay()); + int getAudioBufferDelay(); +

+
+
+
+ 参数 + + + delayMs + 输出参数，表示播放媒体文件时的音频缓冲延迟，单位为毫秒。 + + +
+
+ 返回值 +

+

    +
  • 0：方法调用成功。
    • +
  • < 0：方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/windows/error-code)了解详情和解决建议。
    • +
+

+

+

    +
  • 0：方法调用成功，返回音频缓冲延迟（毫秒）。
    • +
  • < 0：方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/ios/error-code)了解详情和解决建议。你可以使用 MediaPlayerReason 检查失败原因。
    • +
+

+

+

    +
  • 方法调用成功，返回音频缓冲延迟（单位：毫秒）。
    • +
  • 方法调用失败，返回小于 0 的错误码。你可以使用 检查错误原因。
    • +
+

+
+ + \ No newline at end of file diff --git a/dita/RTC-AIDOC/API/api_irtcengine_enableinstantmediarendering.dita b/dita/RTC-AIDOC/API/api_irtcengine_enableinstantmediarendering.dita index bed70fbbd52..93775d4045f 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_enableinstantmediarendering.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_enableinstantmediarendering.dita @@ -49,7 +49,7 @@
适用场景 -

声网建议在极速直播场景中为观众开启该模式。

+

声网建议在直播场景中为观众开启该模式。

调用时机 diff --git a/dita/RTC-AIDOC/API/api_irtcengine_enablevirtualbackground.dita b/dita/RTC-AIDOC/API/api_irtcengine_enablevirtualbackground.dita index 55d0704cf43..048e3bac7a7 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_enablevirtualbackground.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_enablevirtualbackground.dita @@ -169,7 +169,7 @@ type - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。
  • 若使用摄像头采集本地视频，使用默认值 PRIMARY_CAMERA_SOURCE。
  • 若使用自定义视频源，设置为 CUSTOM_VIDEO_SOURCE。
    • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_enablevirtualbackground2.dita b/dita/RTC-AIDOC/API/api_irtcengine_enablevirtualbackground2.dita index 33694a48e0e..5f0fbe78da3 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_enablevirtualbackground2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_enablevirtualbackground2.dita @@ -133,7 +133,7 @@ sourceType - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。
    • 默认值为 AgoraMediaSourceTypePrimaryCamera。
    • 若使用自定义视频源，请设置为 AgoraMediaSourceTypeCustomVideo。
      • @@ -159,7 +159,7 @@ sourceType - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。 在本方法中，该参数仅支持以下两种设置：
      • 默认值为 PRIMARY_CAMERA_SOURCE。
        • @@ -187,7 +187,7 @@ sourceType - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。
        • 默认值为 AgoraMediaSourceTypePrimaryCamera。
        • 若使用自定义视频源，请设置为 AgoraMediaSourceTypeCustomVideo。
          • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_enablewebsdkinteroperability.dita b/dita/RTC-AIDOC/API/api_irtcengine_enablewebsdkinteroperability.dita index 8c224574e7c..485314f3d43 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_enablewebsdkinteroperability.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_enablewebsdkinteroperability.dita @@ -2,7 +2,7 @@ <ph keyref="enableWebSdkInteroperability"/> - 启用与声网 Web SDK 的互通功能（仅适用于极速直播场景）。启用或关闭与声网 Web SDK 的互通功能。启用或关闭与声网 Web SDK 的互通功能，仅适用于极速直播场景。启用或关闭与声网 Web SDK 的互通功能。 + 启用与声网 Web SDK 的互通功能（仅适用于直播场景）。启用或关闭与声网 Web SDK 的互通功能。启用或关闭与声网 Web SDK 的互通功能，仅适用于直播场景。启用或关闭与声网 Web SDK 的互通功能。 @@ -38,10 +38,10 @@
          该方法已废弃。SDK 自动开启与 Web SDK 的互通，无需调用该方法开启。
          -

          你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户，必须调用该方法，否则 Native 用户的视频画面在 Web 端会显示为黑屏。该方法仅适用于极速直播场景，在语音通话场景中默认启用互通功能。

          -

          你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户，确保调用该方法，否则 Native 用户的视频画面在 Web 端将显示为黑屏。该方法仅适用于极速直播场景，在语音通话场景中默认启用互通功能。

          -

          如果频道中存在 Web SDK 用户，必须调用该方法，否则 Native 用户的视频画面在 Web 端将显示为黑屏。该方法仅适用于极速直播场景，在语音通话场景中默认启用互通功能。

          -

          你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户，确保调用该方法，否则 Native 用户的视频画面在 Web 端将显示为黑屏。该方法仅适用于极速直播场景，在语音通话场景中默认启用互通功能。

          +

          你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户，必须调用该方法，否则 Native 用户的视频画面在 Web 端会显示为黑屏。该方法仅适用于直播场景，在语音通话场景中默认启用互通功能。

          +

          你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户，确保调用该方法，否则 Native 用户的视频画面在 Web 端将显示为黑屏。该方法仅适用于直播场景，在语音通话场景中默认启用互通功能。

          +

          如果频道中存在 Web SDK 用户，必须调用该方法，否则 Native 用户的视频画面在 Web 端将显示为黑屏。该方法仅适用于直播场景，在语音通话场景中默认启用互通功能。

          +

          你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户，确保调用该方法，否则 Native 用户的视频画面在 Web 端将显示为黑屏。该方法仅适用于直播场景，在语音通话场景中默认启用互通功能。

参数 diff --git a/dita/RTC-AIDOC/API/api_irtcengine_getfaceshapeareaoptions.dita b/dita/RTC-AIDOC/API/api_irtcengine_getfaceshapeareaoptions.dita index 6d7ebb36ac0..67562a17ebb 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_getfaceshapeareaoptions.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_getfaceshapeareaoptions.dita @@ -104,7 +104,7 @@ sourceType - 应用滤镜效果的媒体源类型，详见 。 + 媒体源类型，详见 。 该参数仅支持以下两种设置：
  • 使用摄像头采集本地视频时，使用默认值 PRIMARY_CAMERA_SOURCE。
    • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_playeffect1.dita b/dita/RTC-AIDOC/API/api_irtcengine_playeffect1.dita index f1e76853667..a2265e5fabc 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_playeffect1.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_playeffect1.dita @@ -14,29 +14,41 @@

    - (int)playEffect:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain NS_SWIFT_NAME(playEffect(_:filePath:loopCount:pitch:pan:gain:)); + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain NS_SWIFT_NAME(playEffect(_:filePath:loopCount:pitch:pan:gain:)); - (int)playEffect:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain NS_SWIFT_NAME(playEffect(_:filePath:loopCount:pitch:pan:gain:)); + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain NS_SWIFT_NAME(playEffect(_:filePath:loopCount:pitch:pan:gain:));

    -

    你可以多次调用该方法，并传入不同的 soundId 和 filePath，以同时播放多个音效文件。为获得最佳用户体验，声网建议不要同时播放超过三个音效文件。

    -

    你可以多次调用该方法，并传入不同的 soundId 和 filePath，以同时播放多个音效文件。为获得最佳用户体验，声网建议不要同时播放超过三个音效文件。

    - 如果需要播放在线音效文件，声网建议先将其缓存到本地设备，调用 将其预加载到内存中，再调用本方法播放。否则，可能因加载超时或失败导致播放失败或无声。 - 如果需要播放在线音效文件，声网建议先将其缓存到本地设备，调用 将其预加载到内存中，再调用本方法播放。否则，可能因加载超时或失败导致播放失败或无声。 +

    要同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用该方法。为获得最佳用户体验，声网建议你不要同时播放超过三个音频文件。

    +

    要同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用该方法。为获得最佳用户体验，声网建议你不要同时播放超过三个音频文件。

    + +
      +
    • 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，调用 将其预加载到内存中，然后再调用该方法播放音效。否则，可能因加载超时或失败导致播放失败或无声音。
      • +
    • 如果在调用 playEffect 之前调用了 preloadEffect，playEffect 播放后不会关闭文件资源。下次调用 playEffect 时将直接从头开始播放。
      • +
    • 如果在调用 playEffect 之前未调用 preloadEffect，playEffect 播放后将销毁资源。下次调用 playEffect 时将尝试重新打开文件并从头开始播放。
      • +
    +     + +
      +
    • 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，调用 将其预加载到内存中，然后再调用该方法播放音效。否则，可能因加载超时或失败导致播放失败或无声音。
      • +
    • 如果在调用 playEffect 之前调用了 preloadEffect，playEffect 播放后不会关闭文件资源。下次调用 playEffect 时将直接从头开始播放。
      • +
    • 如果在调用 playEffect 之前未调用 preloadEffect，playEffect 播放后将销毁资源。下次调用 playEffect 时将尝试重新打开文件并从头开始播放。
      • +
    +
    调用时机 -

    你可以在加入频道前或加入频道后调用该方法。

    -

    你可以在加入频道前或加入频道后调用该方法。

    +

    你可以在加入频道前或后调用该方法。

    +

    你可以在加入频道前或后调用该方法。

    参数 @@ -115,10 +127,18 @@
    返回值 -

    0：方法调用成功。 -< 0：方法调用失败。

    -

    0：方法调用成功。 -< 0：方法调用失败。

    +

    +

      +
    • 0：方法调用成功。
      • +
    • < 0：方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/ios/error-code)了解详情和解决建议。
      • +
    +

    +

    +

      +
    • 0：方法调用成功。
      • +
    • < 0：方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/macos/error-code)了解详情和解决建议。
      • +
    +

    \ No newline at end of file diff --git a/dita/RTC-AIDOC/API/api_irtcengine_playeffect2.dita b/dita/RTC-AIDOC/API/api_irtcengine_playeffect2.dita index 4c539383c7f..fc101420f34 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_playeffect2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_playeffect2.dita @@ -14,57 +14,81 @@

    - (int)playEffect:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain - publish:(BOOL)publish NS_SWIFT_NAME(playEffect(_:filePath:loopCount:pitch:pan:gain:publish:)); + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain + publish:(BOOL)publish NS_SWIFT_NAME(playEffect(_:filePath:loopCount:pitch:pan:gain:publish:)); public abstract int playEffect(int soundId, String filePath, int loopCount, double pitch, double pan, double gain, boolean publish); - (int)playEffect:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain - publish:(BOOL)publish NS_SWIFT_NAME(playEffect(_:filePath:loopCount:pitch:pan:gain:publish:)); + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain + publish:(BOOL)publish NS_SWIFT_NAME(playEffect(_:filePath:loopCount:pitch:pan:gain:publish:));

    -

    你可以多次调用该方法并传入不同的 soundId 和 filePath，以同时播放多个音效文件。为获得最佳用户体验，声网建议你不要同时播放超过三个音效文件。你可以在加入频道前或加入频道后调用该方法。

    -

    该方法支持播放以 content:// 开头的 URI 文件。关于支持的音频文件格式，详见[声网 RTC SDK 支持哪些格式的音频文件](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。若本地音乐文件不存在、SDK 不支持该文件格式，或无法访问音乐文件的 URL，SDK 会报告 AUDIO_MIXING_REASON_CAN_NOT_OPEN。

    -

    你可以多次调用该方法并传入不同的 soundId 和 filePath，以同时播放多个音效文件。为获得最佳用户体验，声网建议你不要同时播放超过三个音效文件。你可以在加入频道前或加入频道后调用该方法。

    - 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，再调用 将其预加载到内存中，然后调用 播放音效。否则，可能因加载超时或失败导致播放失败或无声。 - 如果需要播放在线音效文件，建议先将其缓存到本地设备，调用 preloadEffect 将文件预加载到内存中，再调用该方法播放音效。否则可能因加载超时或失败导致播放失败或无声。 - 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，再调用 将其预加载到内存中，然后调用 播放音效。否则，可能因加载超时或失败导致播放失败或无声。 +

    要同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用此方法。为获得最佳用户体验，声网建议你不要同时播放超过三个音效文件。

    +

    该方法支持播放以 content:// 开头的 URI 文件。关于支持的音频文件格式，详见[声网 RTC SDK 支持哪些格式的音频文件](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。若本地音乐文件不存在、SDK 不支持该文件格式，或无法访问音乐文件的 URL，SDK 会报告 AUDIO_MIXING_REASON_CAN_NOT_OPEN。要同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用该方法。为获得最佳用户体验，声网建议不要同时播放超过三个音频文件。

    +

    要同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用此方法。为获得最佳用户体验，声网建议你不要同时播放超过三个音效文件。

    + +
      +
    • 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，调用 将其预加载到内存中，再调用此方法播放音效。否则，可能因加载超时或失败导致播放失败或无声。
      • +
    • 如果在调用 playEffect 之前调用了 preloadEffect，则 playEffect 执行后不会关闭文件资源。下次调用 playEffect 时将直接从头开始播放。
      • +
    • 如果在调用 playEffect 之前未调用 preloadEffect，则 playEffect 执行后会销毁资源。下次调用 playEffect 时将尝试重新打开文件并从头开始播放。
      • +
    +     + +
      +
    • 如果需要播放在线音效文件，建议先将其缓存到本地设备，调用 preloadEffect 将文件预加载到内存中，再调用该方法播放音效。否则可能因加载超时或失败导致播放失败或无声。
      • +
    • 如果在调用 playEffectEx 前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次调用 playEffectEx 时将从头开始播放。
      • +
    • 如果未调用 preloadEffectEx 就直接调用 playEffectEx，则 playEffectEx 执行后会销毁资源。下次调用时将尝试重新打开文件并从头播放。
      • +
    +     + +
      +
    • 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，调用 将其预加载到内存中，再调用此方法播放音效。否则，可能因加载超时或失败导致播放失败或无声。
      • +
    • 如果在调用 playEffect 之前调用了 preloadEffect，则 playEffect 执行后不会关闭文件资源。下次调用 playEffect 时将直接从头开始播放。
      • +
    • 如果在调用 playEffect 之前未调用 preloadEffect，则 playEffect 执行后会销毁资源。下次调用 playEffect 时将尝试重新打开文件并从头开始播放。
      • +
    +
    调用时机 -

    你可以在加入频道前或加入频道后调用该方法。

    +

    你可以在加入频道前或加入频道后调用此方法。

    你可以在加入频道前或后调用该方法。

    -

    你可以在加入频道前或加入频道后调用该方法。

    +

    你可以在加入频道前或加入频道后调用此方法。

    -
    -

    要同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用该方法。为获得最佳用户体验，声网建议不要同时播放超过三个音效文件。

    -

    你可以多次调用该方法并传入不同的 soundId 和 filePath，以同时播放多个音效文件。为获得最佳用户体验，声网建议你不要同时播放超过三个音效文件。

    -

    该方法支持播放以 content:// 开头的 URI 文件。支持的音频文件格式详见[声网 RTC SDK 支持哪些格式的音频文件](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。如果本地音频文件不存在、SDK 不支持该文件格式，或无法访问音频文件的 URL，SDK 会返回错误码 AUDIO_MIXING_REASON_CAN_NOT_OPEN。

    -

    你可以多次调用该方法并传入不同的 soundId 和 filePath，以同时播放多个音效文件。为获得最佳用户体验，声网建议你不要同时播放超过三个音效文件。

    - 如果需要播放在线音效文件，声网建议先将其缓存到本地设备，调用 将其预加载到内存中，再调用该方法播放音效。否则，可能因加载超时或失败导致播放失败或无声。 -如果在调用 前调用了 ，则在 执行后文件资源不会被关闭。下次调用 时将直接从头开始播放。 -如果在调用 前未调用 ，则在 执行后资源将被销毁。下次调用 时将尝试重新打开文件并从头播放。 - 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，再调用 将其预加载到内存中，然后调用该方法播放音效。否则，可能因加载超时或失败导致播放失败或无声。 - 如果需要播放在线音效文件，声网建议先将其缓存到本地设备，调用 preloadEffect 将文件预加载到内存中，再调用该方法播放音效。否则，可能因加载超时或失败导致播放失败或无声。 - 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，再调用 将其预加载到内存中，然后调用该方法播放音效。否则，可能因加载超时或失败导致播放失败或无声。 +

    调用 后，可以调用该方法为频道内所有用户播放指定的音效。每次调用该方法只能播放一个音效。如需同时播放多个音效，需要多次调用该方法。

    +

    要同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用该方法。为获得最佳用户体验，声网建议你不要同时播放超过三个音频文件。

    +

    该方法支持播放以 content:// 开头的 URI 文件。关于支持的音频文件格式，参见 What formats of audio files does the Agora RTC SDK support。如果本地音频文件不存在、SDK 不支持该文件格式，或无法访问音频文件的 URL，SDK 会报告 AUDIO_MIXING_REASON_CAN_NOT_OPEN。

    +

    要同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用该方法。为获得最佳用户体验，声网建议你不要同时播放超过三个音频文件。

    + +
      +
    • 如果需要播放在线音效文件，声网建议先将其缓存到本地设备，调用 将其预加载到内存中，再调用该方法播放音效。否则，可能因加载超时或失败导致播放失败或无声。
      • +
    • 建议同时播放的音效数量不超过三个。
      • +
    • 该方法中的音效 ID 和文件路径必须与 中的一致。
      • +
    • 如果在调用 前调用了 ，则在 执行后文件资源不会被关闭。下次调用 时将直接从头开始播放。
      • +
    • 如果在调用 前未调用 ，则在 执行后资源将被销毁。下次调用 时将尝试重新打开文件并从头播放。
      • +
    +     + +
      +
    • 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，调用 将文件预加载到内存中，再调用此方法播放音效。否则，可能因加载超时或失败导致播放失败或无声。
      • +
    • 如果在调用 playEffect 之前已调用 preloadEffect，则 playEffect 执行后不会关闭文件资源。下次调用 playEffect 时将直接从头开始播放。
      • +
    • 如果在调用 playEffect 之前未调用 preloadEffect，则 playEffect 执行后资源将被销毁。下次调用 playEffect 时将尝试重新打开文件并从头开始播放。
      • +
    +     + +
      +
    • 如果需要播放在线音效文件，建议先将其缓存到本地设备，调用 preloadEffect 将文件预加载到内存中，再调用此方法播放。否则可能因加载超时或失败导致播放失败或无声。
      • +
    • 如果在调用 playEffect 前已调用 preloadEffect，则 playEffect 执行后不会关闭文件资源。下次调用 playEffect 时将从头开始播放。
      • +
    • 如果未调用 preloadEffect 就执行 playEffect，则播放结束后资源将被销毁。下次调用 playEffect 时将尝试重新打开文件并从头播放。
      • +
    +     + +
      +
    • 如果你需要播放在线音效文件，声网建议你先将该文件缓存到本地设备，调用 将文件预加载到内存中，再调用此方法播放音效。否则，可能因加载超时或失败导致播放失败或无声。
      • +
    • 如果在调用 playEffect 之前已调用 preloadEffect，则 playEffect 执行后不会关闭文件资源。下次调用 playEffect 时将直接从头开始播放。
      • +
    • 如果在调用 playEffect 之前未调用 preloadEffect，则 playEffect 执行后资源将被销毁。下次调用 playEffect 时将尝试重新打开文件并从头开始播放。
      • +
    +
    调用时机

    你可以在加入频道前或后调用该方法。

    -

    你可以在加入频道前或加入频道后调用该方法。

    +

    你可以在加入频道前或后调用该方法。

    你可以在加入频道前或加入频道后调用该方法。

    -

    你可以在加入频道前或加入频道后调用该方法。

    +

    你可以在加入频道前或后调用该方法。

    参数 soundId - 音效 ID。每个音效文件的 ID 是唯一的。如果已调用 将音效预加载到内存中，请确保该参数的值与 中的 soundId 相同。 + 音效的 ID。 filePath - 文件路径。支持 URL 和本地文件的绝对路径，路径需精确到文件名及扩展名。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV 和 3GP。详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。如果已调用 将音效预加载到内存中，请确保该参数的值与 中的 filePath 相同。 + 本地音效文件的绝对路径或在线音效文件的 URL。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount 音效的循环播放次数：
      -
    • ≥ 0：播放的次数。例如，1 表示循环播放一次，即总共播放两次。
      • -
    • -1：无限循环播放该音效文件。
      • +
    • -1：无限循环播放，直到调用 或 。
      • +
    • 0：播放一次。
      • +
    • 1：播放两次。
         pitch - 音效的音调。取值范围为 0.5 到 2.0。默认值为 1.0，表示原始音调。值越小，音调越低。 + 音效的音调。取值范围为 0.5 到 2.0，默认值为 1.0（原始音调）。值越小，音调越低。 pan 音效的空间位置。取值范围为 -1.0 到 1.0：
      -
    • -1.0：音效从用户左侧传来。
      • -
    • 0.0：音效从用户正前方传来。
      • -
    • 1.0：音效从用户右侧传来。
      • +
    • -1.0：音效定位在左侧。
      • +
    • 0.0：音效定位在正前方。
      • +
    • 1.0：音效定位在右侧。
         gain - 音效的音量。取值范围为 0.0 到 100.0。默认值为 100.0，表示原始音量。值越小，音量越低。 + 音效的音量。取值范围为 0 到 100，默认值为 100（原始音量）。值越小，音量越低。 publish - 是否将音效发布给远端用户： + 是否将音效发布到远端：
      -
    • ：将音效发布给远端用户，本地和远端用户都能听到音效。
      • -
    • ：（默认）不将音效发布给远端用户，只有本地用户能听到音效。
      • +
    • ：将音效发布到远端。
      • +
    • ：（默认）不将音效发布到远端。
         @@ -113,21 +138,21 @@ soundId 音效 ID。每个音效文件的 ID 必须唯一。 - -如果你已通过调用 将音效预加载到内存中，确保该参数的值与 中的 soundId 相同。 + 如果你已通过调用 将音效预加载到内存中，请确保该参数的值与 中的 soundId 相同。 + filePath - 音效文件路径。支持以 ipod-library:// 开头的路径、URL 以及本地文件的绝对路径。绝对路径需精确到文件名及扩展名。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV 和 3GP。 - -如果你已通过调用 将音效预加载到内存中，确保该参数的值与 中的 filePath 相同。 + 文件路径。支持以 ipod-library:// 开头的路径、URL 以及本地文件的绝对路径。绝对路径需精确到文件名及扩展名。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV 和 3GP。 + 如果你已通过调用 将音效预加载到内存中，请确保该参数的值与 中的 filePath 相同。 + loopCount 音效循环播放的次数：
    • ≥ 0：播放的次数。例如，1 表示循环播放一次，即总共播放两次。
      • -
    • -1：无限循环播放该音效文件。
      • +
    • -1：无限循环播放该音频文件。
         @@ -139,9 +164,9 @@ pan 音效的空间位置。取值范围为 -1.0 到 1.0：
      -
    • -1.0：音效从你左侧播放。
      • -
    • 0.0：音效从你正前方播放。
      • -
    • 1.0：音效从你右侧播放。
      • +
    • -1.0：音效从用户左侧播放。
      • +
    • 0.0：音效从用户正前方播放。
      • +
    • 1.0：音效从用户右侧播放。
     @@ -153,8 +178,8 @@ publish 是否将音效发布给远端用户：
      -
    • ：将音效发布给远端用户，你和远端用户都能听到该音效。
      • -
    • ：不将音效发布给远端用户，只有你能听到该音效。
      • +
    • ：将音效发布给远端用户，本地和远端用户都能听到该音效。
      • +
    • ：不将音效发布给远端用户，只有本地用户能听到该音效。
     @@ -164,13 +189,13 @@ soundId - 音效 ID。每个音效文件的 ID 必须唯一。 + 音效 ID。每个音效文件的 ID 都是唯一的。 如果你已通过调用 preloadEffect 将音效预加载到内存中，请确保该参数的值与 preloadEffect 中的 soundId 相同。 filePath - 音效文件路径。支持以 content:// 开头的 URI 地址、以 /assets/ 开头的路径、URL 以及本地文件的绝对路径。路径需精确到文件名及扩展名。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV 和 3GP。 + 文件路径。支持以 content:// 开头的 URI、以 /assets/ 开头的路径、URL 以及本地文件的绝对路径。路径需精确到文件名及扩展名。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV 和 3GP。 如果你已通过调用 preloadEffect 将音效预加载到内存中，请确保该参数的值与 preloadEffect 中的 filePath 相同。 @@ -205,33 +230,33 @@ publish 是否将音效发布给远端用户：
      -
    • ：将音效发布给远端用户，本地用户和远端用户都能听到音效。
      • -
    • ：不将音效发布给远端用户，只有本地用户能听到音效。
      • +
    • ：将音效发布给远端用户，本地用户和远端用户都能听到该音效。
      • +
    • ：不将音效发布给远端用户，只有本地用户能听到该音效。
     startPos - 音效文件的播放起始位置，单位为毫秒。 + 音效文件的播放起始位置（单位：毫秒）。 soundId 音效 ID。每个音效文件的 ID 必须唯一。 - -如果你已通过调用 将音效预加载到内存中，确保该参数的值与 中的 soundId 相同。 + 如果你已通过调用 将音效预加载到内存中，请确保该参数的值与 中的 soundId 相同。 + filePath - 音效文件路径。支持以 ipod-library:// 开头的路径、URL 以及本地文件的绝对路径。绝对路径需精确到文件名及扩展名。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV 和 3GP。 - -如果你已通过调用 将音效预加载到内存中，确保该参数的值与 中的 filePath 相同。 + 文件路径。支持以 ipod-library:// 开头的路径、URL 以及本地文件的绝对路径。绝对路径需精确到文件名及扩展名。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV 和 3GP。 + 如果你已通过调用 将音效预加载到内存中，请确保该参数的值与 中的 filePath 相同。 + loopCount 音效循环播放的次数：
    • ≥ 0：播放的次数。例如，1 表示循环播放一次，即总共播放两次。
      • -
    • -1：无限循环播放该音效文件。
      • +
    • -1：无限循环播放该音频文件。
         @@ -243,9 +268,9 @@ pan 音效的空间位置。取值范围为 -1.0 到 1.0：
      -
    • -1.0：音效从你左侧播放。
      • -
    • 0.0：音效从你正前方播放。
      • -
    • 1.0：音效从你右侧播放。
      • +
    • -1.0：音效从用户左侧播放。
      • +
    • 0.0：音效从用户正前方播放。
      • +
    • 1.0：音效从用户右侧播放。
     @@ -257,8 +282,8 @@ publish 是否将音效发布给远端用户：
      -
    • ：将音效发布给远端用户，你和远端用户都能听到该音效。
      • -
    • ：不将音效发布给远端用户，只有你能听到该音效。
      • +
    • ：将音效发布给远端用户，本地和远端用户都能听到该音效。
      • +
    • ：不将音效发布给远端用户，只有本地用户能听到该音效。
     @@ -282,12 +307,8 @@
  • < 0：方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/ios/error-code)了解详情和解决建议。

-

-

    -
  • 0：方法调用成功。
    • -
  • < 0：方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/android/error-code)了解详情和解决建议。
    • -
-

+

0：方法调用成功。 +< 0：方法调用失败。

  • 0：方法调用成功。
    • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect.dita b/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect.dita index 73e3ede4f22..f8a4f427028 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect.dita @@ -2,7 +2,7 @@ <ph keyref="preloadEffect"/> - 将指定的音效文件预加载到内存中。将指定的音效文件预加载到内存中。预加载指定的音效文件。将指定的音效文件预加载到内存中。 + 预加载指定的音效文件。预加载指定的音效文件。预加载指定的音效文件。预加载指定的音效文件。 @@ -15,43 +15,49 @@

    virtual int preloadEffect(int soundId, const char* filePath, int startPos = 0) = 0; - (int)preloadEffect:(int)soundId - filePath:(NSString* _Nonnull)filePath - startPos:(int)startPos NS_SWIFT_NAME(preloadEffect(_:filePath:startPos:)); + filePath:(NSString* _Nonnull)filePath + startPos:(int)startPos NS_SWIFT_NAME(preloadEffect(_:filePath:startPos:)); public abstract int preloadEffect(int soundId, String filePath, int startPos); - (int)preloadEffect:(int)soundId - filePath:(NSString* _Nonnull)filePath - startPos:(int)startPos NS_SWIFT_NAME(preloadEffect(_:filePath:startPos:)); + filePath:(NSString* _Nonnull)filePath + startPos:(int)startPos NS_SWIFT_NAME(preloadEffect(_:filePath:startPos:));

-

确保所有预加载文件的总大小不超过限制。

-

确保所有预加载文件的总大小不超过限制。

-

你可以多次调用该方法，将多个音效文件预加载到内存中。预加载完成后，可以调用 playEffect 播放预加载的音效，或调用 播放所有已预加载的音效。

-

确保所有预加载文件的总大小不超过限制。

- +

该方法每次调用时仅将一个指定的音效文件预加载到内存中。要预加载多个音效文件，需要多次调用该方法。预加载完成后，你可以调用 播放预加载的音效，或调用 播放所有预加载的音效。

+

该方法每次调用时仅将一个指定的音效文件预加载到内存中。如需预加载多个音效文件，请多次调用该方法。 +你可以调用 playEffect 播放已预加载的音效，或调用 播放所有已预加载的音效。

    -
  • 如果在调用 之前调用 ， 执行后不会关闭文件资源。下次调用 时会直接从头开始播放。
    • -
  • 如果在调用 之前未调用 ， 执行后会销毁资源。下次调用 时会尝试重新打开文件并从头开始播放。
    • +
  • 为确保通信顺畅，请限制音效文件的大小。
    • +
  • 声网建议你在加入频道前调用此方法。
    • +
  • 如果在调用 playEffect 之前调用了 preloadEffect，则 playEffect 执行后不会关闭文件资源。下次调用 playEffect 时将直接从头开始播放。
    • +
  • 如果在调用 playEffect 之前未调用 preloadEffect，则 playEffect 执行后会销毁资源。下次调用 playEffect 时会尝试重新打开文件并从头开始播放。
- - +

+

该方法每次调用时仅将一个指定的音效文件预加载到内存中。若需预加载多个音效文件，请多次调用该方法。

+

该方法每次调用时仅将一个指定的音效文件预加载到内存中。如需预加载多个音效文件，请多次调用该方法。 +你可以调用 playEffect 播放已预加载的音效，或调用 播放所有已预加载的音效。

    -
  • 如果你在调用 playEffect 之前调用了 preloadEffect，playEffect 执行后不会关闭文件资源。下次调用 playEffect 时会直接从头开始播放。
    • -
  • 如果你未在调用 playEffect 之前调用 preloadEffect，playEffect 执行后会销毁资源。下次调用 playEffect 时会尝试重新打开文件并从头开始播放。
    • +
  • 为确保通信顺畅，请限制音效文件的大小。
    • +
  • 声网建议你在加入频道前调用此方法。
    • +
  • 如果在调用 playEffect 之前调用了 preloadEffect，则 playEffect 执行后不会关闭文件资源。下次调用 playEffect 时将直接从头开始播放。
    • +
  • 如果在调用 playEffect 之前未调用 preloadEffect，则 playEffect 执行后会销毁资源。下次调用 playEffect 时会尝试重新打开文件并从头开始播放。
- - +

+
    -
  • 为确保通信流畅，请限制音效文件的大小。
    • -
  • 声网建议你在加入频道前调用该方法。
    • -
  • 如果在调用 playEffect 前调用了 preloadEffect，则在 playEffect 执行后文件资源不会被关闭。下次调用 playEffect 时将从头开始播放。
    • -
  • 如果未在调用 playEffect 前调用 preloadEffect，则在 playEffect 执行后资源将被销毁。下次调用 playEffect 时将尝试重新打开文件并从头播放。
    • +
  • 为确保通信顺畅，请限制音效文件的大小。
    • +
  • 声网建议在加入频道前调用该方法。
    • +
  • 如果在调用 之前调用了 ，则在 执行后文件资源不会被关闭。下次调用 时会从头开始播放。
    • +
  • 如果在调用 之前未调用 ，则在 执行后资源会被销毁。下次调用 时会尝试重新打开文件并从头开始播放。
 - +
    -
  • 如果你在调用 playEffect 之前调用了 preloadEffect，playEffect 执行后不会关闭文件资源。下次调用 playEffect 时会直接从头开始播放。
    • -
  • 如果你未在调用 playEffect 之前调用 preloadEffect，playEffect 执行后会销毁资源。下次调用 playEffect 时会尝试重新打开文件并从头开始播放。
    • +
  • 为确保通信流畅，请限制音效文件的大小。
    • +
  • 声网建议在加入频道前调用此方法。
    • +
  • 如果在调用 playEffect 之前调用了 preloadEffect，则 playEffect 执行后不会关闭文件资源。下次调用 playEffect 时将从头开始播放。
    • +
  • 如果在调用 playEffect 之前未调用 preloadEffect，则 playEffect 执行后资源将被销毁。下次调用 playEffect 时将尝试重新打开文件并从头开始播放。
@@ -70,17 +76,11 @@ filePath - 文件路径： -
    -
  • Android：文件路径需精确到文件名和后缀名。支持 URL 地址、绝对路径或以 /assets/ 开头的路径。使用绝对路径访问本地文件可能会遇到权限问题，建议使用 URI 地址，例如：content://com.android.providers.media.documents/document/audio%3A14441。
    • -
  • Windows：音效文件的绝对路径或 URL 地址（包括文件名后缀），例如：。
    • -
  • iOS 或 macOS：音效文件的绝对路径或 URL 地址（包括文件名后缀），例如：/var/mobile/Containers/Data/audio.mp4。
    • -
- + 本地音效文件的绝对路径或在线音效文件的 URL。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。 startPos - 音效文件的播放起始位置，单位为毫秒。 + 音效播放的起始位置，单位为毫秒。默认值为 0，表示从头开始播放。 soundId @@ -88,11 +88,7 @@ filePath - 文件路径： -
    -
  • iOS 或 macOS：音效文件的绝对路径或 URL 地址（包括文件名后缀）。例如：。
    • -
- + 本地音效文件的绝对路径或在线音效文件的 URL。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。 startPos @@ -116,11 +112,7 @@ filePath - 文件路径： -
    -
  • iOS 或 macOS：音效文件的绝对路径或 URL 地址（包括文件名后缀）。例如：。
    • -
- + 本地音效文件的绝对路径或在线音效文件的 URL。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。 startPos diff --git a/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect2.dita b/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect2.dita index 9a813d04116..234cb23461f 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect2.dita @@ -14,16 +14,34 @@

- (int)preloadEffect:(int)soundId - filePath:(NSString* _Nonnull)filePath NS_SWIFT_NAME(preloadEffect(_:filePath:)); + filePath:(NSString* _Nonnull)filePath NS_SWIFT_NAME(preloadEffect(_:filePath:)); public abstract int preloadEffect(int soundId, String filePath); - (int)preloadEffect:(int)soundId - filePath:(NSString* _Nonnull)filePath NS_SWIFT_NAME(preloadEffect(_:filePath:)); + filePath:(NSString* _Nonnull)filePath NS_SWIFT_NAME(preloadEffect(_:filePath:));

确保所有预加载文件的总大小不超过限制。关于该方法支持的音频文件格式，详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。

-

确保所有预加载文件的总大小不超过限制。支持的音频文件格式，详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。

+

确保所有预加载文件的总大小不超过限制。详见 声网 RTC SDK 支持哪些音频文件格式。

确保所有预加载文件的总大小不超过限制。关于该方法支持的音频文件格式，详见[声网 RTC SDK 支持哪些音频文件格式](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format)。

+ +
    +
  • 如果你在调用 playEffect 之前调用了 preloadEffect，则在 playEffect 执行后文件资源不会被关闭。下次调用 playEffect 时会直接从头开始播放。
    • +
  • 如果你在调用 playEffectEx 之前未调用 preloadEffect，则在 playEffect 执行后资源会被销毁。下次调用 playEffect 时会尝试重新打开文件并从头开始播放。
    • +
+ + +
    +
  • 如果在调用 playEffect 之前调用了 preloadEffect，playEffect 执行后不会关闭文件资源。下次调用 playEffect 时，将从头开始播放。
    • +
  • 如果在调用 playEffect 之前未调用 preloadEffect，playEffect 执行后会销毁资源。下次调用 playEffect 时，将尝试重新打开文件并从头开始播放。
    • +
+ + +
    +
  • 如果你在调用 playEffect 之前调用了 preloadEffect，则在 playEffect 执行后文件资源不会被关闭。下次调用 playEffect 时会直接从头开始播放。
    • +
  • 如果你在调用 playEffectEx 之前未调用 preloadEffect，则在 playEffect 执行后资源会被销毁。下次调用 playEffect 时会尝试重新打开文件并从头开始播放。
    • +
+
调用时机 @@ -52,10 +70,12 @@ filePath - 文件路径： + 文件路径。支持以下格式：
    -
  • Android：文件路径需精确到文件名和后缀名。声网支持 URL 地址、绝对路径，或以 /assets/ 开头的文件路径。如果使用绝对路径访问本地文件，可能会遇到权限问题，因此建议使用 URI 地址。例如：
    • -
content://com.android.providers.media.documents/document/audio%3A14441。 +
  • URL 地址。
    • +
  • 绝对路径。
    • +
  • 以 /assets/ 开头的文件路径。
    • + 路径需精确到文件名和后缀名。如果使用绝对路径访问本地文件，可能会遇到权限问题，建议使用 URI 地址，例如：content://com.android.providers.media.documents/document/audio%3A14441。         soundId diff --git a/dita/RTC-AIDOC/API/api_irtcengine_pushaudioframe2.dita b/dita/RTC-AIDOC/API/api_irtcengine_pushaudioframe2.dita index 5e6d6118ee7..7e0f3ad3616 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_pushaudioframe2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_pushaudioframe2.dita @@ -2,7 +2,7 @@ <ph keyref="pushAudioFrame2"/> - 将外部音频帧推送到 SDK。将外部音频数据推送到 App。将外部音频帧推送到 SDK。 + 将外部音频帧推送到 SDK。将外部音频帧推送到 SDK。将外部音频帧推送到 SDK。 @@ -19,7 +19,7 @@ channels:(NSInteger)channels trackId:(NSInteger)trackId timestamp:(NSTimeInterval)timestamp NS_SWIFT_NAME(pushExternalAudioFrameRawData(_:samples:sampleRate:channels:trackId:timestamp:)); - public abstract int pushExternalAudioFrame(byte[] data, long timestamp) + public abstract int pushExternalAudioFrame(byte[] data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId); - (int)pushExternalAudioFrameRawData:(void* _Nonnull)data samples:(NSInteger)samples sampleRate:(NSInteger)sampleRate @@ -29,12 +29,6 @@

    -
    - -
    废弃
    -
    该方法已废弃。请改用 pushExternalAudioFrame(byte[] data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId)。
    -     -

    你可以调用该方法通过音频轨道向 SDK 推送外部音频帧。 调用该方法前，请先完成以下操作：

      @@ -42,6 +36,12 @@
    1. 调用 joinChannelByToken 加入频道。在 中，将 publishCustomAudioTrackId 设置为要发布的音频轨道 ID，并将 publishCustomAudioTrack 设置为 。

    +

    调用该方法前，请按以下顺序操作： +

      +
    1. 调用 创建自定义音频轨道，并获取音频轨道 ID。
      2. +
    2. 调用 joinChannel 加入频道。在 中，将 publishCustomAudioTrackId 设置为要发布的音频轨道 ID，并将 publishCustomAudioTrack 设置为 。
      3. +
    +

    你可以调用该方法通过音频轨道向 SDK 推送外部音频帧。 调用该方法前，请先完成以下操作：

      @@ -50,6 +50,15 @@

    +
    + 调用时机 +

    在调用该方法推送外部音频数据前，请先完成以下步骤： +

      +
    1. 调用 创建自定义音频轨道并获取音频轨道 ID。
      2. +
    2. 调用 joinChannel 加入频道。在 中，将 publishCustomAudioTrackId 设置为要发布的音频轨道 ID，并将 publishCustomAudioTrack 设置为 。
      3. +
    +

    +
    参数 @@ -79,11 +88,40 @@ data - 音频数据缓冲区。 + 外部音频数据。 timestamp - 音频数据的时间戳。 + 外部音频帧的时间戳（毫秒）。该参数为必填项，可用于还原采集音频帧的顺序，或在涉及视频的场景中（包括使用外部视频源的场景）实现音视频同步。 + + + sampleRate + 外部音频源的采样率（Hz），可设置为以下值： +
      +
    • 8000
      • +
    • 16000
      • +
    • 32000
      • +
    • 44100
      • +
    • 48000。
      • +
    +     +     + + channels + 外部音频源的声道数，可设置为以下值： +
      +
    • 1：单声道。
      • +
    • 2：立体声。
      • +
    +     +     + + bytesPerSample + 每个采样点的字节数。 + + + trackId + 音频轨道 ID。请设置为 返回的自定义音频轨道 ID。 data diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setbeautyeffectoptions.dita b/dita/RTC-AIDOC/API/api_irtcengine_setbeautyeffectoptions.dita index 358dd1fc926..25e46560eb4 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setbeautyeffectoptions.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setbeautyeffectoptions.dita @@ -79,7 +79,7 @@ type - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。
    • 如果使用摄像头采集本地视频，使用默认值 PRIMARY_CAMERA_SOURCE。
    • 如果使用自定义视频源，设置为 CUSTOM_VIDEO_SOURCE。
      • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setbeautyeffectoptions2.dita b/dita/RTC-AIDOC/API/api_irtcengine_setbeautyeffectoptions2.dita index 2fed205ecce..3661ed4dccc 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setbeautyeffectoptions2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setbeautyeffectoptions2.dita @@ -53,7 +53,7 @@ sourceType - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。 在该方法中，该参数仅支持以下两种设置：
      • 默认值为 AgoraMediaSourceTypePrimaryCamera。
        • @@ -101,7 +101,7 @@ sourceType - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。 在该方法中，该参数仅支持以下两种设置：
        • 默认值为 AgoraMediaSourceTypePrimaryCamera。
          • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setchannelprofile.dita b/dita/RTC-AIDOC/API/api_irtcengine_setchannelprofile.dita index 6880f3d6e8b..1a76f9bf7fd 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setchannelprofile.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setchannelprofile.dita @@ -20,10 +20,10 @@

    -

    SDK 会根据不同的频道场景采用不同的优化策略。例如，在极速直播场景中，SDK 会优先保证视频质量。初始化 SDK 后，默认频道场景为极速直播。

    -

    你可以调用该方法设置频道场景。SDK 会针对不同的频道场景采用不同的优化策略。例如，在极速直播场景中，SDK 会优先保证视频质量。初始化 SDK 后，默认频道场景为极速直播。

    -

    SDK 会根据不同的频道场景采用不同的优化策略，例如在极速直播场景中优先保证视频质量。初始化 SDK 后，默认频道场景为极速直播。

    -

    你可以调用该方法设置频道场景。SDK 会针对不同的频道场景采用不同的优化策略。例如，在极速直播场景中，SDK 会优先保证视频质量。初始化 SDK 后，默认频道场景为极速直播。

    +

    SDK 会根据不同的频道场景采用不同的优化策略。例如，在直播场景中，SDK 会优先保证视频质量。初始化 SDK 后，默认频道场景为直播。

    +

    你可以调用该方法设置频道场景。SDK 会针对不同的频道场景采用不同的优化策略。例如，在互动直播场景中，SDK 会优先保证视频质量。初始化 SDK 后，默认频道场景为互动直播。

    +

    SDK 会根据不同的频道场景采用不同的优化策略，例如在直播场景中优先保证视频质量。初始化 SDK 后，默认频道场景为直播。

    +

    你可以调用该方法设置频道场景。SDK 会针对不同的频道场景采用不同的优化策略。例如，在互动直播场景中，SDK 会优先保证视频质量。初始化 SDK 后，默认频道场景为互动直播。

    为保证实时通信质量，声网建议频道内所有用户使用相同的频道场景。在不同的频道场景中，SDK 的默认音频路由也不同。详见 。
      @@ -62,7 +62,7 @@ 频道场景：
      • CHANNEL_PROFILE_COMMUNICATION（0）：通信场景。建议使用 CHANNEL_PROFILE_LIVE_BROADCASTING 以获得更好的音视频体验。
        • -
      • CHANNEL_PROFILE_LIVE_BROADCASTING（1）：（默认）极速直播场景。
        • +
      • CHANNEL_PROFILE_LIVE_BROADCASTING（1）：（默认）直播场景。
      • CHANNEL_PROFILE_GAME（2）：游戏场景。已废弃，请使用 CHANNEL_PROFILE_LIVE_BROADCASTING。
      • CHANNEL_PROFILE_CLOUD_GAMING（3）：互动场景。该场景对延迟进行了优化，适用于用户之间需要频繁互动的场景。已废弃，请使用 CHANNEL_PROFILE_LIVE_BROADCASTING。
      diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setcolorenhanceoptions.dita b/dita/RTC-AIDOC/API/api_irtcengine_setcolorenhanceoptions.dita index b1238ecfc9d..4bbd88b49b8 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setcolorenhanceoptions.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setcolorenhanceoptions.dita @@ -89,7 +89,7 @@ type - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。
      • 使用摄像头采集本地视频时，使用默认值 PRIMARY_CAMERA_SOURCE。
      • 使用自定义视频源时，设置为 CUSTOM_VIDEO_SOURCE。
        • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setcolorenhanceoptions2.dita b/dita/RTC-AIDOC/API/api_irtcengine_setcolorenhanceoptions2.dita index 8615c1816fa..de92892c552 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setcolorenhanceoptions2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setcolorenhanceoptions2.dita @@ -76,7 +76,7 @@ sourceType - 应用滤镜效果的媒体源类型，详见 。 + 媒体源类型，详见 。
        • 默认值为 AgoraMediaSourceTypePrimaryCamera。
        • 如果使用自定义视频源，请将该参数设置为 AgoraMediaSourceTypeCustomVideo。
          • @@ -98,7 +98,7 @@ sourceType - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。 该参数仅支持以下两种设置：
          • 默认值为 PRIMARY_CAMERA_SOURCE。
            • @@ -122,7 +122,7 @@ sourceType - 应用滤镜效果的媒体源类型，详见 。 + 媒体源类型，详见 。
            • 默认值为 AgoraMediaSourceTypePrimaryCamera。
            • 如果使用自定义视频源，请将该参数设置为 AgoraMediaSourceTypeCustomVideo。
              • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setfaceshapeareaoptions.dita b/dita/RTC-AIDOC/API/api_irtcengine_setfaceshapeareaoptions.dita index 974e689e41d..4920d815c52 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setfaceshapeareaoptions.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setfaceshapeareaoptions.dita @@ -82,7 +82,7 @@ sourceType - 应用滤镜效果的媒体源类型，详见 。 + 媒体源类型，详见 。
              • 如果使用摄像头采集本地视频，使用默认值 AgoraMediaSourceTypePrimaryCamera。
              • 如果使用自定义视频源，将该参数设置为 AgoraMediaSourceTypeCustomVideo。
                • @@ -95,7 +95,7 @@ sourceType - 应用滤镜特效的媒体源类型，详见 。 + 媒体源类型，详见 。 在此方法中，该参数仅支持以下两种设置：
                • 如果使用摄像头采集本地视频，使用默认值 PRIMARY_CAMERA_SOURCE。
                  • @@ -110,7 +110,7 @@ sourceType - 应用滤镜效果的媒体源类型，详见 。 + 媒体源类型，详见 。
                  • 如果使用摄像头采集本地视频，使用默认值 AgoraMediaSourceTypePrimaryCamera。
                  • 如果使用自定义视频源，将该参数设置为 AgoraMediaSourceTypeCustomVideo。
                    • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setlowlightenhanceoptions.dita b/dita/RTC-AIDOC/API/api_irtcengine_setlowlightenhanceoptions.dita index 3cf4504fa50..2f8a12ffd4f 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setlowlightenhanceoptions.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setlowlightenhanceoptions.dita @@ -119,7 +119,7 @@ type - 应用滤镜效果的媒体源类型，详见 。 + 媒体源类型，详见 。 在该方法中，该参数仅支持以下两种设置：
                    • 如果使用摄像头采集本地视频，使用默认值 PRIMARY_CAMERA_SOURCE。
                      • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setlowlightenhanceoptions2.dita b/dita/RTC-AIDOC/API/api_irtcengine_setlowlightenhanceoptions2.dita index 453cc0a405f..0eab8f0b411 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setlowlightenhanceoptions2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setlowlightenhanceoptions2.dita @@ -83,7 +83,7 @@ sourceType - 应用滤镜效果的媒体源类型，详见 。 + 媒体源类型，详见 。 注意：在该方法中，该参数仅支持以下两种设置：
                      • 默认值为 AgoraMediaSourceTypePrimaryCamera。
                        • @@ -106,7 +106,7 @@ sourceType - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。 该参数仅支持以下两种设置：
                        • 默认值为 PRIMARY_CAMERA_SOURCE。
                          • @@ -130,7 +130,7 @@ sourceType - 应用滤镜效果的媒体源类型，详见 。 + 媒体源类型，详见 。 注意：在该方法中，该参数仅支持以下两种设置：
                          • 默认值为 AgoraMediaSourceTypePrimaryCamera。
                            • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setplaybackaudioframeparameters.dita b/dita/RTC-AIDOC/API/api_irtcengine_setplaybackaudioframeparameters.dita index b6f81cfb5c3..d7752f05581 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setplaybackaudioframeparameters.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setplaybackaudioframeparameters.dita @@ -15,35 +15,42 @@

                            virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall) = 0; - (int)setPlaybackAudioFrameParametersWithSampleRate:(NSInteger)sampleRate - channel:(NSInteger)channel - mode:(AgoraAudioRawFrameOperationMode)mode - samplesPerCall:(NSInteger)samplesPerCall NS_SWIFT_NAME(setPlaybackAudioFrameParametersWithSampleRate(_:channel:mode:samplesPerCall:)); + channel:(NSInteger)channel + mode:(AgoraAudioRawFrameOperationMode)mode + samplesPerCall:(NSInteger)samplesPerCall NS_SWIFT_NAME(setPlaybackAudioFrameParametersWithSampleRate(_:channel:mode:samplesPerCall:)); public abstract int setPlaybackAudioFrameParameters(int sampleRate, int channel, int mode, int samplesPerCall); - (int)setPlaybackAudioFrameParametersWithSampleRate:(NSInteger)sampleRate - channel:(NSInteger)channel - mode:(AgoraAudioRawFrameOperationMode)mode - samplesPerCall:(NSInteger)samplesPerCall NS_SWIFT_NAME(setPlaybackAudioFrameParametersWithSampleRate(_:channel:mode:samplesPerCall:)); + channel:(NSInteger)channel + mode:(AgoraAudioRawFrameOperationMode)mode + samplesPerCall:(NSInteger)samplesPerCall NS_SWIFT_NAME(setPlaybackAudioFrameParametersWithSampleRate(_:channel:mode:samplesPerCall:));

    -

    SDK 会根据该方法中设置的 samplesPerCall、sampleRate 和 channel 参数计算采样间隔：采样间隔（秒） = samplesPerCall / (sampleRate × channel)。请确保采样间隔 ≥ 0.01 秒。SDK 会根据采样间隔触发 回调。

    -

    SDK 会根据你设置的 samplesPerCall、sampleRate 和 channel 参数计算采样间隔。采样间隔（秒）= samplesPerCall / (sampleRate × channel)。请确保采样间隔 ≥ 0.01 秒。SDK 会根据采样间隔触发 onPlaybackAudioFrame: 回调。

    -

    SDK 会根据 samplesPerCall、sampleRate 和 channel 参数计算采样间隔。采样间隔（单位：秒） = samplesPerCall /（sampleRate × channel）。请确保采样间隔不小于 0.01 秒。SDK 会根据采样间隔触发 回调。

    -

    SDK 会根据你设置的 samplesPerCall、sampleRate 和 channel 参数计算采样间隔。采样间隔（秒）= samplesPerCall / (sampleRate × channel)。请确保采样间隔 ≥ 0.01 秒。SDK 会根据采样间隔触发 onPlaybackAudioFrame: 回调。

    +

    SDK 会根据 samplesPerCall、sampleRate 和 channel 参数计算采样间隔。采样间隔（单位：秒） = samplesPerCall / (sampleRate × channel)。请确保采样间隔 ≥ 0.01 秒。SDK 会根据采样间隔触发 回调。

    +

    SDK 会根据你设置的 samplesPerCall、sampleRate 和 channel 参数计算采样间隔。采样间隔（秒）= samplesPerCall / (sampleRate × channel)。请确保采样间隔 ≥ 0.01 秒。

    +

    SDK 会根据 samplesPerCall、sampleRate 和 channel 参数计算采样间隔。采样间隔（单位：秒） = samplesPerCall /（sampleRate × channel）。请确保采样间隔 ≥ 0.01 秒。SDK 会根据采样间隔触发 回调。

    +

    SDK 会根据你设置的 samplesPerCall、sampleRate 和 channel 参数计算采样间隔。采样间隔（秒）= samplesPerCall / (sampleRate × channel)。请确保采样间隔 ≥ 0.01 秒。

    调用时机

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

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

    -

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

    +

    在加入频道前调用此方法。

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

    +
    参数 sampleRate - 回调中返回的采样率。可设置为 8000、16000、32000、44100 或 48000 Hz。 + 回调中返回的采样率。可设置为 8000、16000、24000、32000、44100 或 48000 Hz。 channel @@ -60,15 +67,15 @@ samplesPerCall - 每次调用返回的数据采样数，例如媒体推流时为 1024。 + 每次回调的数据采样数，例如媒体推流时为 1024。 sampleRate - 回调中返回的采样率，可设置为 8000、16000、32000、44100 或 48000 Hz。 + 回调中返回的采样率。可设置为 8000、16000、24000、32000、44100 或 48000 Hz。 channel - 音频声道数，可设置为 1 或 2。 + 音频声道数。可设置为以下取值：
    • 1：单声道。
    • 2：立体声。
      • @@ -77,19 +84,19 @@ mode - 音频帧的使用模式，详见 。 + 音频帧的使用模式。详见 。 samplesPerCall - 每次回调返回的数据采样数，例如媒体推流时为 1024。 + 每次回调的数据采样数，例如媒体推流时为 1024。 sampleRate - 回调中返回的采样率。可设置为 8000、16000、32000、44100 或 48000 Hz。 + 回调中返回的采样率。可设置为 8000、16000、24000、32000、44100 或 48000 Hz。 channel - 音频声道数，可设置为： + 音频声道数。可设置为：
      • 1：单声道。
      • 2：立体声。
        • @@ -100,22 +107,22 @@ mode 音频帧的使用模式：
          -
        • 0：（默认）只读模式。例如，用户通过声网 SDK 获取数据后推送 RTMP 或 RTMPS 流。
          • -
        • 2：读写模式。用户从 中读取数据，修改后再播放。例如，用户有自己的音效处理模块并进行语音预处理，如变声。
          • +
        • RAW_AUDIO_FRAME_OP_MODE_READ_ONLY (0)：（默认）只读模式。例如，用户通过声网 SDK 获取数据后推送 RTMP 或 RTMPS 流。
          • +
        • RAW_AUDIO_FRAME_OP_MODE_READ_WRITE (2)：读写模式。用户从 中读取数据，修改后再播放。例如，用户有自己的音效处理模块并进行语音预处理，如变声。
         samplesPerCall - 每次调用的数据采样数，例如媒体推流时为 1024。 + 每次调用返回的数据采样数，例如媒体推流时为 1024。 sampleRate - 回调中返回的采样率，可设置为 8000、16000、32000、44100 或 48000 Hz。 + 回调中返回的采样率。可设置为 8000、16000、24000、32000、44100 或 48000 Hz。 channel - 音频声道数，可设置为 1 或 2。 + 音频声道数。可设置为以下取值：
        • 1：单声道。
        • 2：立体声。
          • @@ -124,11 +131,11 @@ mode - 音频帧的使用模式，详见 。 + 音频帧的使用模式。详见 。 samplesPerCall - 每次回调返回的数据采样数，例如媒体推流时为 1024。 + 每次回调的数据采样数，例如媒体推流时为 1024。
    diff --git a/dita/RTC-AIDOC/API/api_irtcengine_setvideodenoiseroptions2.dita b/dita/RTC-AIDOC/API/api_irtcengine_setvideodenoiseroptions2.dita index 06d6c5cf2c5..0c7fcf3e601 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_setvideodenoiseroptions2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_setvideodenoiseroptions2.dita @@ -110,7 +110,7 @@     sourceType - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。
    • 默认值为 AgoraMediaSourceTypePrimaryCamera。
    • 如果你使用自定义视频源，请将该参数设置为 AgoraMediaSourceTypeCustomVideo。
      • @@ -132,7 +132,7 @@ sourceType - 应用滤镜效果的媒体源类型，详见 。 + 媒体源类型，详见 。 在此方法中，该参数仅支持以下两种设置：
      • 默认值为 PRIMARY_CAMERA_SOURCE。
        • @@ -156,7 +156,7 @@ sourceType - 应用滤镜效果的媒体源类型。详见 。 + 媒体源类型。详见 。
        • 默认值为 AgoraMediaSourceTypePrimaryCamera。
        • 如果你使用自定义视频源，请将该参数设置为 AgoraMediaSourceTypeCustomVideo。
          • diff --git a/dita/RTC-AIDOC/API/api_irtcengine_startaudiorecording1.dita b/dita/RTC-AIDOC/API/api_irtcengine_startaudiorecording1.dita index acf5a7c506b..187597d9310 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_startaudiorecording1.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_startaudiorecording1.dita @@ -2,7 +2,7 @@ <ph keyref="startAudioRecording1"/> - 开始客户端音频录制并设置录制采样率。开始客户端录音。开始客户端录音。开始客户端录音。 + 开始客户端音频录制。开始客户端录音。开始客户端录音。开始客户端录音。 diff --git a/dita/RTC-AIDOC/API/api_irtcengine_startorupdatechannelmediarelay.dita b/dita/RTC-AIDOC/API/api_irtcengine_startorupdatechannelmediarelay.dita index 8059341da8b..e3fbd5632b7 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_startorupdatechannelmediarelay.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_startorupdatechannelmediarelay.dita @@ -57,7 +57,7 @@
          • 请在加入频道后调用该方法。
            • -
          • 该方法仅在你是极速直播频道中的主播时有效。
            • +
          • 该方法仅在你是直播频道中的主播时有效。
          • 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)启用。
          • 该方法不支持字符串用户 User Account。
          @@ -65,16 +65,16 @@
          • 请在加入频道后调用该方法。
            • -
          • 该方法仅在你是极速直播频道中的主播时生效。
            • +
          • 该方法仅在你是直播频道中的主播时生效。
          • 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。
          • 该 API 不支持字符串用户 User Account。
           - 请在加入频道后调用该方法。该方法仅在你是极速直播频道中的主播时生效。跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。该 API 不支持字符串用户 User Account。 + 请在加入频道后调用该方法。该方法仅在你是直播频道中的主播时生效。跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。该 API 不支持字符串用户 User Account。
          • 请在加入频道后调用该方法。
            • -
          • 该方法仅在你是极速直播频道中的主播时生效。
            • +
          • 该方法仅在你是直播频道中的主播时生效。
          • 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。
          • 该 API 不支持字符串用户 User Account。
          diff --git a/dita/RTC-AIDOC/API/api_irtcengine_startrtmpstreamwithtranscoding.dita b/dita/RTC-AIDOC/API/api_irtcengine_startrtmpstreamwithtranscoding.dita index 79013641f7d..54d9330c0f5 100644 --- a/dita/RTC-AIDOC/API/api_irtcengine_startrtmpstreamwithtranscoding.dita +++ b/dita/RTC-AIDOC/API/api_irtcengine_startrtmpstreamwithtranscoding.dita @@ -31,7 +31,7 @@
          • 请在加入频道后调用该方法。
            • -
          • 只有在极速直播频道场景中的主播角色可以调用该方法。
            • +
          • 只有在直播频道场景中的主播角色可以调用该方法。
          • 如果你想在推流失败后重试推流，请先调用 停止推流，再调用该方法重试，否则 SDK 会返回与上次推流失败相同的错误码。
           @@ -45,7 +45,7 @@
          • 请在加入频道后调用该方法。
            • -
          • 仅在极速直播频道场景中，主播角色可以调用该方法。
            • +
          • 仅在直播频道场景中，主播角色可以调用该方法。
          • 如果推流失败后需要重试，请先调用 停止推流，再调用该方法重新推流；否则，SDK 会返回与上次失败相同的错误码。
           diff --git a/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex.dita b/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex.dita index 8688a362ce1..83bc3fcadf2 100644 --- a/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex.dita +++ b/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex.dita @@ -2,7 +2,7 @@ <ph keyref="playEffectEx"/> - 在频道中播放指定音效。在频道中播放指定的音效。在频道中播放指定音效。在频道中播放指定的音效。 + 在频道中播放指定音效。在频道中播放指定的音效。在频道中播放指定的音效。在频道中播放指定的音效。 @@ -55,31 +55,39 @@

          你可以调用该方法在频道内向所有用户播放指定音效。每次调用该方法只能播放一个音效。若需同时播放多个音效，请使用不同的 soundId 和 filePath 多次调用该方法。你还可以设置是否在频道中发布该音效。

          -

          该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在调用 预加载音效后，可调用此方法将指定音效播放给频道内所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用该方法。

          -

          你可以调用该方法将指定音效播放给频道内的所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请使用不同的 soundId 和 filePath 多次调用该方法。你还可以设置是否在频道中发布该音效。

          -

          该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在调用 预加载音效后，可调用此方法将指定音效播放给频道内所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用该方法。

          +

          该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在通过 preloadEffectEx 预加载音效后，可调用此方法将指定音效播放给频道内所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用该方法。

          +

          你可以调用该方法在频道中向所有用户播放指定的音效。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用该方法，并为每个音效设置不同的 soundId 和 filePath 参数。

          +

          该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在通过 preloadEffectEx 预加载音效后，可调用此方法将指定音效播放给频道内所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用该方法。

          • 声网建议不要同时播放超过三个音效。
            • -
          • 该方法中的音效 ID 和文件路径必须与 方法中的保持一致。
            • +
          • 该方法中的音效 ID 和文件路径必须与 方法中的保持一致。
            • +
          • 如果在调用 之前调用了 ， 执行后不会关闭文件资源。下次调用 时会直接从头开始播放。
            • +
          • 如果在调用 之前未调用 ， 执行后会销毁资源。下次调用 时会尝试重新打开文件并从头播放。
          • 声网建议不要同时播放超过三个音效。
            • -
          • 此方法中的音效 ID 和文件路径必须与 方法中的保持一致。
            • +
          • 此方法中的音效 ID 和文件路径必须与 preloadEffectEx 方法中的保持一致。
            • +
          • 如果在执行 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时将直接从头开始播放。
            • +
          • 如果在执行 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后会销毁资源。下次执行 playEffectEx 时将尝试重新打开文件并从头播放。
          • 声网建议不要同时播放超过三个音效。
            • -
          • 该方法中的音效 ID 和文件路径必须与 preloadEffect 中的保持一致。
            • +
          • 此方法中的音效 ID 和文件路径必须与 preloadEffectEx 方法中的一致。
            • +
          • 如果在调用 playEffectEx 之前调用了 preloadEffectEx，则在 playEffectEx 执行后文件资源不会被关闭。下次调用 playEffectEx 时将从头开始播放。
            • +
          • 如果在调用 playEffectEx 之前未调用 preloadEffectEx，则在 playEffectEx 执行后资源将被销毁。下次调用 playEffectEx 时将尝试重新打开文件并从头开始播放。
          • 声网建议不要同时播放超过三个音效。
            • -
          • 此方法中的音效 ID 和文件路径必须与 方法中的保持一致。
            • +
          • 此方法中的音效 ID 和文件路径必须与 preloadEffectEx 方法中的保持一致。
            • +
          • 如果在执行 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时将直接从头开始播放。
            • +
          • 如果在执行 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后会销毁资源。下次执行 playEffectEx 时将尝试重新打开文件并从头播放。
           @@ -145,23 +153,23 @@ connection - 连接对象，详见 。 + 对象。详见 。 soundId - 音效的 ID。每个音效文件的唯一标识。如果通过 方法将音效预加载到内存中，请确保该参数值与 方法中的值一致。 + 音效的 ID。每个音效文件的唯一标识。如果通过 preloadEffectEx 方法将音效预加载到内存中，请确保该参数值与 preloadEffectEx 方法中的值一致。 filePath - 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 /var/mobile/Containers/Data/audio.mp4。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 + 本地音效文件的绝对路径（包括文件扩展名）或在线音效文件的 URL，例如 /var/mobile/Containers/Data/audio.mp4。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount - 音效的循环播放次数： + 设置音效的循环次数：
          • 0：播放一次。
          • 1：播放两次。
            • -
          • -1：无限循环，直到调用 或 。
            • +
          • -1：无限循环，直到调用 stopEffect 或 。
                     @@ -198,7 +206,7 @@ connection - 连接信息。详见 。 + 连接信息，详见 。 soundId @@ -226,15 +234,15 @@ pan 音效的空间位置。取值范围为 -1.0 到 1.0：
            -
          • -1.0：音效从用户左侧传来。
            • -
          • 0.0：音效从用户正前方传来。
            • -
          • 1.0：音效从用户右侧传来。
            • +
          • -1.0：音效从用户左侧播放。
            • +
          • 0.0：音效从用户正前方播放。
            • +
          • 1.0：音效从用户右侧播放。
                     gain - 音效的音量。取值范围为 0.0 到 100.0，默认值为 100.0（原始音量）。值越小，音量越低。 + 音效的音量。取值范围为 0.0 到 100.0，默认值为 100（原始音量）。值越小，音量越低。 publish @@ -247,27 +255,27 @@ startPos - 音效文件的播放起始位置，单位为毫秒。 + 音效文件的播放起始位置（单位为毫秒）。 connection - 连接对象，详见 。 + 对象。详见 。 soundId - 音效的 ID。每个音效文件的唯一标识。如果通过 方法将音效预加载到内存中，请确保该参数值与 方法中的值一致。 + 音效的 ID。每个音效文件的唯一标识。如果通过 preloadEffectEx 方法将音效预加载到内存中，请确保该参数值与 preloadEffectEx 方法中的值一致。 filePath - 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 /var/mobile/Containers/Data/audio.mp4。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 + 本地音效文件的绝对路径（包括文件扩展名）或在线音效文件的 URL，例如 /var/mobile/Containers/Data/audio.mp4。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount - 音效的循环播放次数： + 设置音效的循环次数：
          • 0：播放一次。
          • 1：播放两次。
            • -
          • -1：无限循环，直到调用 或 。
            • +
          • -1：无限循环，直到调用 stopEffect 或 。
                     diff --git a/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex2.dita b/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex2.dita index 68643b4ecf0..d2eeb0a0857 100644 --- a/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex2.dita @@ -14,22 +14,22 @@

          - (int)playEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain - publish:(BOOL)publish NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:publish:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain + publish:(BOOL)publish NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:publish:)); public abstract int playEffectEx(RtcConnection connection, int soundId, String filePath, int loopCount, double pitch, double pan, double gain, boolean publish); - (int)playEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain - publish:(BOOL)publish NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:publish:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain + publish:(BOOL)publish NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:publish:));

          @@ -47,25 +47,31 @@
          自 v4.6.0 版本新增。
          -

          该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在调用 预加载音效后，可调用此方法将指定音效播放给频道内所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用该方法。

          -

          调用 preloadEffect 预加载音效后，你可以调用 playEffectEx 将指定音效播放给频道内所有用户。每次调用该方法只能播放一个音效，若需同时播放多个音效，请使用不同的 soundId 和 filePath 多次调用该方法。

          -

          该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在调用 预加载音效后，可调用此方法将指定音效播放给频道内所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用该方法。

          +

          该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在通过 preloadEffectEx:filePath: 预加载音效后，可调用此方法将指定音效播放给频道中的所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用此方法。

          +

          调用 preloadEffectEx 预加载音效后，可以使用该方法将指定音效播放给频道中的所有用户。你可以多次调用该方法，并传入不同的 soundId 和 filePath，以同时播放多个音效文件。每次调用该方法只能播放一个音效。

          +

          该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在通过 preloadEffectEx:filePath: 预加载音效后，可调用此方法将指定音效播放给频道中的所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用此方法。

          • 声网建议不要同时播放超过三个音效。
            • -
          • 本方法中的音效 ID 和文件路径必须与 中的保持一致。
            • +
          • 此方法中的 soundId 和 filePath 必须与 preloadEffectEx:filePath: 方法中的保持一致。
            • +
          • 如果在执行 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时将直接从头开始播放。
            • +
          • 如果在执行 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后资源将被销毁。下次执行 playEffectEx 时将尝试重新打开文件并从头播放。
          • 声网建议不要同时播放超过三个音效。
            • -
          • 本方法中的音效 ID 和文件路径必须与 preloadEffect 中保持一致。
            • +
          • 本方法中的音效 ID 和文件路径必须与 preloadEffectEx 方法中保持一致。
            • +
          • 如果在调用 playEffectEx 之前调用了 preloadEffectEx，则在 playEffectEx 执行后文件资源不会被关闭。下次调用 playEffectEx 时将从头开始播放。
            • +
          • 如果在调用 playEffectEx 之前未调用 preloadEffectEx，则在 playEffectEx 执行后资源将被销毁。下次调用 playEffectEx 时将尝试重新打开文件并从头播放。
          • 声网建议不要同时播放超过三个音效。
            • -
          • 本方法中的音效 ID 和文件路径必须与 中的保持一致。
            • +
          • 此方法中的 soundId 和 filePath 必须与 preloadEffectEx:filePath: 方法中的保持一致。
            • +
          • 如果在执行 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时将直接从头开始播放。
            • +
          • 如果在执行 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后资源将被销毁。下次执行 playEffectEx 时将尝试重新打开文件并从头播放。
          @@ -78,19 +84,19 @@ connection - 连接对象。详见 。 + 对象。详见 。 soundId - 音效的 ID。每个音效文件的唯一标识。如果通过 将音效预加载到内存中，请确保该参数值与 中的值一致。 + 音效的 ID。每个音效文件的唯一 ID。请确保该参数值与 preloadEffectEx:filePath: 方法中的值一致。 filePath - 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 /var/mobile/Containers/Data/audio.mp4。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。 + 本地音效文件的绝对路径（包括文件扩展名）或在线音效文件的 URL，例如 。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount - 音效的循环播放次数： + 设置音效的循环播放次数：
          • 0：播放一次。
          • 1：播放两次。
            • @@ -106,9 +112,9 @@ pan 音效的空间位置。取值范围为 -1.0 到 1.0：
              -
            • 0.0：音效从用户正前方传来。
              • -
            • 1.0：音效从用户右侧传来。
              • -
            • -1.0：音效从用户左侧传来。
              • +
            • 0.0：音效从你正前方传来。
              • +
            • 1.0：音效从你右侧传来。
              • +
            • -1.0：音效从你左侧传来。
             @@ -127,7 +133,7 @@ connection - 连接信息。详见 。 + 连接信息，详见 。 soundId @@ -135,7 +141,7 @@ filePath - 本地文件的绝对路径或在线文件的 URL。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 + 本地文件的绝对路径或在线文件的 URL。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount @@ -149,21 +155,21 @@ pitch - 音效的音调。取值范围为 0.5 到 2.0，默认值为 1.0（原始音调）。数值越小，音调越低。 + 音效的音调。取值范围为 0.5 到 2.0，默认值为 1.0（原始音调）。值越小，音调越低。 pan 音效的空间位置。取值范围为 -1.0 到 1.0：
              -
            • -1.0：音效从用户左侧传来。
              • -
            • 0.0：音效从用户正前方传来。
              • -
            • 1.0：音效从用户右侧传来。
              • +
            • -1.0：音效从用户左侧播放。
              • +
            • 0.0：音效从用户正前方播放。
              • +
            • 1.0：音效从用户右侧播放。
                         gain - 音效的音量。取值范围为 0.0 到 100.0，默认值为 100（原始音量）。数值越小，音量越低。 + 音效的音量。取值范围为 0.0 到 100.0，默认值为 100（原始音量）。值越小，音量越低。 publish @@ -176,19 +182,19 @@ connection - 连接对象。详见 。 + 对象。详见 。 soundId - 音效的 ID。每个音效文件的唯一标识。如果通过 将音效预加载到内存中，请确保该参数值与 中的值一致。 + 音效的 ID。每个音效文件的唯一 ID。请确保该参数值与 preloadEffectEx:filePath: 方法中的值一致。 filePath - 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 /var/mobile/Containers/Data/audio.mp4。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。 + 本地音效文件的绝对路径（包括文件扩展名）或在线音效文件的 URL，例如 。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount - 音效的循环播放次数： + 设置音效的循环播放次数：
            • 0：播放一次。
            • 1：播放两次。
              • @@ -204,9 +210,9 @@ pan 音效的空间位置。取值范围为 -1.0 到 1.0：
                -
              • 0.0：音效从用户正前方传来。
                • -
              • 1.0：音效从用户右侧传来。
                • -
              • -1.0：音效从用户左侧传来。
                • +
              • 0.0：音效从你正前方传来。
                • +
              • 1.0：音效从你右侧传来。
                • +
              • -1.0：音效从你左侧传来。
               diff --git a/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex3.dita b/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex3.dita index 7f7ec4c0600..1ea83d1bc3b 100644 --- a/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex3.dita +++ b/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex3.dita @@ -14,21 +14,21 @@

              - (int)playEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain - startPos:(int)startPos NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:startPos:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain + startPos:(int)startPos NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:startPos:)); - (int)playEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain - startPos:(int)startPos NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:startPos:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain + startPos:(int)startPos NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:startPos:));

              @@ -42,18 +42,22 @@
              自 v4.6.0 版本新增。
              -

              该方法用于设置是否在频道中发布音效。要同时播放多个音效文件，你只需使用不同的 soundId 和 filePath 多次调用该方法。在调用 预加载音效后，可以调用此方法将指定音效播放给频道中的所有用户。每次调用该方法只能播放一个音效。要同时播放多个音效，请多次调用该方法。

              -

              该方法用于设置是否在频道中发布音效。要同时播放多个音效文件，你只需使用不同的 soundId 和 filePath 多次调用该方法。在调用 预加载音效后，可以调用此方法将指定音效播放给频道中的所有用户。每次调用该方法只能播放一个音效。要同时播放多个音效，请多次调用该方法。

              +

              你可以使用该方法在频道中播放指定的音效。若需同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用该方法。在调用 preloadEffectEx:filePath: 预加载音效后，你可以调用该方法将音效播放给频道内所有用户。每次调用该方法只能播放一个音效，若需同时播放多个音效，请多次调用该方法。

              +

              你可以使用该方法在频道中播放指定的音效。若需同时播放多个音效文件，请使用不同的 soundId 和 filePath 多次调用该方法。在调用 preloadEffectEx:filePath: 预加载音效后，你可以调用该方法将音效播放给频道内所有用户。每次调用该方法只能播放一个音效，若需同时播放多个音效，请多次调用该方法。

                -
              • 声网建议不要同时播放超过三个音效。
                • -
              • 此方法中的音效 ID 和文件路径必须与 中的保持一致。
                • +
              • 声网建议你不要同时播放超过三个音效。
                • +
              • 此方法中的音效 ID 和文件路径必须与 preloadEffectEx:filePath: 方法中的保持一致。
                • +
              • 如果在执行 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时将直接从头开始播放。
                • +
              • 如果在执行 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后资源将被销毁。下次执行 playEffectEx 时将尝试重新打开文件并从头播放。
                -
              • 声网建议不要同时播放超过三个音效。
                • -
              • 此方法中的音效 ID 和文件路径必须与 中的保持一致。
                • +
              • 声网建议你不要同时播放超过三个音效。
                • +
              • 此方法中的音效 ID 和文件路径必须与 preloadEffectEx:filePath: 方法中的保持一致。
                • +
              • 如果在执行 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时将直接从头开始播放。
                • +
              • 如果在执行 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后资源将被销毁。下次执行 playEffectEx 时将尝试重新打开文件并从头播放。
              @@ -66,15 +70,15 @@ connection - 连接对象。详见 。 + 对象。详见 。 soundId - 音效的 ID。每个音效文件的唯一标识。如果通过 将音效预加载到内存中，请确保该参数值与 中的值一致。 + 音效的 ID。每个音效文件的唯一标识。请确保该参数值与 preloadEffectEx:filePath: 方法中的值一致。 filePath - 本地音效文件的绝对路径（包括文件扩展名）或在线音效文件的 URL，例如 。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 + 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount @@ -94,9 +98,9 @@ pan 音效的空间位置。取值范围为 -1.0 到 1.0：
                -
              • 0.0：音效从用户正前方传来。
                • -
              • 1.0：音效从用户右侧传来。
                • -
              • -1.0：音效从用户左侧传来。
                • +
              • 0.0：音效从你正前方传来。
                • +
              • 1.0：音效从你右侧传来。
                • +
              • -1.0：音效从你左侧传来。
                             @@ -106,19 +110,19 @@ startPos - 音效文件的播放起始位置，单位为毫秒。 + 音效文件的播放起始位置（单位为毫秒）。 connection - 连接对象。详见 。 + 对象。详见 。 soundId - 音效的 ID。每个音效文件的唯一标识。如果通过 将音效预加载到内存中，请确保该参数值与 中的值一致。 + 音效的 ID。每个音效文件的唯一标识。请确保该参数值与 preloadEffectEx:filePath: 方法中的值一致。 filePath - 本地音效文件的绝对路径（包括文件扩展名）或在线音效文件的 URL，例如 。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 + 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount @@ -138,9 +142,9 @@ pan 音效的空间位置。取值范围为 -1.0 到 1.0：
                -
              • 0.0：音效从用户正前方传来。
                • -
              • 1.0：音效从用户右侧传来。
                • -
              • -1.0：音效从用户左侧传来。
                • +
              • 0.0：音效从你正前方传来。
                • +
              • 1.0：音效从你右侧传来。
                • +
              • -1.0：音效从你左侧传来。
                             @@ -150,7 +154,7 @@ startPos - 音效文件的播放起始位置，单位为毫秒。 + 音效文件的播放起始位置（单位为毫秒）。               diff --git a/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex4.dita b/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex4.dita index f77fb3db8e9..c1b1fa12709 100644 --- a/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex4.dita +++ b/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex4.dita @@ -14,19 +14,19 @@

              - (int)playEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:)); - (int)playEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath - loopCount:(NSInteger)loopCount - pitch:(double)pitch - pan:(double)pan - gain:(NSInteger)gain NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath + loopCount:(NSInteger)loopCount + pitch:(double)pitch + pan:(double)pan + gain:(NSInteger)gain NS_SWIFT_NAME(playEffectEx(_:soundId:filePath:loopCount:pitch:pan:gain:));

              @@ -40,18 +40,22 @@
              自 v4.6.0 版本新增。
              -

              你可以通过该方法设置是否在频道中发布音效。调用 预加载音效后，再调用此方法即可将指定音效播放给频道中的所有用户。每次调用该方法只能播放一个音效，如需同时播放多个音效，请使用不同的 soundId 和 filePath 多次调用该方法。

              -

              你可以通过该方法设置是否在频道中发布音效。调用 预加载音效后，再调用此方法即可将指定音效播放给频道中的所有用户。每次调用该方法只能播放一个音效，如需同时播放多个音效，请使用不同的 soundId 和 filePath 多次调用该方法。

              +

              该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在通过 preloadEffectEx:filePath: 预加载音效后，可以调用此方法将指定音效播放给频道中的所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用该方法。

              +

              该方法用于设置是否在频道中发布音效。若需同时播放多个音效文件，只需使用不同的 soundId 和 filePath 多次调用该方法。在通过 preloadEffectEx:filePath: 预加载音效后，可以调用此方法将指定音效播放给频道中的所有用户。每次调用该方法只能播放一个音效。若需同时播放多个音效，请多次调用该方法。

              • 声网建议不要同时播放超过三个音效。
                • -
              • 此方法中的音效 ID 和文件路径必须与 方法中的保持一致。
                • +
              • 此方法中的音效 ID 和文件路径必须与 preloadEffectEx:filePath: 方法中的保持一致。
                • +
              • 如果在执行 playEffectEx 之前调用了 preloadEffectEx:filePath:，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时将直接从头开始播放。
                • +
              • 如果在执行 playEffectEx 之前未调用 preloadEffectEx:filePath:，则 playEffectEx 执行后会销毁资源。下次执行 playEffectEx 时将尝试重新打开文件并从头播放。
              • 声网建议不要同时播放超过三个音效。
                • -
              • 此方法中的音效 ID 和文件路径必须与 方法中的保持一致。
                • +
              • 此方法中的音效 ID 和文件路径必须与 preloadEffectEx:filePath: 方法中的保持一致。
                • +
              • 如果在执行 playEffectEx 之前调用了 preloadEffectEx:filePath:，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时将直接从头开始播放。
                • +
              • 如果在执行 playEffectEx 之前未调用 preloadEffectEx:filePath:，则 playEffectEx 执行后会销毁资源。下次执行 playEffectEx 时将尝试重新打开文件并从头播放。
              @@ -64,19 +68,19 @@ connection - 连接对象。详见 。 + 对象。详见 。 soundId - 音效的 ID。每个音效文件的唯一标识。若通过 预加载音效，请确保该参数值与预加载时一致。 + 音效的 ID。每个音效文件的唯一标识。请确保该参数值与 preloadEffectEx:filePath: 方法中的值一致。 filePath - 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 /var/mobile/Containers/Data/audio.mp4。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 + 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount - 设置音效的循环次数： + 设置音效的循环播放次数：
              • 0：播放一次。
              • 1：播放两次。
                • @@ -92,9 +96,9 @@ pan 音效的空间位置。取值范围为 -1.0 到 1.0：
                  -
                • 0.0：音效从你正前方传来。
                  • -
                • 1.0：音效从你右侧传来。
                  • -
                • -1.0：音效从你左侧传来。
                  • +
                • 0.0：音效从用户正前方传来。
                  • +
                • 1.0：音效从用户右侧传来。
                  • +
                • -1.0：音效从用户左侧传来。
                 @@ -104,19 +108,19 @@ connection - 连接对象。详见 。 + 对象。详见 。 soundId - 音效的 ID。每个音效文件的唯一标识。若通过 预加载音效，请确保该参数值与预加载时一致。 + 音效的 ID。每个音效文件的唯一标识。请确保该参数值与 preloadEffectEx:filePath: 方法中的值一致。 filePath - 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 /var/mobile/Containers/Data/audio.mp4。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。 + 本地音效文件的绝对路径（包含文件扩展名）或在线音效文件的 URL，例如 。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。 loopCount - 设置音效的循环次数： + 设置音效的循环播放次数：
                • 0：播放一次。
                • 1：播放两次。
                  • @@ -132,9 +136,9 @@ pan 音效的空间位置。取值范围为 -1.0 到 1.0：
                    -
                  • 0.0：音效从你正前方传来。
                    • -
                  • 1.0：音效从你右侧传来。
                    • -
                  • -1.0：音效从你左侧传来。
                    • +
                  • 0.0：音效从用户正前方传来。
                    • +
                  • 1.0：音效从用户右侧传来。
                    • +
                  • -1.0：音效从用户左侧传来。
                   diff --git a/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex.dita b/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex.dita index 9c50732def9..a88c461de30 100644 --- a/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex.dita +++ b/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex.dita @@ -2,7 +2,7 @@ <ph keyref="preloadEffectEx"/> - 预加载指定音效文件到频道。预加载指定的音效文件到频道中。预加载指定音效文件到频道中。预加载指定的音效文件到频道中。 + 将指定音效预加载到频道中。预加载指定的音效文件到频道中。将指定音效预加载到频道中。预加载指定的音效文件到频道中。 @@ -15,14 +15,14 @@

                  virtual int preloadEffectEx(const RtcConnection& connection, int soundId, const char* filePath, int startPos = 0) = 0; - (int)preloadEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath - startPos:(int)startPos NS_SWIFT_NAME(preloadEffectEx(_:soundId:filePath:startPos:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath + startPos:(int)startPos NS_SWIFT_NAME(preloadEffectEx(_:soundId:filePath:startPos:)); public abstract int preloadEffectEx(RtcConnection connection, int soundId, String filePath, int startPos); - (int)preloadEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath - startPos:(int)startPos NS_SWIFT_NAME(preloadEffectEx(_:soundId:filePath:startPos:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath + startPos:(int)startPos NS_SWIFT_NAME(preloadEffectEx(_:soundId:filePath:startPos:));

                  @@ -44,32 +44,40 @@
                  自 v4.6.0 版本新增。
                  -

                  每次调用该方法只能将一个音效文件预加载到内存中。如果你需要预加载多个音效文件，请多次调用该方法。预加载完成后，你可以调用 播放指定音效，或调用 播放所有已预加载的音效。

                  +

                  每次调用该方法时，只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。预加载完成后，可以调用 播放预加载的音效，或调用 播放所有预加载的音效。

                  每次调用该方法时，只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。预加载完成后，可以调用 playEffect 播放预加载的音效，或调用 playAllEffects 播放所有预加载的音效。

                  -

                  每次调用该方法只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。你可以调用 playEffect 播放预加载的音效，或调用 播放所有预加载的音效。

                  +

                  每次调用该方法时，只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。预加载完成后，可以调用 playEffect 播放预加载的音效，或调用 播放所有预加载的音效。

                  每次调用该方法时，只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。预加载完成后，可以调用 playEffect 播放预加载的音效，或调用 playAllEffects 播放所有预加载的音效。

                  • 为确保使用体验流畅，音效文件的大小不应超过限制。
                    • -
                  • 声网建议你在加入频道前调用该方法。
                    • +
                  • 声网建议在加入频道前调用该方法。
                    • +
                  • 如果在调用 前已调用 ，则 执行后不会关闭文件资源。下次调用 时会直接从头开始播放。
                    • +
                  • 如果在调用 前未调用 ，则 执行后会销毁资源。下次调用 时会尝试重新打开文件并从头开始播放。
                  • 为确保使用体验流畅，音效文件的大小不应超过限制。
                    • -
                  • 声网建议你在加入频道前调用该方法。
                    • +
                  • 声网建议在加入频道前调用该方法。
                    • +
                  • 如果在调用 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时会直接从头开始播放。
                    • +
                  • 如果在调用 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后会销毁资源。下次执行 playEffectEx 时会尝试重新打开文件并从头开始播放。
                  • 为确保使用体验流畅，音效文件的大小不应超过限制。
                    • -
                  • 声网建议你在加入频道前调用该方法。
                    • +
                  • 声网建议在加入频道前调用该方法。
                    • +
                  • 如果在调用 playEffectEx 前已调用 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次调用 playEffectEx 时将从头开始播放。
                    • +
                  • 如果在调用 playEffectEx 前未调用 preloadEffectEx，则 playEffectEx 执行后会销毁文件资源。下次调用 playEffectEx 时将尝试重新打开文件并从头开始播放。
                  • 为确保使用体验流畅，音效文件的大小不应超过限制。
                    • -
                  • 声网建议你在加入频道前调用该方法。
                    • +
                  • 声网建议在加入频道前调用该方法。
                    • +
                  • 如果在调用 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时会直接从头开始播放。
                    • +
                  • 如果在调用 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后会销毁资源。下次执行 playEffectEx 时会尝试重新打开文件并从头开始播放。
                  @@ -114,7 +122,7 @@ connection - 连接信息。详见 。 + 连接信息，详见 。 soundId diff --git a/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex2.dita b/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex2.dita index 4a2f45b911b..721a858ea64 100644 --- a/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex2.dita +++ b/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex2.dita @@ -2,7 +2,7 @@ <ph keyref="preloadEffectEx2"/> - 预加载指定的音效文件到频道中。预加载指定音效文件到频道中。预加载指定的音效文件到频道中。 + 预加载指定的音效文件到频道中。将指定音效预加载到频道中。预加载指定的音效文件到频道中。 @@ -14,12 +14,12 @@

                  - (int)preloadEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath NS_SWIFT_NAME(preloadEffectEx(_:soundId:filePath:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath NS_SWIFT_NAME(preloadEffectEx(_:soundId:filePath:)); public abstract int preloadEffectEx(RtcConnection connection, int soundId, String filePath); - (int)preloadEffectEx:(AgoraRtcConnection* _Nonnull)connection - soundId:(int)soundId - filePath:(NSString* _Nonnull)filePath NS_SWIFT_NAME(preloadEffectEx(_:soundId:filePath:)); + soundId:(int)soundId + filePath:(NSString* _Nonnull)filePath NS_SWIFT_NAME(preloadEffectEx(_:soundId:filePath:));

                  @@ -37,25 +37,31 @@
                  自 v4.6.0 版本新增。
                  -

                  每次调用该方法只能将一个音效文件预加载到内存中。如果你需要预加载多个音效文件，请多次调用该方法。预加载完成后，你可以调用 playEffect 播放预加载的音效，或调用 playAllEffects 播放所有预加载的音效。

                  -

                  每次调用该方法时只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。预加载完成后，你可以调用 playEffect 播放预加载的音效，或调用 播放所有预加载的音效。

                  -

                  每次调用该方法只能将一个音效文件预加载到内存中。如果你需要预加载多个音效文件，请多次调用该方法。预加载完成后，你可以调用 playEffect 播放预加载的音效，或调用 playAllEffects 播放所有预加载的音效。

                  +

                  每次调用该方法时，你只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。预加载完成后，你可以调用 播放预加载的音效，或调用 playAllEffects:loopCount:pitch:pan:gain:publish: 播放所有预加载的音效。

                  +

                  每次调用该方法时只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。预加载完成后，可以调用 playEffect 播放预加载的音效，或调用 播放所有预加载的音效。

                  +

                  每次调用该方法时，你只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。预加载完成后，你可以调用 播放预加载的音效，或调用 playAllEffects:loopCount:pitch:pan:gain:publish: 播放所有预加载的音效。

                  • 为确保使用体验流畅，音效文件的大小不应超过限制。
                  • 声网建议你在加入频道前调用该方法。
                    • +
                  • 如果在调用 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时会直接从头开始播放。
                    • +
                  • 如果在调用 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后会销毁资源。下次执行 playEffectEx 时会尝试重新打开文件并从头开始播放。
                  • 为确保使用体验流畅，音效文件的大小不应超过限制。
                    • -
                  • 声网建议你在加入频道前调用该方法。
                    • +
                  • 声网建议在加入频道前调用该方法。
                    • +
                  • 如果在调用 playEffectEx 之前调用了 preloadEffectEx，则在 playEffectEx 执行后文件资源不会被关闭。下次调用 playEffectEx 时将从头开始播放。
                    • +
                  • 如果在调用 playEffectEx 之前未调用 preloadEffectEx，则在 playEffectEx 执行后资源将被销毁。下次调用 playEffectEx 时将尝试重新打开文件并从头开始播放。
                  • 为确保使用体验流畅，音效文件的大小不应超过限制。
                  • 声网建议你在加入频道前调用该方法。
                    • +
                  • 如果在调用 playEffectEx 之前调用了 preloadEffectEx，则 playEffectEx 执行后不会关闭文件资源。下次执行 playEffectEx 时会直接从头开始播放。
                    • +
                  • 如果在调用 playEffectEx 之前未调用 preloadEffectEx，则 playEffectEx 执行后会销毁资源。下次执行 playEffectEx 时会尝试重新打开文件并从头开始播放。
                  @@ -68,7 +74,7 @@ connection - 连接对象。详见 。 + 连接信息。详见 。 soundId @@ -92,7 +98,7 @@ connection - 连接对象。详见 。 + 连接信息。详见 。 soundId diff --git a/dita/RTC-AIDOC/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/dita/RTC-AIDOC/API/api_irtcengineex_startorupdatechannelmediarelayex.dita index 1c8fa00efab..fe2e90024c9 100644 --- a/dita/RTC-AIDOC/API/api_irtcengineex_startorupdatechannelmediarelayex.dita +++ b/dita/RTC-AIDOC/API/api_irtcengineex_startorupdatechannelmediarelayex.dita @@ -50,7 +50,7 @@
                  • 请在加入频道后调用该方法。
                    • -
                  • 该方法仅在你是极速直播频道中的主播时生效。
                    • +
                  • 该方法仅在你是直播频道中的主播时生效。
                  • 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)启用。
                  • 该方法不支持字符串用户 User Account。
                  @@ -58,7 +58,7 @@
                  • 请在加入频道后调用该方法。
                    • -
                  • 该方法仅在你是极速直播频道中的主播时生效。
                    • +
                  • 该方法仅在你是直播频道中的主播时生效。
                  • 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。
                  • 该 API 不支持字符串用户 User Account。
                  @@ -66,7 +66,7 @@
                  • 请在加入频道后调用该方法。
                    • -
                  • 该方法仅在你是极速直播频道中的主播时有效。
                    • +
                  • 该方法仅在你是直播频道中的主播时有效。
                  • 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。
                  • 该 API 不支持字符串用户 User Account。
                  @@ -74,7 +74,7 @@
                  • 请在加入频道后调用该方法。
                    • -
                  • 该方法仅在你是极速直播频道中的主播时生效。
                    • +
                  • 该方法仅在你是直播频道中的主播时生效。
                  • 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。
                  • 该 API 不支持字符串用户 User Account。
                  diff --git a/dita/RTC-AIDOC/API/api_ivideoeffectobject_addorupdatevideoeffect.dita b/dita/RTC-AIDOC/API/api_ivideoeffectobject_addorupdatevideoeffect.dita index 73890a1cb8f..c405e91f49c 100644 --- a/dita/RTC-AIDOC/API/api_ivideoeffectobject_addorupdatevideoeffect.dita +++ b/dita/RTC-AIDOC/API/api_ivideoeffectobject_addorupdatevideoeffect.dita @@ -44,35 +44,35 @@ NS_SWIFT_NAME(addOrUpdateVideoEffect(nodeId:templateName:)); 优先级规则：
                    -
                  • VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP 节点优先于 VIDEO_EFFECT_NODE_ID::FILTER 参数。
                    • -
                  • 若要应用 VIDEO_EFFECT_NODE_ID::FILTER 参数，必须先移除 VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP 节点：
                    • +
                  • 风格妆 (VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP) 节点优先于滤镜特效 (VIDEO_EFFECT_NODE_ID::FILTER) 节点。
                    • +
                  • 若要应用滤镜特效，必须先移除风格妆特效节点：
                  removeVideoEffect(VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP); addOrUpdateVideoEffect(VIDEO_EFFECT_NODE_ID::FILTER, "template name");                   优先级规则：
                    -
                  • 视频特效节点 VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP 的优先级高于 VIDEO_EFFECT_NODE_ID::FILTER。
                    • -
                  • 若要应用 VIDEO_EFFECT_NODE_ID::FILTER，必须先移除 VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP：
                    • +
                  • 风格妆节点 AgoraVideoEffectNodeStyleMakeup 的优先级高于滤镜特效 AgoraVideoEffectNodeFilter 节点。
                    • +
                  • 若要应用滤镜特效，必须先移除风格妆特效节点：
                  - removeVideoEffect(VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP); -addOrUpdateVideoEffect(VIDEO_EFFECT_NODE_ID::FILTER, "template name"); + [self removeVideoEffectWithNodeId:AgoraVideoEffectNodeStyleMakeup]; +[self addOrUpdateVideoEffectWithNodeId:AgoraVideoEffectNodeFilter templateName:@"template name"];                   优先级规则：
                    -
                  • 风格妆特效节点优先于 FILTER 参数。
                    • -
                  • 若要应用 FILTER 参数，必须先移除风格妆特效节点：
                    • +
                  • 风格妆 (STYLE_MAKEUP) 节点优先于滤镜特效 (FILTER) 节点。
                    • +
                  • 若要应用滤镜特效，必须先移除风格妆特效节点：
                  - removeVideoEffect(`STYLE_MAKEUP`); -addOrUpdateVideoEffect(`FILTER`, "template name"); + removeVideoEffect(VIDEO_EFFECT_NODE_ID.STYLE_MAKEUP); +addOrUpdateVideoEffect(VIDEO_EFFECT_NODE_ID.FILTER, "template name");                   优先级规则：
                    -
                  • 视频特效节点 VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP 的优先级高于 VIDEO_EFFECT_NODE_ID::FILTER。
                    • -
                  • 若要应用 VIDEO_EFFECT_NODE_ID::FILTER，必须先移除 VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP：
                    • +
                  • 风格妆节点 AgoraVideoEffectNodeStyleMakeup 的优先级高于滤镜特效 AgoraVideoEffectNodeFilter 节点。
                    • +
                  • 若要应用滤镜特效，必须先移除风格妆特效节点：
                  - removeVideoEffect(VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP); -addOrUpdateVideoEffect(VIDEO_EFFECT_NODE_ID::FILTER, "template name"); + [self removeVideoEffectWithNodeId:AgoraVideoEffectNodeStyleMakeup]; +[self addOrUpdateVideoEffectWithNodeId:AgoraVideoEffectNodeFilter templateName:@"template name"];
                  @@ -96,8 +96,8 @@ addOrUpdateVideoEffect(VIDEO_EFFECT_NODE_ID::FILTER, "template name");nodeId 视频特效节点的唯一标识符或标识符组合。例如：
                    -
                  • 单个特效：VIDEO_EFFECT_NODE_ID::BEAUTY。
                    • -
                  • 组合特效：VIDEO_EFFECT_NODE_ID::BEAUTY | VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP。
                    • +
                  • 单个特效：AgoraVideoEffectNodeBeauty。
                    • +
                  • 组合特效：AgoraVideoEffectNodeBeauty ｜ AgoraVideoEffectNodeStyleMakeup ｜ AgoraVideoEffectNodeFilter。
                   @@ -107,7 +107,12 @@ addOrUpdateVideoEffect(VIDEO_EFFECT_NODE_ID::FILTER, "template name"); nodeId - 视频特效节点的唯一标识符或标识符组合。详见 。 + 视频特效节点的唯一标识符或标识符组合。详见 。例如： +
                    +
                  • 单个特效：VIDEO_EFFECT_NODE_ID.BEAUTY。
                    • +
                  • 组合特效：VIDEO_EFFECT_NODE_ID.BEAUTY | VIDEO_EFFECT_NODE_ID.STYLE_MAKEUP。
                    • +
                  +                   templateName @@ -117,8 +122,8 @@ addOrUpdateVideoEffect(VIDEO_EFFECT_NODE_ID::FILTER, "template name");nodeId 视频特效节点的唯一标识符或标识符组合。例如：
                    -
                  • 单个特效：VIDEO_EFFECT_NODE_ID::BEAUTY。
                    • -
                  • 组合特效：VIDEO_EFFECT_NODE_ID::BEAUTY | VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP。
                    • +
                  • 单个特效：AgoraVideoEffectNodeBeauty。
                    • +
                  • 组合特效：AgoraVideoEffectNodeBeauty ｜ AgoraVideoEffectNodeStyleMakeup ｜ AgoraVideoEffectNodeFilter。
                                     diff --git a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita index 4f75a519e3a..2385f84d8c1 100644 --- a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita +++ b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita @@ -2,7 +2,7 @@ <ph keyref="onJoinChannelSuccess"/> - 本地用户成功加入频道回调。本地用户成功加入频道回调。远端用户成功加入频道回调。本地用户成功加入频道回调。 + 本地用户成功加入频道回调。本地用户成功加入频道回调。本地用户成功加入频道回调。本地用户成功加入频道回调。 diff --git a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onlocalvideoevent.dita b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onlocalvideoevent.dita new file mode 100644 index 00000000000..66688ef9523 --- /dev/null +++ b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onlocalvideoevent.dita @@ -0,0 +1,59 @@ + + + + <ph keyref="onLocalVideoEvent"/> + 本地视频事件发生时触发的回调。本地视频事件发生时触发的回调。 + + + + + + + + +
                  +

                  + virtual void onLocalVideoEvent(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_EVENT_TYPE event) + public void onLocalVideoEvent(Constants.VideoSourceType source, int event) +

                  +
                  +
                  +
                  + +
                  自从
                  +
                  自 v4.6.1 版本新增。
                  +                   +
                  +

                  你可以通过该回调获取本地视频事件的原因。

                  +

                  你可以通过该回调获取本地视频事件发生的原因。

                  +
                  +
                  + 参数 + + + source + 视频源类型，详见 。 + + + event + 本地视频事件类型，详见 。 + + + source + 视频源的类型。详见 。 + + + event + 本地视频事件类型： +
                    +
                  • LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_HIDDEN：屏幕采集窗口被隐藏。
                    • +
                  • LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN：屏幕采集窗口从隐藏状态恢复。
                    • +
                  • LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_STOPPED_BY_USER：屏幕采集被用户停止。
                    • +
                  • LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_SYSTEM_INTERNAL_ERROR：屏幕采集过程中发生系统内部错误。
                    • +
                  +                   +                   +                   +
                  +                   +                   \ No newline at end of file diff --git a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onpermissiongranted.dita b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onpermissiongranted.dita new file mode 100644 index 00000000000..4bf1609a62d --- /dev/null +++ b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onpermissiongranted.dita @@ -0,0 +1,41 @@ + + + + <ph keyref="onPermissionGranted"/> + 权限被授予时的回调。 回调。用于上报已授予的权限。 + + + + + + + + +
                  +

                  + virtual void onPermissionGranted(agora::rtc::PERMISSION_TYPE permissionType) {} + public void onPermissionGranted(int permission) +

                  +
                  +
                  +
                  + 参数 + + + permissionType + 权限类型，详见 。 + + + permission + 权限类型。包括： +
                    +
                  • RECORD_AUDIO：录音权限。
                    • +
                  • CAMERA：摄像头权限。
                    • +
                  • SCREEN_CAPTURE：屏幕采集权限。
                    • +
                  +                   +                   +                   +
                  + + \ No newline at end of file diff --git a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onuserjoined.dita b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onuserjoined.dita index 95e1eeb5f2b..af0f5e618d3 100644 --- a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onuserjoined.dita +++ b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onuserjoined.dita @@ -21,10 +21,10 @@

                  在通信频道中，该回调表示有远端用户加入频道。当本地用户加入频道时，SDK 也会触发该回调报告频道中已有的用户。 -在极速直播频道中，该回调表示有主播加入频道。当主播加入频道时，SDK 也会触发该回调报告频道中已有的主播。声网建议将连麦主播数量限制为 32 人，最多支持 17 路视频主播。

                  +在直播频道中，该回调表示有主播加入频道。当主播加入频道时，SDK 也会触发该回调报告频道中已有的主播。声网建议将连麦主播数量限制为 32 人，最多支持 17 路视频主播。

                  在通信频道中，该回调表示有远端用户加入频道。当你加入频道时，SDK 也会触发该回调报告频道中已有的用户。 在直播频道中，该回调表示有主播加入频道。声网建议将连麦主播数量限制为 32 人，最多支持 17 路视频主播。

                  -

                  在通信频道中，该回调表示有远端用户加入频道。当本地用户加入频道时，SDK 也会触发该回调报告频道中已有的用户。在极速直播频道中，该回调表示有主播加入频道。声网建议将连麦主播数量限制为 32 人，最多支持 17 路视频主播。

                  +

                  在通信频道中，该回调表示有远端用户加入频道。当本地用户加入频道时，SDK 也会触发该回调报告频道中已有的用户。在直播频道中，该回调表示有主播加入频道。声网建议将连麦主播数量限制为 32 人，最多支持 17 路视频主播。

                  在通信频道中，该回调表示有远端用户加入频道。当你加入频道时，SDK 也会触发该回调报告频道中已有的用户。 在直播频道中，该回调表示有主播加入频道。声网建议将连麦主播数量限制为 32 人，最多支持 17 路视频主播。

                  diff --git a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onusermuteaudio.dita b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onusermuteaudio.dita index cb7c986ac5a..88e3a48cacf 100644 --- a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onusermuteaudio.dita +++ b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onusermuteaudio.dita @@ -25,9 +25,9 @@

                  该回调在远端用户调用 方法时触发。

                  当远端用户调用 方法停止或恢复发送音频流时，SDK 会触发该回调。

                  当通信场景中的用户数量或直播场景中的主播数量超过 32 时，该回调可能无法正常工作。 - 当频道中的用户（在通信频道场景中）或主播（在极速直播频道场景中）数量超过 32 时，该回调可能无法正常工作。 + 当频道中的用户（在通信频道场景中）或主播（在直播频道场景中）数量超过 32 时，该回调可能无法正常工作。 当频道中用户（在通信场景下）或主播（在直播场景下）数量超过 32 时，该回调可能无法正常工作。 - 当频道中的用户（在通信频道场景中）或主播（在极速直播频道场景中）数量超过 32 时，该回调可能无法正常工作。 + 当频道中的用户（在通信频道场景中）或主播（在直播频道场景中）数量超过 32 时，该回调可能无法正常工作。
                  触发时机 diff --git a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onusermutevideo.dita b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onusermutevideo.dita index 9096c29ec88..7f931addfa7 100644 --- a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onusermutevideo.dita +++ b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onusermutevideo.dita @@ -24,9 +24,9 @@

                  当远端用户调用 方法停止或恢复发布视频流时，SDK 会触发该回调，报告远端用户的视频流状态。

                  当远端用户调用 时，SDK 会触发该回调，向本地用户报告远端用户发布的视频流状态。

                  当远端用户调用 方法停止或恢复发布视频流时，SDK 会触发该回调，报告远端用户的视频流状态。

                  - 当频道中的用户数（在通信场景下）或主播数（在极速直播场景下）超过 32 时，该回调可能不准确。 + 当频道中的用户数（在通信场景下）或主播数（在直播场景下）超过 32 时，该回调可能不准确。 当通信场景中的用户数或直播场景中的主播数超过 32 时，该回调可能不准确。 - 当频道中通信场景下的用户数或极速直播场景下的主播数超过 32 时，该回调可能不准确。 + 当频道中通信场景下的用户数或直播场景下的主播数超过 32 时，该回调可能不准确。 当通信场景中的用户数或直播场景中的主播数超过 32 时，该回调可能不准确。
                  diff --git a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onuseroffline.dita b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onuseroffline.dita index 43f059e9f9c..60e2211146a 100644 --- a/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onuseroffline.dita +++ b/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onuseroffline.dita @@ -2,7 +2,7 @@ <ph keyref="onUserOffline"/> - 回调：当远端用户（通信频道场景）或主播（极速直播频道场景）离开频道时触发。远端用户或主播离开频道时的回调。远端用户或主播离开频道时触发的回调。远端用户或主播离开频道时的回调。 + 回调：当远端用户（通信频道场景）或主播（直播频道场景）离开频道时触发。远端用户或主播离开频道时的回调。远端用户或主播离开频道时触发的回调。远端用户或主播离开频道时的回调。 @@ -23,34 +23,34 @@

                  用户离线通常有以下两种情况：

                  • 离开频道：当用户或主播主动离开频道时，会发送离开消息。
                    • -
                  • 掉线：在一段时间内未收到用户或主播的数据包时，SDK 会认为其掉线。通信频道场景为 20 秒，极速直播频道场景时间更长。网络不佳可能导致误判，建议使用声网 RTM SDK 进行更可靠的离线检测。
                    • +
                  • 掉线：在一段时间内未收到用户或主播的数据包时，SDK 会认为其掉线。通信频道场景为 20 秒，直播频道场景时间更长。网络不佳可能导致误判，建议使用声网 RTM SDK 进行更可靠的离线检测。

                  用户离线通常有两个原因：

                  • 离开频道：当用户或主播离开频道时，会发送离开消息。
                    • -
                  • 掉线：在一段时间内（频道场景为 20 秒，极速直播场景更长）未收到用户或主播的数据包时，SDK 会认为其掉线。网络连接不佳可能导致误判。建议使用声网 RTM SDK 进行可靠的离线检测。
                    • +
                  • 掉线：在一段时间内（通信场景为 20 秒，直播场景更长）未收到用户或主播的数据包时，SDK 会认为其掉线。网络连接不佳可能导致误判。建议使用声网 RTM SDK 进行可靠的离线检测。

                  用户离线通常有以下两种原因：

                  • 离开频道：当用户或主播离开频道时，会发送一条离开消息。
                    • -
                  • 掉线：在一段时间内（频道场景为 20 秒，极速直播场景更长）未收到用户或主播的数据包时，SDK 会认为其掉线。网络连接不佳可能导致误判，建议使用声网 RTM SDK 进行可靠的离线检测。
                    • +
                  • 掉线：在一段时间内（频道场景为 20 秒，直播场景更长）未收到用户或主播的数据包时，SDK 会认为其掉线。网络连接不佳可能导致误判，建议使用声网 RTM SDK 进行可靠的离线检测。

                  用户离线通常有两个原因：

                  • 离开频道：当用户或主播离开频道时，会发送离开消息。
                    • -
                  • 掉线：在一段时间内（频道场景为 20 秒，极速直播场景更长）未收到用户或主播的数据包时，SDK 会认为其掉线。网络连接不佳可能导致误判。建议使用声网 RTM SDK 进行可靠的离线检测。
                    • +
                  • 掉线：在一段时间内（通信场景为 20 秒，直播场景更长）未收到用户或主播的数据包时，SDK 会认为其掉线。网络连接不佳可能导致误判。建议使用声网 RTM SDK 进行可靠的离线检测。

                  触发时机 -

                  当远端用户（通信频道场景）或主播（极速直播频道场景）离开频道时触发该回调。

                  -

                  该回调在远端用户（在频道场景中）或主播（在极速直播场景中）离开频道时触发。

                  -

                  该回调在远端用户（在频道场景中）或主播（在极速直播场景中）离开频道时被触发。

                  -

                  该回调在远端用户（在频道场景中）或主播（在极速直播场景中）离开频道时触发。

                  +

                  当远端用户（通信频道场景）或主播（直播频道场景）离开频道时触发该回调。

                  +

                  该回调在远端用户（在通信场景中）或主播（在直播场景中）离开频道时触发。

                  +

                  该回调在远端用户（在通信场景中）或主播（在直播场景中）离开频道时被触发。

                  +

                  该回调在远端用户（在通信场景中）或主播（在直播场景中）离开频道时触发。

                  参数 @@ -73,7 +73,7 @@ reason - 远端用户（在频道场景中）或主播（在极速直播场景中）离线的原因，详见 。 + 远端用户（在通信场景中）或主播（在直播场景中）离线的原因，详见 。 uid @@ -81,7 +81,7 @@ reason - 远端用户（在频道场景中）或主播（在极速直播场景中）离线的原因： + 远端用户（在通信场景中）或主播（在直播场景中）离线的原因：
                  • USER_OFFLINE_QUIT (0)：用户主动退出通话，发送离开消息。
                  • USER_OFFLINE_DROPPED (1)：SDK 超时未收到任何数据包，用户掉线。网络连接不佳可能导致误判，建议使用声网 RTM SDK 进行可靠的离线检测。
                    • @@ -99,7 +99,7 @@ reason - 远端用户（在频道场景中）或主播（在极速直播场景中）离线的原因，详见 。 + 远端用户（在通信场景中）或主播（在直播场景中）离线的原因，详见 。
                  diff --git a/dita/RTC-AIDOC/API/class_channelmediaoptions.dita b/dita/RTC-AIDOC/API/class_channelmediaoptions.dita index c6288c11c79..d19eb9dc2ff 100644 --- a/dita/RTC-AIDOC/API/class_channelmediaoptions.dita +++ b/dita/RTC-AIDOC/API/class_channelmediaoptions.dita @@ -12,9 +12,11 @@ Optional<bool> publishThirdCameraTrack; Optional<bool> publishFourthCameraTrack; Optional<bool> publishMicrophoneTrack; +#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(TARGET_OS_MAC) || defined(__OHOS__) + Optional<bool> publishScreenCaptureAudio; +#endif #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__) Optional<bool> publishScreenCaptureVideo; - Optional<bool> publishScreenCaptureAudio; #else Optional<bool> publishScreenTrack; Optional<bool> publishSecondaryScreenTrack; @@ -181,11 +183,11 @@

                  -

                  支持在同一个 中同时发布多个音频流和一个视频流。例如，可以同时将 publishMicrophoneTrack、publishCustomAudioTrack 和 publishMediaPlayerAudioTrack 设置为 ，但 publishCameraTrack、publishScreenCaptureVideo、publishScreenTrack、publishCustomVideoTrack 或 publishEncodedVideoTrack 中只能有一个设置为 。

                  +

                  声网支持在同一个 中同时发布多个音频流和一个视频流。例如，可以同时将 publishMicrophoneTrack、publishCustomAudioTrack 和 publishMediaPlayerAudioTrack 设置为 ，但 publishCameraTrack、publishScreenCaptureVideo、publishScreenTrack、publishCustomVideoTrack 或 publishEncodedVideoTrack 中只能有一个设置为 。

                  支持在同一个 中同时发布多个音频流和一个视频流。例如，你可以同时将 publishMicrophoneTrack、publishCustomAudioTrack 和 publishMediaPlayerAudioTrack 设置为 ，但 publishCameraTrack、publishScreenCaptureVideo（iOS）/publishScreenTrack（macOS）、publishCustomVideoTrack 和 publishEncodedVideoTrack 中只能有一个设置为 。

                  支持在同一个 中同时发布多个音频流和一个视频流。例如，可以同时启用 publishMicrophoneTrack、publishCustomAudioTrack 和 publishMediaPlayerAudioTrack，但 publishCameraTrack、publishScreenCaptureVideo、publishCustomVideoTrack 和 publishEncodedVideoTrack 中只能有一个设置为 。

                  支持在同一个 中同时发布多个音频流和一个视频流。例如，你可以同时将 publishMicrophoneTrack、publishCustomAudioTrack 和 publishMediaPlayerAudioTrack 设置为 ，但 publishCameraTrack、publishScreenCaptureVideo（iOS）/publishScreenTrack（macOS）、publishCustomVideoTrack 和 publishEncodedVideoTrack 中只能有一个设置为 。

                  - 建议你根据业务场景自行设置成员参数的值，否则 SDK 会自动为其赋值。 + 声网建议你根据业务场景自行设置成员参数值，否则 SDK 会自动为成员参数分配值。 建议你根据业务场景自行设置各成员参数值，否则 SDK 会自动为其赋值。 建议你根据业务场景自行设置各成员参数值，否则 SDK 会自动分配默认值。 建议你根据业务场景自行设置各成员参数值，否则 SDK 会自动为其赋值。 @@ -252,11 +254,10 @@ publishScreenCaptureAudio - - 该参数仅适用于 Android 和 iOS 平台。是否发布屏幕采集的音频： + 是否发布屏幕采集器的音频轨道：
                    -
                  • ：发布屏幕采集的音频。
                    • -
                  • ：不发布屏幕采集的音频。
                    • +
                  • ：发布屏幕采集器的音频。
                    • +
                  • ：（默认）不发布屏幕采集器的音频轨道。
                                     @@ -310,7 +311,7 @@ publishCustomAudioTrackId - 要发布的自定义音频轨道的 ID。默认值为 0。你可以通过 createCustomAudioTrack 获取自定义音频轨道 ID。 + 要发布的自定义音频轨道的 ID。默认值为 0。你可以通过 获取自定义音频轨道 ID。 publishCustomVideoTrack @@ -351,7 +352,7 @@ publishTranscodedVideoTrack - 自 v4.2.0 起，参数名从 publishTrancodedVideoTrack 更正为 publishTranscodedVideoTrack。是否发布本地合图视频： + 自 v4.2.0 起，参数名从 publishTrancodedVideoTrack 更正为 publishTranscodedVideoTrack。是否发布本地合图视频：
                  • ：发布本地合图视频。
                  • ：不发布本地合图视频。
                    • @@ -735,15 +736,15 @@ audienceLatencyLevel - 互动直播中观众的延迟等级，详见 AgoraAudienceLatencyLevelType。 + 互动直播中观众的延迟等级，详见 。 defaultVideoStreamType - 默认的视频流类型，详见 AgoraVideoStreamType。 + 默认的视频流类型，详见 。 channelProfile - 频道场景，详见 AgoraChannelProfile。 + 频道场景，详见 。 publishMixedAudioTrack @@ -767,8 +768,8 @@ 你在服务器上生成的用于鉴权的 Token。
                      -
                    • 该参数仅在调用 updateChannelWithMediaOptions 或 updateChannelExWithMediaOptions 方法时生效。
                      • -
                    • 请确保用于生成 Token 的 App ID、频道名和用户名与用于初始化 RTC 引擎的 sharedEngineWithConfig:delegate: 方法，以及用于加入频道的 joinChannelByToken:channelId:uid:mediaOptions:joinSuccess: 和 joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess: 方法中使用的参数一致。
                      • +
                    • 该参数仅在调用 updateChannelWithMediaOptions 或 updateChannelExWithMediaOptions 方法时生效。
                      • +
                    • 请确保用于生成 Token 的 App ID、频道名和用户名与用于初始化 RTC 引擎的 方法，以及用于加入频道的 和 方法中使用的参数一致。
                                         @@ -797,8 +798,8 @@
                      -
                    • 该参数仅适用于连麦直播场景。联播主播需调用 joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess: 方法以观众身份加入其他主播的频道，并将 isInteractiveAudience 设置为 YES。
                      • -
                    • 该参数仅在用户角色为 AgoraClientRoleAudience 时生效。
                      • +
                    • 该参数仅适用于连麦直播场景。联播主播需调用 方法以观众身份加入其他主播的频道，并将 isInteractiveAudience 设置为 。
                      • +
                    • 该参数仅在用户角色为 AgoraClientRoleAudience 时生效。
                    是否启用互动模式：
                      @@ -809,7 +810,7 @@ customVideoTrackId - 调用 createCustomVideoTrack 方法返回的视频轨道 ID。默认值为 0。 + 调用 方法返回的视频轨道 ID。默认值为 0。 isAudioFilterable @@ -1056,8 +1057,7 @@ channelProfile - - 自 v4.x.x 版本废弃。请改用 CHANNEL_PROFILE_LIVE_BROADCASTING。频道场景： + 频道场景：
                      • CHANNEL_PROFILE_COMMUNICATION (0)：通信场景。声网推荐使用直播场景以获得更佳的音视频体验。
                      • CHANNEL_PROFILE_LIVE_BROADCASTING (1)：直播场景（默认）。
                        • @@ -1368,15 +1368,15 @@ audienceLatencyLevel - 互动直播中观众的延迟等级，详见 AgoraAudienceLatencyLevelType。 + 互动直播中观众的延迟等级，详见 。 defaultVideoStreamType - 默认的视频流类型，详见 AgoraVideoStreamType。 + 默认的视频流类型，详见 。 channelProfile - 频道场景，详见 AgoraChannelProfile。 + 频道场景，详见 。 publishMixedAudioTrack @@ -1400,8 +1400,8 @@ 你在服务器上生成的用于鉴权的 Token。
                          -
                        • 该参数仅在调用 updateChannelWithMediaOptions 或 updateChannelExWithMediaOptions 方法时生效。
                          • -
                        • 请确保用于生成 Token 的 App ID、频道名和用户名与用于初始化 RTC 引擎的 sharedEngineWithConfig:delegate: 方法，以及用于加入频道的 joinChannelByToken:channelId:uid:mediaOptions:joinSuccess: 和 joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess: 方法中使用的参数一致。
                          • +
                        • 该参数仅在调用 updateChannelWithMediaOptions 或 updateChannelExWithMediaOptions 方法时生效。
                          • +
                        • 请确保用于生成 Token 的 App ID、频道名和用户名与用于初始化 RTC 引擎的 方法，以及用于加入频道的 和 方法中使用的参数一致。
                                                 @@ -1430,8 +1430,8 @@
                          -
                        • 该参数仅适用于连麦直播场景。联播主播需调用 joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess: 方法以观众身份加入其他主播的频道，并将 isInteractiveAudience 设置为 YES。
                          • -
                        • 该参数仅在用户角色为 AgoraClientRoleAudience 时生效。
                          • +
                        • 该参数仅适用于连麦直播场景。联播主播需调用 方法以观众身份加入其他主播的频道，并将 isInteractiveAudience 设置为 。
                          • +
                        • 该参数仅在用户角色为 AgoraClientRoleAudience 时生效。
                        是否启用互动模式：
                          @@ -1442,7 +1442,7 @@ customVideoTrackId - 调用 createCustomVideoTrack 方法返回的视频轨道 ID。默认值为 0。 + 调用 方法返回的视频轨道 ID。默认值为 0。 isAudioFilterable diff --git a/dita/RTC-AIDOC/API/class_encodedvideoframeinfo.dita b/dita/RTC-AIDOC/API/class_encodedvideoframeinfo.dita index 46f34ee5ce1..fcc4b341877 100644 --- a/dita/RTC-AIDOC/API/class_encodedvideoframeinfo.dita +++ b/dita/RTC-AIDOC/API/class_encodedvideoframeinfo.dita @@ -2,7 +2,7 @@ <ph keyref="EncodedVideoFrameInfo"/> - 描述外部编码视频帧的信息。描述外部编码视频帧的信息。包含外部编码视频帧的相关信息。描述外部编码视频帧的信息。 + 描述外部编码视频帧的信息。描述外部编码视频帧的信息。包含外部编码视频帧的信息。描述外部编码视频帧的信息。

                          diff --git a/dita/RTC-AIDOC/API/class_localvideostats.dita b/dita/RTC-AIDOC/API/class_localvideostats.dita index b9efe025103..468ead58a07 100644 --- a/dita/RTC-AIDOC/API/class_localvideostats.dita +++ b/dita/RTC-AIDOC/API/class_localvideostats.dita @@ -84,7 +84,7 @@ public boolean dualStreamEnabled; public int hwEncoderAccelerating; public int encodedFrameDepth; - } +} __attribute__((visibility("default"))) @interface AgoraRtcLocalVideoStats : NSObject @property(assign, nonatomic) NSUInteger uid; @property(assign, nonatomic) NSUInteger sentBitrate; diff --git a/dita/RTC-AIDOC/API/class_logconfig.dita b/dita/RTC-AIDOC/API/class_logconfig.dita index a7eda7d0cfc..aca236316c3 100644 --- a/dita/RTC-AIDOC/API/class_logconfig.dita +++ b/dita/RTC-AIDOC/API/class_logconfig.dita @@ -59,7 +59,7 @@ filePath 日志文件的完整路径。声网建议使用默认的日志目录。如果你需要修改默认目录，请确保指定的目录存在且可写。默认日志目录如下：

                            -
                          • iOS：AppSandbox/Library/Logs/agorasdk.log
                            • +
                          • iOS：AppSandbox/Library/caches/agorasdk.log
                          • macOS：
                            • 启用 Sandbox 时：AppSandbox/Library/Logs/agorasdk.log
                              • @@ -102,7 +102,7 @@ filePath 日志文件的完整路径。声网建议使用默认的日志目录。如果你需要修改默认目录，请确保指定的目录存在且可写。默认日志目录如下：
                                -
                              • iOS：AppSandbox/Library/Logs/agorasdk.log
                                • +
                              • iOS：AppSandbox/Library/caches/agorasdk.log
                              • macOS：
                                • 启用 Sandbox 时：AppSandbox/Library/Logs/agorasdk.log
                                  • diff --git a/dita/RTC-AIDOC/API/class_mediasource.dita b/dita/RTC-AIDOC/API/class_mediasource.dita index a1ac4cc6988..a571c6d51dd 100644 --- a/dita/RTC-AIDOC/API/class_mediasource.dita +++ b/dita/RTC-AIDOC/API/class_mediasource.dita @@ -104,10 +104,10 @@ isAgoraSource - 如果需要打开通过极速直播服务分发的直播流或点播视频，请将媒体资源的 URL 传入 url，并将 isAgoraSource 设置为 ；否则无需设置该参数。要打开的媒体资源是否为通过极速直播服务分发的直播流或点播视频： + 如果需要打开通过直播服务分发的直播流或点播视频，请将媒体资源的 URL 传入 url，并将 isAgoraSource 设置为 ；否则无需设置该参数。要打开的媒体资源是否为通过直播服务分发的直播流或点播视频：
                                    -
                                  • ：媒体资源为通过极速直播服务分发的直播或点播视频。
                                    • -
                                  • ：（默认）媒体资源不是通过极速直播服务分发的直播或点播视频。
                                    • +
                                  • ：媒体资源为通过直播服务分发的直播或点播视频。
                                    • +
                                  • ：（默认）媒体资源不是通过直播服务分发的直播或点播视频。
                                                                     @@ -250,7 +250,7 @@ isAgoraSource - 如果需要播放通过极速直播服务分发的直播或点播视频，请将媒体资源的 URL 传入 url，并将 isAgoraSource 设置为 ；否则无需设置该参数。是否为通过 Media Broadcast 服务分发的直播或点播视频资源： + 如果需要播放通过直播服务分发的直播或点播视频，请将媒体资源的 URL 传入 url，并将 isAgoraSource 设置为 ；否则无需设置该参数。是否为通过 Media Broadcast 服务分发的直播或点播视频资源：
                                  • ：是。
                                  • ：（默认）否。
                                    • diff --git a/dita/RTC-AIDOC/API/class_screenaudioparameters.dita b/dita/RTC-AIDOC/API/class_screenaudioparameters.dita index 56dfdafa434..0bb39427dcf 100644 --- a/dita/RTC-AIDOC/API/class_screenaudioparameters.dita +++ b/dita/RTC-AIDOC/API/class_screenaudioparameters.dita @@ -7,9 +7,13 @@

                                    struct ScreenAudioParameters { - int sampleRate = 16000; - int channels = 2; - int captureSignalVolume = 100; + int sampleRate; + int channels; + int captureSignalVolume; +#if defined(__APPLE__) && !TARGET_OS_IOS + bool excludeCurrentProcessAudio = true; +#else +#endif }; __attribute__((visibility("default"))) @interface AgoraScreenAudioParameters : NSObject @property(assign, nonatomic) NSInteger captureSignalVolume; @@ -38,15 +42,15 @@ sampleRate - 音频采样率（Hz）。默认值为 16000。 + 音频采样率，单位为 Hz。 channels - 音频声道数。默认值为 2，表示立体声。 + 音频通道数。默认值为 2，表示立体声。 captureSignalVolume - 采集的系统音频音量。取值范围为 [0, 100]，默认值为 100。 + 采集的系统音频音量，取值范围为 [0, 100]，默认值为 100。 captureSignalVolume diff --git a/dita/RTC-AIDOC/API/class_screencaptureparameters.dita b/dita/RTC-AIDOC/API/class_screencaptureparameters.dita index 1c2755ba96d..df3c6026177 100644 --- a/dita/RTC-AIDOC/API/class_screencaptureparameters.dita +++ b/dita/RTC-AIDOC/API/class_screencaptureparameters.dita @@ -7,6 +7,8 @@

                                    struct ScreenCaptureParameters { + bool captureAudio; + ScreenAudioParameters audioParams; VideoDimensions dimensions; int frameRate; int bitrate; diff --git a/dita/RTC-AIDOC/API/class_watermarkconfig.dita b/dita/RTC-AIDOC/API/class_watermarkconfig.dita index ab37db3e25b..dbc25e67932 100644 --- a/dita/RTC-AIDOC/API/class_watermarkconfig.dita +++ b/dita/RTC-AIDOC/API/class_watermarkconfig.dita @@ -61,6 +61,8 @@

                                    自 v4.6.0 版本新增。
                                    + 设置水印类型时，type 需与实际提供的数据字段相匹配，不可同时传入多种类型的水印：若 type 为 buffer，则仅支持设置 buffer 字段；若 type 为 image，则仅支持设置 imageUrl 字段。 + 设置水印类型时，type 需与实际提供的数据字段相匹配，不可同时传入多种类型的水印：若 type 为 buffer，则仅支持设置 buffer 字段；若 type 为 image，则仅支持设置 imageUrl 字段。
                                    属性 diff --git a/dita/RTC-AIDOC/API/enum_audiorecordingqualitytype.dita b/dita/RTC-AIDOC/API/enum_audiorecordingqualitytype.dita index 1f56190709f..c745fb80be1 100644 --- a/dita/RTC-AIDOC/API/enum_audiorecordingqualitytype.dita +++ b/dita/RTC-AIDOC/API/enum_audiorecordingqualitytype.dita @@ -9,19 +9,19 @@ AUDIO_RECORDING_QUALITY_LOW - （0）：低质量。采样率为 32 kHz，录制 10 分钟的文件大小约为 1.2 MB。 + （0）：低质量。例如，采样率为 32 kHz 时，录制 10 分钟的文件大小约为 1.2 MB。 AUDIO_RECORDING_QUALITY_MEDIUM - （1）：中等质量。采样率为 32 kHz，录制 10 分钟的文件大小约为 2 MB。 + （1）：中等质量。例如，采样率为 32 kHz 时，录制 10 分钟的文件大小约为 2 MB。 AUDIO_RECORDING_QUALITY_HIGH - （2）：高质量。采样率为 32 kHz，录制 10 分钟的文件大小约为 3.75 MB。 + （2）：高质量。例如，采样率为 32 kHz 时，录制 10 分钟的文件大小约为 3.75 MB。 AUDIO_RECORDING_QUALITY_ULTRA_HIGH - （3）：超高质量。采样率为 32 kHz，录制 10 分钟的文件大小约为 7.5 MB。 + （3）：超高质量。例如，采样率为 32 kHz 时，录制 10 分钟的文件大小约为 7.5 MB。 AgoraAudioRecordingQualityLow diff --git a/dita/RTC-AIDOC/API/enum_channelprofiletype.dita b/dita/RTC-AIDOC/API/enum_channelprofiletype.dita index 23fe492b985..f1e99853e19 100644 --- a/dita/RTC-AIDOC/API/enum_channelprofiletype.dita +++ b/dita/RTC-AIDOC/API/enum_channelprofiletype.dita @@ -17,15 +17,21 @@ CHANNEL_PROFILE_GAME - （2）：游戏场景。自 v4.5.0 版本废弃。 + （2）：游戏场景。 + 该场景已废弃，请改用 CHANNEL_PROFILE_LIVE_BROADCASTING。 + CHANNEL_PROFILE_CLOUD_GAMING - （3）：云游戏场景。对延迟进行了优化，适用于用户之间需要频繁互动的场景。自 v4.5.0 版本废弃。 + （3）：云游戏场景。对延迟进行了优化，适用于用户之间需要频繁互动的场景。 + 该场景已废弃，请改用 CHANNEL_PROFILE_LIVE_BROADCASTING。 + CHANNEL_PROFILE_COMMUNICATION_1v1 - （4）：通信 1v1 场景。自 v4.5.0 版本废弃。 + （4）：通信 1v1 场景。 + 该场景已废弃，请改用 CHANNEL_PROFILE_LIVE_BROADCASTING。 + AgoraChannelProfileCommunication @@ -37,15 +43,21 @@ AgoraChannelProfileGame - （2）：游戏场景。 + （2）：游戏场景。 + 该场景已废弃，请改用 AgoraChannelProfileLiveBroadcasting。 + AgoraChannelProfileCloudGaming - （3）：云游戏场景。对延迟进行了优化，适用于用户之间需要频繁互动的场景。 + （3）：云游戏场景。对延迟进行了优化，适用于用户之间需要频繁互动的场景。 + 该场景已废弃，请改用 AgoraChannelProfileLiveBroadcasting。 + AgoraChannelProfileCommunication_1v1 - （4）：点对点通信场景。 + （4）：点对点通信场景。 + 该场景已废弃，请改用 AgoraChannelProfileLiveBroadcasting。 + AgoraChannelProfileCommunication @@ -57,15 +69,21 @@ AgoraChannelProfileGame - （2）：游戏场景。 + （2）：游戏场景。 + 该场景已废弃，请改用 AgoraChannelProfileLiveBroadcasting。 + AgoraChannelProfileCloudGaming - （3）：云游戏场景。对延迟进行了优化，适用于用户之间需要频繁互动的场景。 + （3）：云游戏场景。对延迟进行了优化，适用于用户之间需要频繁互动的场景。 + 该场景已废弃，请改用 AgoraChannelProfileLiveBroadcasting。 + AgoraChannelProfileCommunication_1v1 - （4）：点对点通信场景。 + （4）：点对点通信场景。 + 该场景已废弃，请改用 AgoraChannelProfileLiveBroadcasting。 +
                                    diff --git a/dita/RTC-AIDOC/API/enum_errorcodetype.dita b/dita/RTC-AIDOC/API/enum_errorcodetype.dita index 48929caa708..c970514d138 100644 --- a/dita/RTC-AIDOC/API/enum_errorcodetype.dita +++ b/dita/RTC-AIDOC/API/enum_errorcodetype.dita @@ -164,6 +164,14 @@ ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH （130）：SDK 不支持将加密流推送到 CDN。 + + ERR_PCMSEND_FORMAT + （200）：不支持的 PCM 格式。 + + + ERR_PCMSEND_BUFFEROVERFLOW + （201）：缓冲区溢出，PCM 发送速率过快。 + ERR_LOAD_MEDIA_ENGINE （1001）：加载媒体引擎失败。 @@ -325,6 +333,14 @@ AgoraErrorCodeInvalidUserAccount （134）：用户账号无效，可能是因为包含无效参数。 + + AgoraErrorCodePcmSendFormat + （200）：不支持的 PCM 格式。 + + + AgoraErrorCodePcmSendBufferOverflow + （201）：缓冲区溢出，PCM 发送速率过快。 + AgoraErrorCodeLoadMediaEngine （1001）：加载媒体引擎失败。 @@ -506,6 +522,14 @@ AgoraErrorCodeInvalidUserAccount （134）：用户账号无效，可能是因为包含无效参数。 + + AgoraErrorCodePcmSendFormat + （200）：不支持的 PCM 格式。 + + + AgoraErrorCodePcmSendBufferOverflow + （201）：缓冲区溢出，PCM 发送速率过快。 + AgoraErrorCodeLoadMediaEngine （1001）：加载媒体引擎失败。 diff --git a/dita/RTC-AIDOC/API/enum_localvideoeventtype.dita b/dita/RTC-AIDOC/API/enum_localvideoeventtype.dita new file mode 100644 index 00000000000..1b62080e7ab --- /dev/null +++ b/dita/RTC-AIDOC/API/enum_localvideoeventtype.dita @@ -0,0 +1,37 @@ + + + + <ph keyref="LOCAL_VIDEO_EVENT_TYPE"/> + 本地视频事件类型。 + +
                                    +
                                    + +
                                    自从
                                    +
                                    自 v4.6.1 版本新增。
                                    +                                     +
                                    +
                                    +
                                    + 枚举值 + + + LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_HIDDEN + （1）：屏幕采集窗口被隐藏，仅适用于 Android 平台。 + + + LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN + （2）：屏幕采集窗口从隐藏状态恢复，仅适用于 Android 平台。 + + + LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_STOPPED_BY_USER + （3）：屏幕采集被用户停止，仅适用于 Android 平台。 + + + LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_SYSTEM_INTERNAL_ERROR + （4）：屏幕采集过程中发生系统内部错误，仅适用于 Android 平台。 + + +
                                    +                                     +                                     \ No newline at end of file diff --git a/dita/RTC-AIDOC/API/enum_localvideostreamreason.dita b/dita/RTC-AIDOC/API/enum_localvideostreamreason.dita index eb209dbbaab..fca94ebf6b5 100644 --- a/dita/RTC-AIDOC/API/enum_localvideostreamreason.dita +++ b/dita/RTC-AIDOC/API/enum_localvideostreamreason.dita @@ -131,7 +131,7 @@                                     LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_EXCLUDE_WINDOW_FAILED - （34）：（仅适用于 Windows 平台）屏幕共享时，排除窗口列表中的某些窗口排除失败。 + （34）：（仅适用于 Windows 平台）屏幕共享时，排除窗口列表中的部分窗口排除失败。 AgoraLocalVideoStreamReasonOK diff --git a/dita/RTC-AIDOC/API/rtc_api_data_type.dita b/dita/RTC-AIDOC/API/rtc_api_data_type.dita index 3ec70cdc7dc..9f381f97ad8 100644 --- a/dita/RTC-AIDOC/API/rtc_api_data_type.dita +++ b/dita/RTC-AIDOC/API/rtc_api_data_type.dita @@ -865,6 +865,7 @@
                                    • +
                                    • diff --git a/dita/RTC-AIDOC/API/rtc_api_overview.dita b/dita/RTC-AIDOC/API/rtc_api_overview.dita index d94757d3bbf..48f1aa7d280 100644 --- a/dita/RTC-AIDOC/API/rtc_api_overview.dita +++ b/dita/RTC-AIDOC/API/rtc_api_overview.dita @@ -894,7 +894,7 @@ - + @@ -1004,6 +1004,10 @@ + + + + @@ -2058,6 +2062,10 @@ API 描述 + + + + @@ -3341,6 +3349,10 @@ + + + + diff --git a/dita/RTC-AIDOC/RTC_NG_API_Android.ditamap b/dita/RTC-AIDOC/RTC_NG_API_Android.ditamap index 9b717f2c8e2..1e4e1c9dc1a 100644 --- a/dita/RTC-AIDOC/RTC_NG_API_Android.ditamap +++ b/dita/RTC-AIDOC/RTC_NG_API_Android.ditamap @@ -53,6 +53,7 @@ + @@ -288,6 +289,7 @@ + @@ -610,6 +612,7 @@ + @@ -852,6 +855,7 @@ + diff --git a/dita/RTC-AIDOC/RTC_NG_API_CPP.ditamap b/dita/RTC-AIDOC/RTC_NG_API_CPP.ditamap index 780ba1ab1c5..014f1af24a0 100644 --- a/dita/RTC-AIDOC/RTC_NG_API_CPP.ditamap +++ b/dita/RTC-AIDOC/RTC_NG_API_CPP.ditamap @@ -57,6 +57,7 @@ + @@ -285,6 +286,7 @@ + @@ -592,6 +594,7 @@ + @@ -890,6 +893,7 @@ + diff --git a/dita/RTC-AIDOC/RTC_NG_API_iOS.ditamap b/dita/RTC-AIDOC/RTC_NG_API_iOS.ditamap index 213689f1047..ebdc686eef1 100644 --- a/dita/RTC-AIDOC/RTC_NG_API_iOS.ditamap +++ b/dita/RTC-AIDOC/RTC_NG_API_iOS.ditamap @@ -51,6 +51,7 @@ + @@ -579,6 +580,7 @@ + diff --git a/dita/RTC-AIDOC/RTC_NG_API_macOS.ditamap b/dita/RTC-AIDOC/RTC_NG_API_macOS.ditamap index 7be8d5b13f2..1357ba6256f 100644 --- a/dita/RTC-AIDOC/RTC_NG_API_macOS.ditamap +++ b/dita/RTC-AIDOC/RTC_NG_API_macOS.ditamap @@ -48,6 +48,7 @@ + diff --git a/dita/RTC-AIDOC/config/keys-rtc-ng-api-cpp.ditamap b/dita/RTC-AIDOC/config/keys-rtc-ng-api-cpp.ditamap index c67bed47adf..20f5d027234 100644 --- a/dita/RTC-AIDOC/config/keys-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-AIDOC/config/keys-rtc-ng-api-cpp.ditamap @@ -1374,6 +1374,13 @@ + + + + getAudioBufferDelay + + + @@ -4820,6 +4827,13 @@ + + + + onLocalVideoEvent + + + @@ -4925,6 +4939,13 @@ + + + + onPermissionGranted + + + @@ -6644,6 +6665,13 @@ + + + + LOCAL_VIDEO_EVENT_TYPE + + + diff --git a/dita/RTC-AIDOC/config/keys-rtc-ng-api-ios.ditamap b/dita/RTC-AIDOC/config/keys-rtc-ng-api-ios.ditamap index fcd8e42d507..57b4a04134a 100644 --- a/dita/RTC-AIDOC/config/keys-rtc-ng-api-ios.ditamap +++ b/dita/RTC-AIDOC/config/keys-rtc-ng-api-ios.ditamap @@ -1255,6 +1255,13 @@ + + + + getAudioBufferDelay + + + diff --git a/dita/RTC-AIDOC/config/keys-rtc-ng-api-java.ditamap b/dita/RTC-AIDOC/config/keys-rtc-ng-api-java.ditamap index 9b89d651775..3d913d6b6aa 100644 --- a/dita/RTC-AIDOC/config/keys-rtc-ng-api-java.ditamap +++ b/dita/RTC-AIDOC/config/keys-rtc-ng-api-java.ditamap @@ -1324,6 +1324,13 @@ + + + + getAudioBufferDelay + + + @@ -4728,6 +4735,13 @@ + + + + onLocalVideoEvent + + + @@ -4833,6 +4847,13 @@ + + + + onPermissionGranted + + + diff --git a/dita/RTC-AIDOC/config/relations-rtc-ng-api-cpp.ditamap b/dita/RTC-AIDOC/config/relations-rtc-ng-api-cpp.ditamap index 0994a26bafe..1ca0f37434d 100644 --- a/dita/RTC-AIDOC/config/relations-rtc-ng-api-cpp.ditamap +++ b/dita/RTC-AIDOC/config/relations-rtc-ng-api-cpp.ditamap @@ -204,6 +204,7 @@ + @@ -714,6 +715,7 @@ + @@ -721,6 +723,7 @@ + diff --git a/dita/RTC-AIDOC/config/relations-rtc-ng-api-ios.ditamap b/dita/RTC-AIDOC/config/relations-rtc-ng-api-ios.ditamap index 12511922b11..e3dc8120154 100644 --- a/dita/RTC-AIDOC/config/relations-rtc-ng-api-ios.ditamap +++ b/dita/RTC-AIDOC/config/relations-rtc-ng-api-ios.ditamap @@ -166,6 +166,7 @@ + diff --git a/dita/RTC-AIDOC/config/relations-rtc-ng-api-java.ditamap b/dita/RTC-AIDOC/config/relations-rtc-ng-api-java.ditamap index 8caa8bd829e..1108fb2a09e 100644 --- a/dita/RTC-AIDOC/config/relations-rtc-ng-api-java.ditamap +++ b/dita/RTC-AIDOC/config/relations-rtc-ng-api-java.ditamap @@ -149,6 +149,7 @@ + @@ -686,6 +687,7 @@ + @@ -693,6 +695,7 @@ + diff --git a/dita/RTC-NG/API/enum_recorderstreamtype.dita b/dita/RTC-NG/API/enum_recorderstreamtype.dita index b8ab625b22b..19ae7e1e74b 100644 --- a/dita/RTC-NG/API/enum_recorderstreamtype.dita +++ b/dita/RTC-NG/API/enum_recorderstreamtype.dita @@ -2,19 +2,20 @@ <ph keyref="RecorderStreamType"/> - 需录制的视频流类型。 + The type of video stream to be recorded.
                                    - 枚举值 + Enumeration value - - - 0: （默认）频道内的视频流。 - - - - 1: 加入频道前，在本地预览的视频流。 - -
                                    + + + 0: (Default) Video stream in the channel. + + + + 1: Preview the video stream locally before joining the channel. + + +
                                    diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap index 047167e85bb..0fdb54384bd 100644 --- a/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap +++ b/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap @@ -5,7 +5,7 @@ - Unreal + Blueprint diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index 630073cc6ff..06b4f7cedb4 100644 --- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -370,7 +370,7 @@ - + diff --git a/en-US/dita/RTC-AIDOC/API/api_imediaplayer_getaudiobufferdelay.dita b/en-US/dita/RTC-AIDOC/API/api_imediaplayer_getaudiobufferdelay.dita new file mode 100644 index 00000000000..04910f76b07 --- /dev/null +++ b/en-US/dita/RTC-AIDOC/API/api_imediaplayer_getaudiobufferdelay.dita @@ -0,0 +1,53 @@ + + + + <ph keyref="getAudioBufferDelay"/> + Gets the audio buffer delay when playing media files.Gets the audio buffer delay when you play a media file.Gets the audio buffer delay when playing media files. + + + + + + + + +
                                    +

                                    + virtual int getAudioBufferDelay(int32_t& delayMs) = 0; + - (NSInteger)getAudioBufferDelay NS_SWIFT_NAME(getAudioBufferDelay()); + int getAudioBufferDelay(); +

                                    +
                                    +
                                    +
                                    + Parameters + + + delayMs + Output parameter. The audio buffer delay when playing media files, in milliseconds. + + +
                                    +
                                    + Return Values +

                                    +

                                      +
                                    • 0: The method call succeeds.
                                      • +
                                    • < 0: The method call fails.
                                      • +
                                    +

                                    +

                                    +

                                      +
                                    • 0: Success. Returns the audio buffer delay in milliseconds.
                                      • +
                                    • < 0: Failure. You can use MediaPlayerReason to check the reason for the failure.
                                      • +
                                    +

                                    +

                                    +

                                      +
                                    • If the method call succeeds, returns the audio buffer delay (in milliseconds).
                                      • +
                                    • If the method call fails, returns an error code less than 0. You can use to check the error reason.
                                      • +
                                    +

                                    +
                                    + + \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengine_playeffect2.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengine_playeffect2.dita index 91c56493f4b..5c1ea4b6655 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengine_playeffect2.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengine_playeffect2.dita @@ -17,8 +17,15 @@

                                    -

                                    This method supports playing URI files that start with content://. For supported audio file formats, see [What audio file formats does the Agora RTC SDK support](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format). If the local music file does not exist, the SDK does not support the file format, or the music file URL cannot be accessed, the SDK reports AUDIO_MIXING_REASON_CAN_NOT_OPEN.

                                    - If you need to play an online audio effect file, it is recommended to cache it to the local device first, preload the file into memory using preloadEffect, and then call this method to play the effect. Otherwise, playback may fail or be silent due to timeout or loading failure. +

                                    This method supports playing URI files that start with content://. See What formats of audio files does the Agora RTC SDK support for supported formats. If the local audio file does not exist, the SDK does not support the file format, or the audio file URL is inaccessible, the SDK returns AUDIO_MIXING_REASON_CAN_NOT_OPEN. +To play multiple audio effect files simultaneously, call this method multiple times with different soundId and filePath. For the best user experience, Agora recommends not playing more than three audio files simultaneously.

                                    + +
                                      +
                                    • To play online audio effect files, Agora recommends caching the file on the local device and calling preloadEffect to preload it into memory before calling this method to play it. Otherwise, playback may fail or be silent due to timeout or loading failure.
                                      • +
                                    • If you call preloadEffectEx before playEffectEx, the file resource will not be closed after playEffectEx is executed. The next time you call playEffectEx, it will start playing from the beginning.
                                      • +
                                    • If you call playEffectEx directly without calling preloadEffectEx, the resource will be destroyed after playEffectEx is executed. The next time you call it, it will try to reopen the file and play from the beginning.
                                      • +
                                    +
                                    Timing @@ -33,17 +40,15 @@ soundId - Audio effect ID. Each audio effect file must have a unique ID. + Audio effect ID. Each audio effect file must have a unique ID. + If you have preloaded the audio effect into memory using preloadEffect, make sure this parameter matches the soundId used in preloadEffect. + filePath - Path of the audio effect file. The following formats are supported: -
                                      -
                                    • URI address starting with content://
                                      • -
                                    • Path starting with /assets/
                                      • -
                                    • URL
                                      • -
                                    • Absolute path of a local file (must include file name and extension)
                                      • -
                                    Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP.                                     + File path. Supports URI starting with content://, path starting with /assets/, URL, and absolute path of local files. The absolute path must include the file name and extension. Supported formats include MP3, AAC, M4A, MP4, WAV, and 3GP. + If you have preloaded the audio effect into memory using preloadEffect, make sure this parameter matches the filePath used in preloadEffect. +                                     loopCount @@ -56,28 +61,28 @@ pitch - Pitch of the audio effect. The range is from 0.5 to 2.0. The default value is 1.0, which represents the original pitch. The smaller the value, the lower the pitch. + Pitch of the audio effect. Range: 0.5 to 2.0. Default is 1.0, which represents the original pitch. The smaller the value, the lower the pitch. pan - Spatial position of the audio effect. The range is from -1.0 to 1.0: + Spatial position of the audio effect. Range: -1.0 to 1.0:
                                      -
                                    • -1.0: Audio effect comes from the user's left.
                                      • -
                                    • 0.0: Audio effect comes from the front.
                                      • -
                                    • 1.0: Audio effect comes from the user's right.
                                      • +
                                    • -1.0: Played from the user's left.
                                      • +
                                    • 0.0: Played from the front.
                                      • +
                                    • 1.0: Played from the user's right.
                                                                         gain - Volume of the audio effect. The range is from 0.0 to 100.0. The default value is 100.0, which represents the original volume. The smaller the value, the lower the volume. + Volume of the audio effect. Range: 0.0 to 100.0. Default is 100.0, which represents the original volume. The smaller the value, the lower the volume. publish Whether to publish the audio effect to remote users:
                                      -
                                    • : Publish the audio effect to remote users. Both local and remote users can hear it.
                                      • -
                                    • : Do not publish the audio effect to remote users. Only the local user can hear it.
                                      • +
                                    • : Publish the audio effect. Both local and remote users can hear it.
                                      • +
                                    • : Do not publish the audio effect. Only the local user can hear it.
                                                                         @@ -85,12 +90,8 @@
                                    Return Values -

                                    -

                                      -
                                    • 0: Success.
                                      • -
                                    • < 0: Failure.
                                      • -
                                    -

                                    +

                                    0: The method call succeeds. +< 0: The method call fails.

                                                                         \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengine_playeffect3.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengine_playeffect3.dita index 97d48c68ae3..5977daf225c 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengine_playeffect3.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengine_playeffect3.dita @@ -2,7 +2,7 @@ <ph keyref="playEffect3"/> - Plays the specified local or online sound effect file.Plays the specified local or online audio effect file. + Plays the specified local or online audio effect file.Plays the specified local or online audio effect file. @@ -18,21 +18,32 @@

                          -

                          To play multiple sound effect files simultaneously, call this method multiple times with different soundId and filePath. For the best user experience, Agora recommends not playing more than three sound effect files at the same time.

                          -

                          This method supports playing URI files that start with content://. For supported audio file formats, see [What audio file formats does the Agora RTC SDK support](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format). If the local audio file does not exist, the SDK does not support the file format, or the audio file URL cannot be accessed, the SDK returns the error code AUDIO_MIXING_REASON_CAN_NOT_OPEN.

                          - If you need to play online sound effect files, Agora recommends caching them to the local device first, preloading them into memory with , and then calling this method to play the sound effect. Otherwise, playback may fail or be silent due to loading timeout or failure. -If is called before , the file resource will not be closed after is executed. The next call to will start playback from the beginning. -If is not called before , the resource will be destroyed after is executed. The next call to will attempt to reopen the file and play from the beginning. - If you need to play an online audio effect file, Agora recommends caching it to the local device first, preloading the file into memory using preloadEffect, and then calling this method to play the effect. Otherwise, playback may fail or be silent due to timeout or loading failure. +

                          After calling , you can call this method to play the specified audio effect for all users in the channel. Each call to this method can only play one audio effect. To play multiple audio effects simultaneously, call this method multiple times. For the best user experience, Agora recommends not playing more than three audio effect files at the same time.

                          +

                          This method supports playing URI files that start with content://. For supported audio file formats, see What formats of audio files does the Agora RTC SDK support. If the local audio file does not exist, the SDK does not support the file format, or the audio file URL is inaccessible, the SDK reports AUDIO_MIXING_REASON_CAN_NOT_OPEN.

                          + +
                            +
                          • If you need to play an online audio effect file, Agora recommends caching it to the local device first, preloading it into memory using , and then calling this method to play the effect. Otherwise, playback may fail or be silent due to loading timeout or failure.
                            • +
                          • The audio effect ID and file path in this method must be the same as those in .
                            • +
                          • If you call before , the file resource will not be closed after is executed. The next time is called, it will start playing from the beginning.
                            • +
                          • If you do not call before , the resource will be destroyed after is executed. The next time is called, it will try to reopen the file and play from the beginning.
                            • +
                          +                           + +
                            +
                          • If you need to play an online audio effect file, it is recommended to first cache it to the local device, call preloadEffect to preload the file into memory, and then call this method to play it. Otherwise, playback may fail or be silent due to timeout or loading failure.
                            • +
                          • If preloadEffect is called before playEffect, the file resource will not be closed after playEffect is executed. The next call to playEffect will start playback from the beginning.
                            • +
                          • If playEffect is called without first calling preloadEffect, the resource will be destroyed after playback ends. The next call to playEffect will attempt to reopen the file and play from the beginning.
                            • +
                          +
                          Timing -

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

                          +

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

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

                          @@ -40,90 +51,91 @@ If is not called before soundId - Sound effect ID. Each sound effect file has a unique ID. If is called to preload the sound effect into memory, ensure this parameter matches the soundId in . + The audio effect ID. The ID of each audio effect file must be unique. If you have preloaded the audio effect into memory using , ensure that this parameter value is the same as the soundId in . filePath - File path. Supports URL and absolute path of local files. The path must include the file name and extension. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See [What audio file formats does Agora RTC SDK support](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format). If is called to preload the sound effect into memory, ensure this parameter matches the filePath in . + The absolute path of the local audio effect file or the URL of the online audio effect file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav. loopCount - Number of times to loop the sound effect: + The number of times to loop the audio effect:
                            -
                          • ≥ 0: Number of times to play. For example, 1 means loop once, i.e., play twice in total.
                            • -
                          • -1: Loop the sound effect indefinitely.
                            • +
                          • -1: Loop indefinitely until or is called.
                            • +
                          • 0: Play once.
                            • +
                          • 1: Play twice.
                                                     pitch - Pitch of the sound effect. Range: 0.5 to 2.0. The default value is 1.0, which represents the original pitch. The smaller the value, the lower the pitch. + The pitch of the audio effect. The range is from 0.5 to 2.0, with the default value being 1.0 (original pitch). The smaller the value, the lower the pitch. pan - Spatial position of the sound effect. Range: -1.0 to 1.0: + The spatial position of the audio effect. The range is from -1.0 to 1.0:
                            -
                          • -1.0: Sound effect comes from the user's left.
                            • -
                          • 0.0: Sound effect comes from the front.
                            • -
                          • 1.0: Sound effect comes from the user's right.
                            • +
                          • -1.0: Audio effect is positioned to the left.
                            • +
                          • 0.0: Audio effect is centered.
                            • +
                          • 1.0: Audio effect is positioned to the right.
                                                     gain - Volume of the sound effect. Range: 0.0 to 100.0. The default value is 100.0, which represents the original volume. The smaller the value, the lower the volume. + The volume of the audio effect. The range is from 0 to 100, with the default value being 100 (original volume). The smaller the value, the lower the volume. publish - Whether to publish the sound effect to remote users: + Whether to publish the audio effect to remote users:
                            -
                          • : Publish the sound effect to remote users. Both local and remote users can hear it.
                            • -
                          • : (Default) Do not publish the sound effect to remote users. Only the local user can hear it.
                            • +
                          • : Publish the audio effect to remote users. Both local and remote users can hear it.
                            • +
                          • : (Default) Do not publish the audio effect to remote users. Only the local user can hear it.
                                                     startPos - Start position of the sound effect file in milliseconds. + The start position for playing the audio effect file, in milliseconds. soundId - Audio effect ID. Each audio effect file must have a unique ID. - If you have preloaded the audio effect into memory using preloadEffect, make sure this parameter value is the same as the soundId used in preloadEffect. + Audio effect ID. Each audio effect file has a unique ID. + If you have preloaded the audio effect into memory by calling preloadEffect, ensure that this parameter matches the soundId used in preloadEffect. filePath - Path of the audio effect file. Supports URI addresses starting with content://, paths starting with /assets/, URLs, and absolute paths of local files. The path must include the file name and extension. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. - If you have preloaded the audio effect into memory using preloadEffect, make sure this parameter value is the same as the filePath used in preloadEffect. + File path. Supports URIs starting with content://, paths starting with /assets/, URLs, and absolute paths of local files. The path must include the file name and extension. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. + If you have preloaded the audio effect into memory by calling preloadEffect, ensure that this parameter matches the filePath used in preloadEffect. loopCount - Number of times the audio effect loops: + Number of times the audio effect is looped:
                            -
                          • ≥ 0: Number of times to play. For example, 1 means loop once, i.e., play twice in total.
                            • +
                          • ≥ 0: Number of loops. For example, 1 means loop once, i.e., play twice in total.
                          • -1: Loop the audio file indefinitely.
                                                     pitch - Pitch of the audio effect. The range is from 0.5 to 2.0. The default value is 1.0, which represents the original pitch. The smaller the value, the lower the pitch. + Pitch of the audio effect. Value range is 0.5 to 2.0. Default is 1.0, which means original pitch. The smaller the value, the lower the pitch. pan - Spatial position of the audio effect. The range is from -1.0 to 1.0: + Spatial position of the audio effect. Value range is -1.0 to 1.0:
                            -
                          • -1.0: Audio effect plays from the user's left.
                            • -
                          • 0.0: Audio effect plays from the front.
                            • -
                          • 1.0: Audio effect plays from the user's right.
                            • +
                          • -1.0: Audio plays from the user's left.
                            • +
                          • 0.0: Audio plays from the front.
                            • +
                          • 1.0: Audio plays from the user's right.
                                                     gain - Volume of the audio effect. The range is from 0.0 to 100.0. The default value is 100.0, which represents the original volume. The smaller the value, the lower the volume. + Volume of the audio effect. Value range is 0.0 to 100.0. Default is 100.0, which means original volume. The smaller the value, the lower the volume. publish @@ -136,7 +148,7 @@ If is not called before startPos - The starting position for playing the audio effect file, in milliseconds. + Start position of the audio effect file in milliseconds.
                          @@ -148,12 +160,8 @@ If is not called before -
                            -
                          • 0: Success.
                            • -
                          • < 0: Failure.
                            • -
                          -

                          +

                          0: Success. +< 0: Failure.

                   \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect.dita index f4de66e0645..96de7a4aee6 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect.dita @@ -2,7 +2,7 @@ <ph keyref="preloadEffect"/> - Preloads the specified sound effect file into memory.Preloads the specified audio effect file. + Preloads the specified audio effect file.Preloads the specified audio effect file. @@ -18,20 +18,22 @@

                  -

                  Make sure the total size of all preloaded files does not exceed the limit.

                  -

                  You can call this method multiple times to preload multiple audio effect files into memory. After preloading, you can call playEffect to play a specific effect or to play all preloaded effects.

                  +

                  Each time you call this method, only one specified audio effect file is preloaded into memory. To preload multiple audio effect files, call this method multiple times. After preloading, you can call to play the preloaded effect, or call to play all preloaded effects.

                  +

                  This method preloads only one specified audio effect file into memory per call. To preload multiple audio effect files, call this method multiple times. After preloading, you can call playEffect to play the preloaded effect or call to play all preloaded effects.

                    -
                  • If you call before , the file resource will not be closed after is executed. The next call to will start playback from the beginning.
                    • -
                  • If you do not call before , the resource will be destroyed after is executed. The next call to will attempt to reopen the file and play from the beginning.
                    • +
                  • To ensure smooth communication, limit the size of the audio effect files.
                    • +
                  • Agora recommends calling this method before joining a channel.
                    • +
                  • If you call before , the file resource will not be closed after is executed. The next time you call , it will start playing from the beginning.
                    • +
                  • If you do not call before , the resource will be destroyed after is executed. The next time you call , it will try to reopen the file and play from the beginning.
                  • To ensure smooth communication, limit the size of audio effect files.
                  • Agora recommends calling this method before joining a channel.
                    • -
                  • If you call preloadEffect before playEffect, the file resource will not be closed after playEffect executes. The next call to playEffect will start playback from the beginning.
                    • -
                  • If you do not call preloadEffect before playEffect, the resource will be destroyed after playEffect executes. The next call to playEffect will attempt to reopen the file and play from the beginning.
                    • +
                  • If you call preloadEffect before playEffect, the file resource will not be closed after playEffect is executed. The next time you call playEffect, it will start playing from the beginning.
                    • +
                  • If you do not call preloadEffect before playEffect, the resource will be destroyed after playEffect is executed. The next time you call playEffect, it will try to reopen the file and play from the beginning.
                  @@ -44,33 +46,27 @@ soundId - Sound effect ID. The ID of each sound effect file must be unique. + The audio effect ID. The ID of each audio effect file must be unique. filePath - File path: -
                    -
                  • Android: The path must include the file name and extension. Supports URL, absolute path, or path starting with /assets/. Using an absolute path to access local files may cause permission issues. It is recommended to use a URI, e.g., content://com.android.providers.media.documents/document/audio%3A14441.
                    • -
                  • Windows: Absolute path or URL of the sound effect file (including file extension), e.g., .
                    • -
                  • iOS or macOS: Absolute path or URL of the sound effect file (including file extension), e.g., /var/mobile/Containers/Data/audio.mp4.
                    • -
                  -                   + The absolute path of the local audio effect file or the URL of the online audio effect file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav.                   startPos - Start position of the sound effect file in milliseconds. + The start position for playing the audio effect, in milliseconds. The default value is 0, which means to play from the beginning. soundId - The ID of the audio effect. + ID of the audio effect. filePath - The absolute path of the local audio effect file or the URL of an online audio effect file. + Absolute path of a local audio effect file or URL of an online audio effect file. startPos - The starting playback position of the online audio effect file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav. + Start playback position of the online audio effect file. Supported formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav.                   @@ -84,8 +80,8 @@

                    -
                  • 0: Success.
                    • -
                  • < 0: Failure.
                    • +
                  • 0: The method call succeeds.
                    • +
                  • < 0: The method call fails.

                  diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect2.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect2.dita index 4f2a7d366fa..f49ee6c1fc9 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect2.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengine_preloadeffect2.dita @@ -17,7 +17,13 @@

                  -

                  Ensure the total size of all preloaded files does not exceed the limit. For supported audio file formats, see [What audio file formats does Agora RTC SDK support](https://doc.shengwang.cn/faq/general-product-inquiry/audio-format).

                  +

                  Make sure the total size of all preloaded files does not exceed the limit. See What formats of audio files does the Agora RTC SDK support.

                  + +
                    +
                  • If you call preloadEffect before playEffect, the file resource will not be closed after playEffect is executed. The next time you call playEffect, it will start playing from the beginning.
                    • +
                  • If you do not call preloadEffect before playEffect, the resource will be destroyed after playEffect is executed. The next time you call playEffect, it will try to reopen the file and play from the beginning.
                    • +
                  +
                  Timing @@ -28,14 +34,16 @@ soundId - Sound effect ID. Each effect file must have a unique ID. + Audio effect ID. Each audio effect file must have a unique ID. filePath - File path: + File path. Supports the following formats:
                    -
                  • Android: The path must include the file name and extension. Agora supports URLs, absolute paths, or paths starting with /assets/. If you use an absolute path to access a local file, permission issues may occur. Therefore, using a URI is recommended. For example:
                    • -
                  content://com.android.providers.media.documents/document/audio%3A14441.                   +
                • URL.
                  • +
                • Absolute path.
                  • +
                • File path starting with /assets/.
                  • +
                The path must include the file name and extension. If you access a local file using an absolute path, you may encounter permission issues. It is recommended to use a URI, for example:content://com.android.providers.media.documents/document/audio%3A14441.                                 @@ -43,8 +51,8 @@ Return Values

                  -
                • 0: Success.
                  • -
                • < 0: Failure.
                  • +
                • 0: The method call succeeds.
                  • +
                • < 0: The method call fails.

                diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengine_setplaybackaudioframeparameters.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengine_setplaybackaudioframeparameters.dita index 617c6c83f44..1046823f17d 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengine_setplaybackaudioframeparameters.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengine_setplaybackaudioframeparameters.dita @@ -2,7 +2,7 @@ <ph keyref="setPlaybackAudioFrameParameters"/> - Sets the format of the raw audio playback data.Sets the format of the raw audio playback data. + Sets the format of the raw playback audio data.Sets the format of raw audio playback data. @@ -18,20 +18,25 @@

                -

                The SDK calculates the sampling interval based on samplesPerCall, sampleRate, and channel: Sampling interval (in seconds) = samplesPerCall / (sampleRate × channel). Make sure the interval is ≥ 0.01 seconds. The SDK triggers the callback based on this interval.

                -

                The SDK calculates the sampling interval based on the samplesPerCall, sampleRate, and channel parameters. Sampling interval (in seconds) = samplesPerCall / (sampleRate × channel). Ensure the sampling interval is no less than 0.01 seconds. The SDK triggers the callback based on the sampling interval.

                +

                The SDK calculates the sampling interval based on the samplesPerCall, sampleRate, and channel parameters. Sampling interval (in seconds) = samplesPerCall / (sampleRate × channel). Make sure the sampling interval is ≥ 0.01 seconds. The SDK triggers the callback based on the sampling interval.

                +

                The SDK calculates the sampling interval based on the samplesPerCall, sampleRate, and channel parameters. Sampling interval (in seconds) = samplesPerCall / (sampleRate × channel). Ensure that the sampling interval is ≥ 0.01 seconds. The SDK triggers the callback based on the sampling interval.

                Timing

                Call this method before joining a channel.

                Call this method before joining a channel.

                +
                Parameters sampleRate - The sampling rate returned in the callback. Can be set to 8000, 16000, 32000, 44100, or 48000 Hz. + Sampling rate returned in the callback. Can be set to 8000, 16000, 24000, 32000, 44100, or 48000 Hz. channel @@ -44,19 +49,19 @@ mode - The usage mode of the audio frame. See . + Usage mode of the audio frame. See for details. samplesPerCall - The number of samples returned per call, e.g., 1024 for media streaming. + Number of audio samples per callback, for example, 1024 for media streaming. sampleRate - The sampling rate returned in the callback. Can be set to 8000, 16000, 32000, 44100, or 48000 Hz. + Sampling rate returned in the callback. Can be set to 8000, 16000, 24000, 32000, 44100, or 48000 Hz. channel - Number of audio channels: + Number of audio channels. Can be set to:
                • 1: Mono.
                • 2: Stereo.
                  • @@ -67,14 +72,14 @@ mode Usage mode of the audio frame:
                    -
                  • 0 (default): Read-only mode. For example, the user retrieves data via the Agora SDK and pushes RTMP or RTMPS streams.
                    • -
                  • 2: Read-write mode. The user reads data from , modifies it, and plays it back. For example, the user has a custom audio effects module and performs voice preprocessing such as voice changing.
                    • +
                  • RAW_AUDIO_FRAME_OP_MODE_READ_ONLY (0): (Default) Read-only mode. For example, the user obtains data through the Agora SDK and pushes RTMP or RTMPS streams.
                    • +
                  • RAW_AUDIO_FRAME_OP_MODE_READ_WRITE (2): Read-write mode. The user reads data from , modifies it, and then plays it. For example, the user has their own audio effect processing module and performs voice preprocessing, such as voice changing.
                   samplesPerCall - Number of samples per call, e.g., 1024 for media streaming. + Number of data samples returned per call, e.g., 1024 for media streaming.
                @@ -82,8 +87,8 @@ Return Values

                  -
                • 0: Success.
                  • -
                • < 0: Failure.
                  • +
                • 0: Method call succeeded.
                  • +
                • < 0: Method call failed.

                diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex.dita index 3e585daedd4..192be578349 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex.dita @@ -2,7 +2,7 @@ <ph keyref="playEffectEx"/> - Plays a specified sound effect in the channel.Plays the specified audio effect in the channel. + Plays the specified sound effect in the channel.Plays the specified audio effect in the channel. @@ -21,31 +21,35 @@

                Since
                -
                Added since v4.6.0.
                +
                Available since v4.6.0.
                Since
                Available since v4.6.0.
                -

                You can call this method to play a specified sound effect to all users in the channel. Each call can play only one sound effect. To play multiple sound effects simultaneously, use different soundId and filePath and call this method multiple times. You can also set whether to publish the sound effect in the channel.

                -

                You can call this method to play the specified audio effect to all users in the channel. Each call to this method can only play one audio effect. To play multiple audio effects simultaneously, use different soundId and filePath values and call this method multiple times. You can also set whether to publish the audio effect in the channel.

                +

                You can call this method to play a specified sound effect to all users in the channel. Each call to this method can only play one sound effect. To play multiple sound effects simultaneously, use different soundId and filePath values and call this method multiple times. You can also set whether to publish the sound effect in the channel.

                +

                You can call this method to play the specified audio effect to all users in the channel. Each call to this method can only play one audio effect. To play multiple audio effects simultaneously, call this method multiple times and set different soundId and filePath for each audio effect.

                • Agora recommends not playing more than three sound effects simultaneously.
                  • -
                • The sound effect ID and file path in this method must match those in the method.
                  • +
                • The sound effect ID and file path in this method must match those used in the method.
                  • +
                • If you call before calling , the file resource will not be closed after is executed. The next time you call , playback will start from the beginning.
                  • +
                • If you do not call before calling , the resource will be destroyed after is executed. The next time you call , it will attempt to reopen the file and start playback from the beginning.
                • Agora recommends not playing more than three audio effects simultaneously.
                  • -
                • The audio effect ID and file path in this method must match those used in preloadEffect.
                  • +
                • The sound effect ID and file path in this method must be consistent with those in the preloadEffectEx method.
                  • +
                • If preloadEffectEx is called before playEffectEx, the file resource will not be closed after playEffectEx is executed. The next call to playEffectEx will start playback from the beginning.
                  • +
                • If preloadEffectEx is not called before playEffectEx, the resource will be destroyed after playEffectEx is executed. The next call to playEffectEx will attempt to reopen the file and play from the beginning.
                Scenario -

                This method is applicable in multi-channel scenarios.

                +

                This method applies to multi-channel scenarios.

                Parameters @@ -60,11 +64,11 @@ filePath - Absolute path of the local file or URL of the online file. Supported audio formats include mp3, mp4, m4a, aac, 3gp, mkv, and wav. + The absolute path of the local file or the URL of the online file. Supported audio formats include mp3, mp4, m4a, aac, 3gp, mkv, and wav. loopCount - Number of times the sound effect loops: + The number of times the sound effect is played in a loop:
                • -1: Loop indefinitely until or is called.
                • 0: Play once.
                  • @@ -74,34 +78,34 @@ pitch - Pitch of the sound effect. Range: 0.5 to 2.0. Default is 1.0 (original pitch). Lower values indicate lower pitch. + The pitch of the sound effect. The value range is from 0.5 to 2.0, with the default being 1.0 (original pitch). The smaller the value, the lower the pitch. pan - Spatial position of the sound effect. Range: -1.0 to 1.0: + The spatial position of the sound effect. The value range is from -1.0 to 1.0:
                    -
                  • -1.0: Sound comes from the left.
                    • -
                  • 0.0: Sound comes from the front.
                    • -
                  • 1.0: Sound comes from the right.
                    • +
                  • -1.0: The sound effect comes from the user's left.
                    • +
                  • 0.0: The sound effect comes from directly in front of the user.
                    • +
                  • 1.0: The sound effect comes from the user's right.
                                     gain - Volume of the sound effect. Range: 0 to 100. Default is 100 (original volume). Lower values indicate lower volume. + The volume of the sound effect. The value range is from 0 to 100, with the default being 100 (original volume). The smaller the value, the lower the volume. publish Whether to publish the sound effect in the channel:
                    -
                  • : Publish.
                    • -
                  • : (Default) Do not publish.
                    • +
                  • : Publish the sound effect in the channel.
                    • +
                  • : (Default) Do not publish the sound effect in the channel.
                                     startPos - Start position for playing the sound effect file, in milliseconds. + The starting position of the sound effect file, in milliseconds. connection @@ -117,7 +121,7 @@ loopCount - The number of times the audio effect loops: + Number of times the audio effect loops:
                  • -1: Loops indefinitely until or is called.
                  • 0: Plays once.
                    • @@ -127,34 +131,34 @@ pitch - The pitch of the audio effect. The range is from 0.5 to 2.0, with the default value being 1.0 (original pitch). The smaller the value, the lower the pitch. + Pitch of the audio effect. The range is from 0.5 to 2.0. The default value is 1.0 (original pitch). The smaller the value, the lower the pitch. pan - The spatial position of the audio effect. The range is from -1.0 to 1.0: + Spatial position of the audio effect. The range is from -1.0 to 1.0:
                      -
                    • -1.0: The audio effect comes from the left of the user.
                      • -
                    • 0.0: The audio effect comes from the front of the user.
                      • -
                    • 1.0: The audio effect comes from the right of the user.
                      • +
                    • -1.0: The audio effect plays from the user's left.
                      • +
                    • 0.0: The audio effect plays from the user's front.
                      • +
                    • 1.0: The audio effect plays from the user's right.
                                         gain - The volume of the audio effect. The range is from 0.0 to 100.0, with the default value being 100.0 (original volume). The smaller the value, the lower the volume. + Volume of the audio effect. The range is from 0.0 to 100.0. The default value is 100 (original volume). The smaller the value, the lower the volume. publish Whether to publish the audio effect in the channel:
                      -
                    • : Publish the audio effect in the channel.
                      • -
                    • : Do not publish the audio effect in the channel.
                      • +
                    • : Publishes the audio effect in the channel.
                      • +
                    • : Does not publish the audio effect in the channel.
                                         startPos - The starting position (in milliseconds) for playing the audio effect file. + The start position (in milliseconds) for playback of the audio effect file.
                diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex2.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex2.dita index 18658f28a0e..0985b093231 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex2.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_playeffectex2.dita @@ -23,11 +23,13 @@
                Available since v4.6.0.
                -

                After preloading the audio effect using preloadEffect, you can call playEffectEx to play the specified audio effect to all users in the channel. Each call to this method can only play one audio effect. To play multiple audio effects simultaneously, use different soundId and filePath values and call this method multiple times.

                +

                After calling preloadEffectEx to preload the audio effect, you can use this method to play the specified audio effect to all users in the channel. You can call this method multiple times with different soundId and filePath to play multiple audio effects simultaneously. Each call to this method can only play one audio effect.

                • Agora recommends not playing more than three audio effects simultaneously.
                  • -
                • The audio effect ID and file path in this method must match those used in preloadEffect.
                  • +
                • The sound effect ID and file path in this method must be consistent with those in the preloadEffectEx method.
                  • +
                • If preloadEffectEx is called before playEffectEx, the file resource will not be closed after playEffectEx is executed. The next call to playEffectEx will start playback from the beginning.
                  • +
                • If preloadEffectEx is not called before playEffectEx, the resource will be destroyed after playEffectEx is executed. The next call to playEffectEx will attempt to reopen the file and play from the beginning.
                 @@ -48,11 +50,11 @@ filePath - The absolute path of a local file or the URL of an online file. Supported audio formats include mp3, mp4, m4a, aac, 3gp, mkv, and wav. + The absolute path of a local file or the URL of an online file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav. loopCount - The number of times the audio effect loops: + Number of times the audio effect loops:
                • -1: Loops indefinitely until or is called.
                • 0: Plays once.
                  • @@ -62,28 +64,28 @@ pitch - The pitch of the audio effect. The range is from 0.5 to 2.0, with the default value being 1.0 (original pitch). The smaller the value, the lower the pitch. + Pitch of the audio effect. The range is from 0.5 to 2.0. The default value is 1.0 (original pitch). The smaller the value, the lower the pitch. pan - The spatial position of the audio effect. The range is from -1.0 to 1.0: + Spatial position of the audio effect. The range is from -1.0 to 1.0:
                    -
                  • -1.0: The audio effect comes from the left of the user.
                    • -
                  • 0.0: The audio effect comes from the front of the user.
                    • -
                  • 1.0: The audio effect comes from the right of the user.
                    • +
                  • -1.0: The audio effect plays from the user's left.
                    • +
                  • 0.0: The audio effect plays from the user's front.
                    • +
                  • 1.0: The audio effect plays from the user's right.
                                     gain - The volume of the audio effect. The range is from 0.0 to 100.0, with the default value being 100 (original volume). The smaller the value, the lower the volume. + Volume of the audio effect. The range is from 0.0 to 100.0. The default value is 100 (original volume). The smaller the value, the lower the volume. publish Whether to publish the audio effect in the channel:
                    -
                  • : Publish the audio effect in the channel.
                    • -
                  • : Do not publish the audio effect in the channel.
                    • +
                  • : Publishes the audio effect in the channel.
                    • +
                  • : Does not publish the audio effect in the channel.
                                     diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex.dita index 0eb7434b479..3c755939d1e 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex.dita @@ -2,7 +2,7 @@ <ph keyref="preloadEffectEx"/> - Preloads a specified sound effect file into the channel.Preloads the specified audio effect file into the channel. + Preloads the specified sound effect into the channel.Preloads the specified audio effect into the channel. @@ -21,31 +21,35 @@
                  Since
                  -
                  Added since v4.6.0.
                  +
                  Available since v4.6.0.
                  Since
                  -
                  Available since v4.6.0.
                  +
                  Added since v4.6.0.
                  -

                  Each call to this method can preload only one sound effect file into memory. If you need to preload multiple sound effect files, call this method multiple times. After preloading is complete, you can call to play a specific sound effect or to play all preloaded sound effects.

                  -

                  Each call to this method can only preload one audio effect file into memory. To preload multiple audio effect files, call this method multiple times. You can call playEffect to play the preloaded audio effect, or call to play all preloaded audio effects.

                  +

                  Each time you call this method, you can preload only one sound effect file into memory. To preload multiple sound effect files, call this method multiple times. After preloading is complete, you can call to play the preloaded sound effect, or call to play all preloaded sound effects.

                  +

                  Each call to this method can preload only one audio effect file into memory. To preload multiple audio effect files, call this method multiple times. After preloading, you can call playEffect to play the preloaded audio effect, or call to play all preloaded audio effects.

                    -
                  • To ensure smooth user experience, the size of the sound effect file should not exceed the limit.
                    • +
                  • To ensure a smooth user experience, the size of the sound effect file should not exceed the limit.
                  • Agora recommends calling this method before joining a channel.
                    • +
                  • If you call before calling , the file resource will not be closed after is executed. The next time you call , playback will start from the beginning.
                    • +
                  • If you do not call before calling , the resource will be destroyed after is executed. The next time you call , it will attempt to reopen the file and start playback from the beginning.
                    -
                  • To ensure smooth user experience, the size of the audio effect file should not exceed the limit.
                    • +
                  • To ensure a smooth experience, the size of the audio effect file should not exceed the limit.
                  • Agora recommends calling this method before joining a channel.
                    • +
                  • If preloadEffectEx is called before playEffectEx, then after playEffectEx is executed, the file resource will not be closed. The next call to playEffectEx will start playback from the beginning.
                    • +
                  • If preloadEffectEx is not called before playEffectEx, then after playEffectEx is executed, the file resource will be destroyed. The next call to playEffectEx will attempt to reopen the file and play from the beginning.
                  Scenario -

                  This method is applicable in multi-channel scenarios.

                  +

                  This method applies to multi-channel scenarios.

                  Parameters @@ -60,11 +64,11 @@ filePath - Absolute path of the local file or URL of the online file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav. + The absolute path of the local file or the URL of the online file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav. startPos - Start position for playing the sound effect file (in milliseconds). + The starting position (in milliseconds) for playing the sound effect file. connection @@ -76,11 +80,11 @@ filePath - The absolute path of a local file or the URL of an online file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav. + Absolute path of a local file or URL of an online file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav. startPos - The starting position (in milliseconds) for playing the audio effect file. + Start position of the audio effect file in milliseconds.
                  diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex2.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex2.dita index 7b818711d5d..112eab92e51 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex2.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_preloadeffectex2.dita @@ -2,7 +2,7 @@ <ph keyref="preloadEffectEx2"/> - Preloads a specified sound effect file into the channel. + Preloads the specified audio effect into the channel. @@ -20,14 +20,16 @@
                  Since
                  -
                  Available since v4.6.0.
                  +
                  Added since v4.6.0.
                  -

                  Each call to this method can preload only one sound effect file into memory. To preload multiple sound effect files, call this method multiple times. After preloading, you can call playEffect to play the preloaded sound effect, or call to play all preloaded sound effects.

                  +

                  Each call to this method can preload only one audio effect file into memory. To preload multiple audio effect files, call this method multiple times. After preloading, you can call playEffect to play the preloaded audio effect, or call to play all preloaded audio effects.

                    -
                  • To ensure smooth user experience, the size of the sound effect file should not exceed the limit.
                    • +
                  • To ensure a smooth experience, the size of the audio effect file should not exceed the limit.
                  • Agora recommends calling this method before joining a channel.
                    • +
                  • If preloadEffectEx is called before playEffectEx, then after playEffectEx is executed, the file resource will not be closed. The next call to playEffectEx will start playback from the beginning.
                    • +
                  • If preloadEffectEx is not called before playEffectEx, then after playEffectEx is executed, the resource will be destroyed. The next call to playEffectEx will attempt to reopen the file and play from the beginning.
                   @@ -44,11 +46,11 @@ soundId - Sound effect ID. + Audio effect ID. filePath - Absolute path of the local file or URL of the online file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav. + Absolute path of a local file or URL of an online file. Supported audio formats include: mp3, mp4, m4a, aac, 3gp, mkv, and wav. diff --git a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_setvideoencoderconfigurationex.dita b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_setvideoencoderconfigurationex.dita index 6aeb6bcc19b..4642d3f5d07 100644 --- a/en-US/dita/RTC-AIDOC/API/api_irtcengineex_setvideoencoderconfigurationex.dita +++ b/en-US/dita/RTC-AIDOC/API/api_irtcengineex_setvideoencoderconfigurationex.dita @@ -26,11 +26,6 @@ Scenario

                  This method applies to multi-channel scenarios.

                  -
                  - Timing -

                  Call this method after calling .

                  -

                  Call this method after .

                  -
                  Parameters diff --git a/en-US/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onlocalvideoevent.dita b/en-US/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onlocalvideoevent.dita new file mode 100644 index 00000000000..735bafc36e3 --- /dev/null +++ b/en-US/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onlocalvideoevent.dita @@ -0,0 +1,59 @@ + + + + <ph keyref="onLocalVideoEvent"/> + Callback triggered when a local video event occurs. callback. + + + + + + + + +
                  +

                  + virtual void onLocalVideoEvent(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_EVENT_TYPE event) + public void onLocalVideoEvent(Constants.VideoSourceType source, int event) +

                  +
                  +
                  +
                  + +
                  Since
                  +
                  Available since v4.6.1.
                  +                   +
                  +

                  You can use this callback to get the reason for the event.

                  +

                  You can use this callback to get the reason why a local video event occurred.

                  +
                  +
                  + Parameters + + + source + Video source type. See . + + + event + Local video event type. See . + + + source + Video source type. See . + + + event + Local video event type: +
                    +
                  • LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_HIDDEN (1): The screen capture window is hidden.
                    • +
                  • LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN (2): The screen capture window recovers from hidden.
                    • +
                  • LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_STOPPED_BY_USER (3): The screen capture is stopped by the user.
                    • +
                  • LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_SYSTEM_INTERNAL_ERROR (4): A system internal error occurs during screen capture.
                    • +
                  +                   +                   +                   +
                  +                   +                   \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onpermissiongranted.dita b/en-US/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onpermissiongranted.dita new file mode 100644 index 00000000000..492bc048680 --- /dev/null +++ b/en-US/dita/RTC-AIDOC/API/callback_irtcengineeventhandler_onpermissiongranted.dita @@ -0,0 +1,41 @@ + + + + <ph keyref="onPermissionGranted"/> + Callback triggered when a permission is granted. callback. Used to report granted permissions. + + + + + + + + +
                  +

                  + virtual void onPermissionGranted(agora::rtc::PERMISSION_TYPE permissionType) {} + public void onPermissionGranted(int permission) +

                  +
                  +
                  +
                  + Parameters + + + permissionType + Permission type. See . + + + permission + Permission type, including: +
                    +
                  • RECORD_AUDIO: Microphone permission.
                    • +
                  • CAMERA: Camera permission.
                    • +
                  • SCREEN_CAPTURE: Screen capture permission.
                    • +
                  +                   +                   +                   +
                  + + \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/API/callback_ivideoencodedframeobserver_onencodedvideoframereceived.dita b/en-US/dita/RTC-AIDOC/API/callback_ivideoencodedframeobserver_onencodedvideoframereceived.dita index 0cd12efefb2..1fece4e1dbc 100644 --- a/en-US/dita/RTC-AIDOC/API/callback_ivideoencodedframeobserver_onencodedvideoframereceived.dita +++ b/en-US/dita/RTC-AIDOC/API/callback_ivideoencodedframeobserver_onencodedvideoframereceived.dita @@ -2,7 +2,7 @@ <ph keyref="onEncodedVideoFrameReceived"/> - Reports that the receiver has received the encoded video frame sent by the remote user.Callback when the receiver receives a remote encoded video frame. + Reports that the receiver has received the encoded video frame sent by the remote user.Callback when a remote encoded video frame is received.Callback when the receiver receives a remote encoded video frame.Callback when a remote encoded video frame is received. @@ -14,7 +14,9 @@

                  virtual bool onEncodedVideoFrameReceived(const char* channelId, rtc::uid_t uid, const uint8_t* imageBuffer, size_t length, const rtc::EncodedVideoFrameInfo& videoEncodedFrameInfo) = 0; + - (BOOL)onEncodedVideoFrameReceived:(NSData * _Nonnull )videoData length:(size_t)length info:(AgoraEncodedVideoFrameInfo * _Nonnull)videoFrameInfo channelId:(NSString * _Nonnull)channelId uid:(NSUInteger)uid NS_SWIFT_NAME(onEncodedVideoFrameReceived(_:length:info:channelId:uid:)); boolean onEncodedVideoFrameReceived(String channelId, int remoteUid, ByteBuffer buffer, EncodedVideoFrameInfo info) + - (BOOL)onEncodedVideoFrameReceived:(NSData * _Nonnull )videoData length:(size_t)length info:(AgoraEncodedVideoFrameInfo * _Nonnull)videoFrameInfo channelId:(NSString * _Nonnull)channelId uid:(NSUInteger)uid NS_SWIFT_NAME(onEncodedVideoFrameReceived(_:length:info:channelId:uid:));

                  @@ -23,36 +25,71 @@
                  Since
                  Available since v4.6.0.
                  + +
                  Since
                  +
                  Available since v4.6.0.
                  +
                  Since
                  Available since v4.6.0.
                   + +
                  Since
                  +
                  Available since v4.6.0.
                  +

                  If you call the method and set encodedFrameOnly to , the SDK triggers this callback locally to report the received encoded video frame information.

                  +

                  If you call the setRemoteVideoSubscriptionOptions method and set encodedFrameOnly to , the SDK triggers this callback locally to report the received encoded video frame information.

                  If you call the method and set encodedFrameOnly to , the SDK triggers this callback locally to report the received encoded video frame information.

                  +

                  If you call the setRemoteVideoSubscriptionOptions method and set encodedFrameOnly to , the SDK triggers this callback locally to report the received encoded video frame information.

                  +
                  +
                  + Trigger Timing +

                  This callback is triggered when you set encodedFrameOnly to .

                  +

                  This callback is triggered when you set encodedFrameOnly to .

                  -
                  +
                  Parameters channelId - Channel name. + The channel name. uid - Remote user ID. + The remote user ID. imageBuffer - Encoded video image buffer. + The buffer of the encoded video image. length - Data length of the video image. + The length of the video image data. videoEncodedFrameInfo - Information of the encoded video frame. See . + Information about the encoded video frame. See . + + + videoData + Encoded video image data. + + + length + Length of the video image data. + + + videoFrameInfo + Information about the encoded video frame. See AgoraEncodedVideoFrameInfo. + + + channelId + Channel name. + + + uid + Remote user ID. channelId @@ -70,14 +107,40 @@ info Information of the encoded video frame. See . + + videoData + Encoded video image data. + + + length + Length of the video image data. + + + videoFrameInfo + Information about the encoded video frame. See AgoraEncodedVideoFrameInfo. + + + channelId + Channel name. + + + uid + Remote user ID. +
                  -
                  +
                  Return Values

                    -
                  • : Callback processed successfully.
                    • -
                  • : Callback processing failed.
                    • +
                  • : Callback handled successfully.
                    • +
                  • : Callback handling failed.
                    • +
                  +

                  +

                  +

                    +
                  • : Callback handled successfully.
                    • +
                  • : Callback handling failed.

                  @@ -86,6 +149,12 @@

                • : Callback processing failed.

                +

                +

                  +
                • : Callback handled successfully.
                  • +
                • : Callback handling failed.
                  • +
                +

                \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/API/class_channelmediaoptions.dita b/en-US/dita/RTC-AIDOC/API/class_channelmediaoptions.dita index 5a7b97437c3..d27214b4c9a 100644 --- a/en-US/dita/RTC-AIDOC/API/class_channelmediaoptions.dita +++ b/en-US/dita/RTC-AIDOC/API/class_channelmediaoptions.dita @@ -2,7 +2,7 @@ <ph keyref="ChannelMediaOptions"/> - Used to set channel media options.Configures media publishing and subscription options in the channel. + Used to configure channel media options.Configures media publishing and subscription options in the channel.

                @@ -12,9 +12,11 @@ Optional<bool> publishThirdCameraTrack; Optional<bool> publishFourthCameraTrack; Optional<bool> publishMicrophoneTrack; +#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(TARGET_OS_MAC) || defined(__OHOS__) + Optional<bool> publishScreenCaptureAudio; +#endif #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__) Optional<bool> publishScreenCaptureVideo; - Optional<bool> publishScreenCaptureAudio; #else Optional<bool> publishScreenTrack; Optional<bool> publishSecondaryScreenTrack; @@ -95,9 +97,9 @@

                -

                Supports publishing multiple audio streams and one video stream simultaneously in the same . For example, you can set publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack to at the same time, but only one of publishCameraTrack, publishScreenCaptureVideo, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set to .

                +

                Agora supports publishing multiple audio streams and one video stream simultaneously in the same . For example, you can set publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack to at the same time, but only one among publishCameraTrack, publishScreenCaptureVideo, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set to .

                Supports publishing multiple audio streams and one video stream simultaneously within the same . For example, you can enable publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack at the same time, but only one of publishCameraTrack, publishScreenCaptureVideo, publishCustomVideoTrack, and publishEncodedVideoTrack can be set to .

                - We recommend that you set the member parameters according to your business scenario. Otherwise, the SDK automatically assigns values to them. + Agora recommends that you configure the member parameter values based on your business scenario. Otherwise, the SDK will automatically assign values to the member parameters. It is recommended that you set the values of each member parameter according to your business scenario; otherwise, the SDK will assign default values automatically.
                @@ -107,8 +109,8 @@ publishCameraTrack Whether to publish the video captured by the camera:
                  -
                • : Publish the camera video.
                  • -
                • : Do not publish the camera video.
                  • +
                • : Publish the video captured by the camera.
                  • +
                • : Do not publish the video captured by the camera.
                 @@ -116,28 +118,28 @@ publishSecondaryCameraTrack Whether to publish the video captured by the secondary camera:
                  -
                • : Publish the secondary camera video.
                  • -
                • : Do not publish the secondary camera video.
                  • +
                • : Publish the video captured by the secondary camera.
                  • +
                • : Do not publish the video captured by the secondary camera.
                 publishThirdCameraTrack - (Android, Windows, and macOS only)Whether to publish the video captured by the third camera: + This parameter is only applicable to Android, Windows, and macOS platforms.Whether to publish the video captured by the third camera:
                  -
                • : Publish the third camera video.
                  • -
                • : Do not publish the third camera video.
                  • +
                • : Publish the video captured by the third camera.
                  • +
                • : Do not publish the video captured by the third camera.
                                 publishFourthCameraTrack - (Android, Windows, and macOS only)Whether to publish the video captured by the fourth camera: + This parameter is only applicable to Android, Windows, and macOS platforms.Whether to publish the video captured by the fourth camera:
                  -
                • : Publish the fourth camera video.
                  • -
                • : Do not publish the fourth camera video.
                  • +
                • : Publish the video captured by the fourth camera.
                  • +
                • : Do not publish the video captured by the fourth camera.
                                 @@ -145,38 +147,28 @@ publishMicrophoneTrack Whether to publish the audio captured by the microphone:
                  -
                • : Publish the microphone audio.
                  • -
                • : Do not publish the microphone audio.
                  • +
                • : Publish the audio captured by the microphone.
                  • +
                • : Do not publish the audio captured by the microphone.
                 publishScreenCaptureVideo - (Android and iOS only)Whether to publish the video captured from the screen: + This parameter is only applicable to Android and iOS platforms.Whether to publish the video captured from screen:
                  -
                • : Publish the screen video.
                  • -
                • : Do not publish the screen video.
                  • -
                -                 -                 - - publishScreenCaptureAudio - - (Android and iOS only)Whether to publish the audio captured from the screen: -
                  -
                • : Publish the screen audio.
                  • -
                • : Do not publish the screen audio.
                  • +
                • : Publish the video captured from screen.
                  • +
                • : Do not publish the video captured from screen.
                                 publishScreenTrack - (Windows and macOS only)Whether to publish the video captured from the screen: + This parameter is only applicable to Windows and macOS platforms.Whether to publish the video captured from screen:
                  -
                • : Publish the screen video.
                  • -
                • : Do not publish the screen video.
                  • +
                • : Publish the video captured from screen.
                  • +
                • : Do not publish the video captured from screen.
                                 @@ -184,259 +176,43 @@ publishSecondaryScreenTrack Whether to publish the video captured from the second screen:
                  -
                • : Publish the second screen video.
                  • -
                • : Do not publish the second screen video.
                  • +
                • : Publish the video captured from the second screen.
                  • +
                • : Do not publish the video captured from the second screen.
                 publishThirdScreenTrack - (Windows and macOS only)Whether to publish the video captured from the third screen: + This parameter is only applicable to Windows and macOS platforms.Whether to publish the video captured from the third screen:
                  -
                • : Publish the third screen video.
                  • -
                • : Do not publish the third screen video.
                  • +
                • : Publish the video captured from the third screen.
                  • +
                • : Do not publish the video captured from the third screen.
                                 publishFourthScreenTrack - (Windows and macOS only)Whether to publish the video captured from the fourth screen: + This parameter is only applicable to Windows and macOS platforms.Whether to publish the video captured from the fourth screen:
                  -
                • : Publish the fourth screen video.
                  • -
                • : Do not publish the fourth screen video.
                  • +
                • : Publish the video captured from the fourth screen.
                  • +
                • : Do not publish the video captured from the fourth screen.
                                 publishCustomAudioTrack - Whether to publish the audio from a custom audio source: + Whether to publish the audio captured from a custom audio source:
                  -
                • : Publish the custom audio.
                  • -
                • : Do not publish the custom audio.
                  • +
                • : Publish the audio captured from a custom audio source.
                  • +
                • : Do not publish the audio captured from a custom audio source.
                                 publishCustomAudioTrackId - The ID of the custom audio track to publish. Default is 0. You can get the custom audio track ID by calling . - - - publishCustomVideoTrack - Whether to publish the video from a custom video source: -
                  -
                • : Publish the custom video.
                  • -
                • : Do not publish the custom video.
                  • -
                -                 -                 - - publishEncodedVideoTrack - Whether to publish the encoded video: -
                  -
                • : Publish the encoded video.
                  • -
                • : Do not publish the encoded video.
                  • -
                -                 -                 - - publishMediaPlayerAudioTrack - Whether to publish the audio from the media player: -
                  -
                • : Publish the media player audio.
                  • -
                • : Do not publish the media player audio.
                  • -
                -                 -                 - - publishMediaPlayerVideoTrack - Whether to publish the video from the media player: -
                  -
                • : Publish the media player video.
                  • -
                • : Do not publish the media player video.
                  • -
                -                 -                 - - publishTranscodedVideoTrack - - Since v4.2.0, the parameter name has been corrected from publishTrancodedVideoTrack to publishTranscodedVideoTrack.Whether to publish the local transcoded video: -
                  -
                • : Publish the local transcoded video.
                  • -
                • : Do not publish the local transcoded video.
                  • -
                -                 -                 - - publishMixedAudioTrack - Whether to publish the mixed audio track: -
                  -
                • : Publish the mixed audio track.
                  • -
                • : Do not publish the mixed audio track.
                  • -
                -                 -                 - - publishLipSyncTrack - Whether to publish the video track processed by voice-driven extension: -
                  -
                • : Publish the video track processed by voice-driven extension.
                  • -
                • : (Default) Do not publish the video track processed by voice-driven extension.
                  • -
                -                 -                 - - autoSubscribeAudio - Whether to automatically subscribe to all remote audio streams when joining a channel: -
                  -
                • : Subscribe to all remote audio streams.
                  • -
                • : Do not automatically subscribe to any remote audio streams.
                  • -
                -                 -                 - - autoSubscribeVideo - Whether to automatically subscribe to all remote video streams when joining a channel: -
                  -
                • : Subscribe to all remote video streams.
                  • -
                • : Do not automatically subscribe to any remote video streams.
                  • -
                -                 -                 - - enableAudioRecordingOrPlayout - - If you want to publish microphone audio, make sure this parameter is set to .Whether to enable audio recording or playout: -
                  -
                • : Enable recording or playout.
                  • -
                • : Do not enable recording or playout.
                  • -
                -                 -                 - - publishMediaPlayerId - The ID of the media player to publish. Default is 0. - - - clientRoleType - User role. See . - If the user role is set to audience, you cannot publish audio or video streams in the channel. If you want to publish media streams in a live broadcast, make sure to set the user role to broadcaster. - - - - audienceLatencyLevel - Latency level for audience in interactive live streaming. See . - - - defaultVideoStreamType - Default video stream type. See . - - - channelProfile - Channel profile. See . - - - audioDelayMs - Delay in sending audio frames (in ms). You can use this parameter to delay audio frames to ensure audio-video sync. Set to 0 to disable delay. - - - mediaPlayerAudioDelayMs - Delay in sending media player audio frames (in ms). Used to explicitly control audio-video sync. Set to 0 to disable delay. - - - token - (Optional) Token for authentication generated on your server. - -
                  -
                • This parameter takes effect only when calling or .
                  • -
                • Make sure the App ID, channel name, and user name used to generate the token are the same as those used in the , joinChannel, and methods.
                  • -
                -                 -                 -                 - - enableBuiltInMediaEncryption - - Ignored when calling .Whether to enable media packet encryption: -
                  -
                • : Enable.
                  • -
                • : (Default) Do not enable.
                  • -
                -                 -                 - - publishRhythmPlayerTrack - Whether to publish the metronome sound to remote users: -
                  -
                • : Publish the processed audio frame. Both local and remote users can hear the metronome.
                  • -
                • : Do not publish the metronome sound. Only the local user can hear it.
                  • -
                -                 -                 - - isInteractiveAudience - - -
                  -
                • This parameter applies only to co-hosted live streaming scenarios. Co-hosts must call to join another host's channel as an audience and set isInteractiveAudience to true.
                  • -
                • This parameter takes effect only when the user role is CLIENT_ROLE_AUDIENCE.
                  • -
                -                 Whether to enable interactive mode: -
                  -
                • : Enable interactive mode.
                  • -
                • : Do not enable interactive mode.
                  • -
                -                 -                 - - customVideoTrackId - The video track ID returned by calling . Default is 0. - - - isAudioFilterable - - To enable this feature, contact technical support.Whether to filter the published audio stream based on volume algorithm: -
                  -
                • : Audio stream is filtered. This setting has no effect if audio stream filtering is not enabled.
                  • -
                • : Audio stream is not filtered.
                  • -
                -                 -                 - - enableMultipath - - Permissions and system requirements: -
                  -
                • Android: Android 7.0 or later (API level 24+), requires ACCESS_NETWORK_STATE and CHANGE_NETWORK_STATE permissions.
                  • -
                • iOS: iOS 12.0 or later.
                  • -
                • macOS: 10.14 or later.
                  • -
                • Windows: Windows Vista or later.
                  • -
                -                 Whether to enable multipath transmission: -
                  -
                • : Enable multipath.
                  • -
                • : Disable multipath.
                  • -
                -                 -                 - - uplinkMultipathMode - Uplink transmission mode. See . - Make sure enableMultipath is set to true when using this parameter. - - - - downlinkMultipathMode - Downlink transmission mode. See . - Make sure enableMultipath is set to true when using this parameter. - - - - preferMultipathType - Preferred path type for transmission. See . - Make sure enableMultipath is set to true when using this parameter. - + The ID of the custom audio track to be published. Default is 0. You can get the custom audio track ID via . publishCameraTrack @@ -640,13 +416,12 @@ channelProfile - - Deprecated since v4.x.x. Use CHANNEL_PROFILE_LIVE_BROADCASTING instead.Channel profile: + Channel profile:
                • CHANNEL_PROFILE_COMMUNICATION (0): Communication profile. Agora recommends using the live broadcast profile for better audio and video experience.
                • CHANNEL_PROFILE_LIVE_BROADCASTING (1): Live broadcast profile (default).
                  • -
                • CHANNEL_PROFILE_GAME (2): Game profile.
                  • -
                • CHANNEL_PROFILE_CLOUD_GAMING (3): Interactive profile. This profile is optimized for low latency and suitable for scenarios requiring frequent interaction between users.
                  • +
                • CHANNEL_PROFILE_GAME (2): Game profile. This profile is deprecated. Use CHANNEL_PROFILE_LIVE_BROADCASTING instead.
                  • +
                • CHANNEL_PROFILE_CLOUD_GAMING (3): Interactive profile. This profile is optimized for low latency and suitable for scenarios requiring frequent interaction between users. This profile is deprecated. Use CHANNEL_PROFILE_LIVE_BROADCASTING instead.
                                 diff --git a/en-US/dita/RTC-AIDOC/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-AIDOC/API/class_encodedvideoframeinfo.dita index 095886ab062..53298aa888a 100644 --- a/en-US/dita/RTC-AIDOC/API/class_encodedvideoframeinfo.dita +++ b/en-US/dita/RTC-AIDOC/API/class_encodedvideoframeinfo.dita @@ -2,7 +2,7 @@ <ph keyref="EncodedVideoFrameInfo"/> - Describes information about externally encoded video frames.Contains information about externally encoded video frames. + Describes information of externally encoded video frames.Contains information about externally encoded video frames.

                @@ -38,27 +38,27 @@ codecType - Codec type of the local video stream. See . + The codec type of the local video stream. See . width - Width of the video frame (in pixels). + The width of the video frame (in pixels). height - Height of the video frame (in pixels). + The height of the video frame (in pixels). framesPerSecond - Frames per second of the video frame. When this parameter is not 0, it can be used to calculate the Unix timestamp of the externally encoded video frame. + The frame rate of the video frame. When this parameter is not 0, it can be used to calculate the Unix timestamp of the externally encoded video frame. frameType - Type of the video frame. See . + The type of the video frame. See . rotation - Rotation information of the video frame. See . + The rotation information of the video frame. See . trackId @@ -66,44 +66,44 @@ captureTimeMs - Capture timestamp of the externally encoded video frame (in milliseconds, Unix timestamp). + The capture timestamp of the externally encoded video frame (in milliseconds, Unix timestamp). decodeTimeMs - Decode timestamp of the externally encoded video frame (in milliseconds, Unix timestamp). + The decode timestamp of the externally encoded video frame (in milliseconds, Unix timestamp). streamType - Type of the video stream. See . + The type of the video stream. See . codecType - In certain scenarios, such as when the captured video stream has low resolution or the device has limited performance, the SDK automatically switches to H.264 encoding.Video codec type: + In certain scenarios, such as when the captured video stream has low resolution or the device performance is limited, the SDK automatically switches to the H.264 codec format.The codec type of the video:

                • 1: VIDEO_CODEC_VP8, VP8.
                • 2: VIDEO_CODEC_H264, H.264.
                  • -
                • 3 (default): VIDEO_CODEC_H265, H.265.
                  • +
                • 3: (default) VIDEO_CODEC_H265, H.265.
                width - Width of the video frame (in pixels). + The width of the video frame (in pixels). height - Height of the video frame (in pixels). + The height of the video frame (in pixels). framesPerSecond - Frames per second of the video frame. When this parameter is not 0, you can use it to calculate the Unix timestamp of the externally encoded video frame. + The number of frames per second of the video frame. When this parameter is not 0, you can use it to calculate the Unix timestamp of the externally encoded video frame. frameType - Video frame type: + The type of the video frame:
                  -
                • 0 (default): VIDEO_FRAME_TYPE_BLANK_FRAME, blank frame.
                  • +
                • 0: (default) VIDEO_FRAME_TYPE_BLANK_FRAME, blank frame.
                • 3: VIDEO_FRAME_TYPE_KEY_FRAME, key frame.
                • 4: VIDEO_FRAME_TYPE_DELTA_FRAME, delta frame.
                • 5: VIDEO_FRAME_TYPE_B_FRAME, B frame.
                  • @@ -113,9 +113,9 @@ rotation - Rotation angle of the video frame: + The rotation angle of the video frame:
                    -
                  • 0 (default): 0 degrees.
                    • +
                  • 0: (default) 0 degrees.
                  • 90: 90 degrees.
                  • 180: 180 degrees.
                  • 270: 270 degrees.
                    • @@ -128,7 +128,7 @@ captureTimeMs - Unix timestamp (in milliseconds) when the externally encoded video frame was captured. + The Unix timestamp (in milliseconds) when the externally encoded video frame was captured. decodeTimeMs @@ -136,7 +136,7 @@ streamType - Type of the video stream. + The type of the video stream.
                diff --git a/en-US/dita/RTC-AIDOC/API/class_localvideostats.dita b/en-US/dita/RTC-AIDOC/API/class_localvideostats.dita index 9f555c63175..590aea8d593 100644 --- a/en-US/dita/RTC-AIDOC/API/class_localvideostats.dita +++ b/en-US/dita/RTC-AIDOC/API/class_localvideostats.dita @@ -2,7 +2,7 @@ <ph keyref="LocalVideoStats"/> - Used to collect statistics about the local video stream.Statistics of the local video stream. + Collects statistics of the local video stream.Statistics of the local video stream.

                @@ -58,7 +58,7 @@ public boolean dualStreamEnabled; public int hwEncoderAccelerating; public int encodedFrameDepth; - } +}

                @@ -66,39 +66,39 @@ uid - The user ID of the local user. + User ID of the local user. sentBitrate - Actual bitrate (Kbps) of the local video stream sent. + Actual bitrate (Kbps) of the sent local video stream. sentFrameRate - Actual frame rate (fps) of the local video stream sent. + Actual frame rate (fps) of the sent local video stream. captureFrameRate - Frame rate (fps) of the local video stream captured. + Frame rate (fps) of the captured local video stream. captureFrameWidth - Width (px) of the local video stream captured. + Width (px) of the captured local video stream. captureFrameHeight - Height (px) of the local video stream captured. + Height (px) of the captured local video stream. regulatedCaptureFrameRate - Frame rate (fps) of the local video stream after adjustment by the SDK's built-in video capture regulator. + Frame rate (fps) of the local video stream after being adjusted by the SDK's built-in video capture regulator. regulatedCaptureFrameWidth - Width (px) of the local video stream after adjustment by the SDK's built-in video capture regulator. + Width (px) of the local video stream after being adjusted by the SDK's built-in video capture regulator. regulatedCaptureFrameHeight - Height (px) of the local video stream after adjustment by the SDK's built-in video capture regulator. + Height (px) of the local video stream after being adjusted by the SDK's built-in video capture regulator. encoderOutputFrameRate @@ -118,7 +118,7 @@ targetBitrate - Target bitrate (Kbps) of the current encoder, estimated by the SDK based on current network conditions. + Target bitrate (Kbps) of the current encoder, estimated by the SDK based on the current network conditions. targetFrameRate @@ -126,7 +126,7 @@ qualityAdaptIndication - Quality adaptation of the local video stream during the reporting interval (based on target frame rate and target bitrate). See . + Quality adaptation status of the local video stream during the reporting interval (based on target frame rate and target bitrate). See . encodedBitrate @@ -134,7 +134,7 @@ encodedFrameCount - Total number of video frames sent (aggregated value). + Total number of sent video frames (aggregated value). codecType @@ -159,7 +159,7 @@ hwEncoderAccelerating - Local video encoding acceleration type: + Local video encoder acceleration type:
                • 0: Software encoding, no acceleration.
                • 1: Hardware encoding acceleration.
                  • @@ -176,13 +176,13 @@ sentBitrate - Actual bitrate (Kbps) during the sending of the local video stream. + Actual bitrate (Kbps) of the local video stream during transmission. This value does not include the bitrate of retransmissions caused by packet loss. sentFrameRate - Actual frame rate (fps) during the sending of the local video stream. + Actual frame rate (fps) of the local video stream during transmission. This value does not include the frame rate of retransmissions caused by packet loss. @@ -200,15 +200,15 @@ regulatedCaptureFrameRate - Frame rate (fps) of the local video after adjustment by the built-in video capture regulator according to the encoding configuration. + Frame rate (fps) of the local video adjusted by the built-in video capture regulator of the Agora SDK based on the encoding configuration. regulatedCaptureFrameWidth - Width (px) of the local video after adjustment by the built-in video capture regulator according to the encoding configuration. + Width (px) of the local video adjusted by the built-in video capture regulator of the Agora SDK based on the encoding configuration. regulatedCaptureFrameHeight - Height (px) of the local video after adjustment by the built-in video capture regulator according to the encoding configuration. + Height (px) of the local video adjusted by the built-in video capture regulator of the Agora SDK based on the encoding configuration. encoderOutputFrameRate @@ -221,7 +221,7 @@ targetBitrate Target bitrate (Kbps) of the current encoder. - This value is estimated by the SDK based on current network conditions. + This value is estimated by the SDK based on the current network conditions. @@ -230,11 +230,11 @@ qualityAdaptIndication - Video quality adaptation status of the local video stream during the statistics interval: + Video quality adaptation status of the local video stream during the statistical period:
                    -
                  • ADAPT_NONE (0): Local video quality remains unchanged.
                    • -
                  • ADAPT_UP_BANDWIDTH (1): Local video quality improves due to increased network bandwidth.
                    • -
                  • ADAPT_DOWN_BANDWIDTH (2): Local video quality degrades due to decreased network bandwidth.
                    • +
                  • ADAPT_NONE (0): Video quality remains unchanged.
                    • +
                  • ADAPT_UP_BANDWIDTH (1): Video quality improves due to increased network bandwidth.
                    • +
                  • ADAPT_DOWN_BANDWIDTH (2): Video quality degrades due to decreased network bandwidth.
                                     @@ -259,7 +259,7 @@ codecType - In some scenarios (e.g., low capture resolution or limited device performance), the SDK automatically switches to H.264 encoding format.Type of encoder used for the local video. Optional values, see : + In some scenarios (e.g., low capture resolution or limited device performance), the SDK automatically switches to H.264 encoding format.Encoder type used for the local video. The optional values are as follows. See :
                  • VIDEO_CODEC_VP8 (1): VP8.
                  • VIDEO_CODEC_H264 (2): H.264.
                    • @@ -274,7 +274,7 @@ captureBrightnessLevel - Wait a few seconds to get the brightness level from the next callback via captureBrightnessLevel.Brightness level of the video captured by the local camera: + After a few seconds, you can get the brightness level from the next callback's captureBrightnessLevel.Brightness level of the video image captured by the local camera:
                    • CAPTURE_BRIGHTNESS_LEVEL_INVALID (-1): SDK did not detect brightness.
                    • CAPTURE_BRIGHTNESS_LEVEL_NORMAL (0): Normal brightness.
                      • @@ -294,10 +294,10 @@ hwEncoderAccelerating - Local video encoder acceleration type: + Hardware acceleration type for local video encoding:
                      • 0: Software encoding, no acceleration.
                        • -
                      • 1: Hardware-accelerated encoding.
                        • +
                      • 1: Hardware encoding acceleration.
                                             diff --git a/en-US/dita/RTC-AIDOC/API/class_screenaudioparameters.dita b/en-US/dita/RTC-AIDOC/API/class_screenaudioparameters.dita index 967ec54b5db..7b8d15d5869 100644 --- a/en-US/dita/RTC-AIDOC/API/class_screenaudioparameters.dita +++ b/en-US/dita/RTC-AIDOC/API/class_screenaudioparameters.dita @@ -2,14 +2,18 @@ <ph keyref="ScreenAudioParameters"/> - Used to set audio parameters for the screen sharing stream.Configures audio parameters for screen sharing stream. + Used to set the audio parameters of the screen sharing stream.Configures audio parameters for screen sharing stream.

                      struct ScreenAudioParameters { - int sampleRate = 16000; - int channels = 2; - int captureSignalVolume = 100; + int sampleRate; + int channels; + int captureSignalVolume; +#if defined(__APPLE__) && !TARGET_OS_IOS + bool excludeCurrentProcessAudio = true; +#else +#endif }; public static class AudioCaptureParameters { public int sampleRate = 16000; @@ -34,7 +38,7 @@ sampleRate - Audio sample rate (Hz). Default is 16000. + Audio sample rate in Hz. channels @@ -42,7 +46,7 @@ captureSignalVolume - Volume of captured system audio. Range is [0, 100], default is 100. + Captured system audio volume. Value range is [0, 100], default is 100. sampleRate diff --git a/en-US/dita/RTC-AIDOC/API/class_screencaptureparameters.dita b/en-US/dita/RTC-AIDOC/API/class_screencaptureparameters.dita index 6627c973c6e..c5d593007c2 100644 --- a/en-US/dita/RTC-AIDOC/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-AIDOC/API/class_screencaptureparameters.dita @@ -2,11 +2,13 @@ <ph keyref="ScreenCaptureParameters"/> - Used to configure screen sharing parameters. + Parameters used to configure screen sharing.

                      struct ScreenCaptureParameters { + bool captureAudio; + ScreenAudioParameters audioParams; VideoDimensions dimensions; int frameRate; int bitrate; @@ -26,24 +28,24 @@ dimensions - When setting encoding resolution for document sharing scenarios, refer to the recommended settings.Encoded resolution of the screen sharing video stream. Default is 1920 × 1080, i.e., 2,073,600 pixels. Agora calculates fees based on this value. If the screen size differs from this value, the SDK adopts the following encoding strategy. Assuming dimensions is set to 1920 × 1080: + When setting the encoding resolution in document sharing scenarios, refer to the recommended settings.The encoding resolution of the screen sharing video stream. The default value is 1920 × 1080, which equals 2,073,600 pixels. Agora calculates the cost based on this value. If the screen size differs from this value, the SDK uses the following encoding strategy. Assuming dimensions is set to 1920 × 1080:

                        -
                      • If the screen size is smaller, e.g., 1000 × 1000 pixels, the SDK encodes using the screen size (i.e., 1000 × 1000).
                        • -
                      • If the screen size is larger, e.g., 2000 × 1500 pixels, the SDK encodes with a maximum size not exceeding dimensions while maintaining the aspect ratio (4:3), i.e., 1440 × 1080.
                        • -
                      See . +
                    • If the screen size is smaller than dimensions, such as 1000 × 1000 pixels, the SDK encodes using the screen size (i.e., 1000 × 1000 pixels).
                      • +
                    • If the screen size is larger than dimensions, such as 2000 × 1500 pixels, the SDK encodes using the maximum value that does not exceed dimensions while maintaining the screen's aspect ratio (4:3), i.e., 1440 × 1080.
                      • +
                    See also .                                         frameRate - On Windows and macOS, indicates the encoding frame rate (fps) of the screen sharing video stream. Default is 5. Agora does not recommend setting values above 15. + On Windows and macOS, specifies the encoding frame rate (fps) of the screen sharing video stream. The default value is 5. Agora does not recommend setting a value greater than 15. bitrate - On Windows and macOS, indicates the encoding bitrate (Kbps) of the screen sharing video stream. Default is 0, meaning the SDK automatically calculates the bitrate based on screen resolution. + On Windows and macOS, specifies the encoding bitrate (Kbps) of the screen sharing video stream. The default value is 0, meaning the SDK automatically calculates the bitrate based on the current screen resolution. captureMouseCursor - Due to macOS system limitations, setting this to during screen sharing is ineffective (not affected when sharing a window).Whether to capture the mouse during screen sharing: + Due to macOS system limitations, setting this to during screen sharing has no effect (not applicable when sharing a window).Whether to capture the mouse cursor during screen sharing:
                    • : (default) Capture the mouse.
                    • : Do not capture the mouse.
                      • @@ -53,45 +55,45 @@ windowFocus - Due to macOS system limitations, if the app has multiple windows, only the main window will be brought to the foreground.When calling to share a window, whether to bring the window to the foreground: + Due to macOS system limitations, when setting this parameter to bring the window to the front, only the main window will be brought to the front if the current app has multiple windows.When calling the method to share a window, whether to bring the window to the front:
                        -
                      • : Bring to foreground.
                        • -
                      • : (default) Do not bring to foreground.
                        • +
                      • : Bring the window to the front.
                        • +
                      • : (default) Do not bring the window to the front.
                                             excludeWindowList - List of window IDs to exclude. When starting screen sharing using , use this parameter to exclude specific windows. You can also use it to dynamically exclude windows via . + List of window IDs to exclude. When calling to start screen sharing, you can use this parameter to exclude specific windows. When calling to update screen sharing configuration, you can also use this parameter to dynamically exclude specific windows. excludeWindowCount Number of windows to exclude. - On Windows, the maximum value is 24; exceeding this will cause exclusion to fail. + On Windows, the maximum value of this parameter is 24; exceeding this value will cause window exclusion to fail. highLightWidth - (macOS and Windows only) Width of the border (pixels). Default is 5, range is (0, 50]. + (Applicable only to macOS and Windows) Border width (in pixels). The default value is 5. Value range is (0, 50]. This parameter takes effect only when highLighted is set to . highLightColor - (macOS and Windows only) + (Applicable only to macOS and Windows)
                        -
                      • On Windows, the border color is in ARGB format. Default is 0xFF8CBF26.
                        • -
                      • On macOS, COLOR_CLASS represents NSColor.
                        • +
                      • On Windows, the border color is in ARGB format. Default value is 0xFF8CBF26.
                        • +
                      • On macOS, COLOR_CLASS refers to NSColor.
                                             enableHighLight - When sharing part of a window or screen, if this is set to , the SDK displays a border around the entire window or screen.(macOS and Windows only) Whether to display a border around the shared window or screen: + When sharing a portion of a window or screen, if this parameter is set to , the SDK displays a border around the entire window or screen.(Applicable only to macOS and Windows) Whether to show a border around the shared window or screen:
                        -
                      • : Display border.
                        • -
                      • : (default) Do not display border.
                        • +
                      • : Show the border.
                        • +
                      • : (default) Do not show the border.
                                             diff --git a/en-US/dita/RTC-AIDOC/API/enum_channelprofiletype.dita b/en-US/dita/RTC-AIDOC/API/enum_channelprofiletype.dita index 4ea5186a1e1..fa25caed62d 100644 --- a/en-US/dita/RTC-AIDOC/API/enum_channelprofiletype.dita +++ b/en-US/dita/RTC-AIDOC/API/enum_channelprofiletype.dita @@ -17,15 +17,15 @@ CHANNEL_PROFILE_GAME - (2): Gaming scenario. Deprecated since v4.5.0. + (2): Gaming scenario. + This profile is deprecated. Use CHANNEL_PROFILE_LIVE_BROADCASTING instead. + CHANNEL_PROFILE_CLOUD_GAMING - (3): Cloud gaming scenario. Optimized for latency, suitable for scenarios requiring frequent interaction between users. Deprecated since v4.5.0. - - - CHANNEL_PROFILE_COMMUNICATION_1v1 - (4): Communication 1v1 scenario. Deprecated since v4.5.0. + (3): Cloud gaming scenario. Optimized for latency, suitable for scenarios requiring frequent interaction between users. + This profile is deprecated. Use CHANNEL_PROFILE_LIVE_BROADCASTING instead. +
                diff --git a/en-US/dita/RTC-AIDOC/API/enum_errorcodetype.dita b/en-US/dita/RTC-AIDOC/API/enum_errorcodetype.dita index 4f2ed829c11..6eacfd18eae 100644 --- a/en-US/dita/RTC-AIDOC/API/enum_errorcodetype.dita +++ b/en-US/dita/RTC-AIDOC/API/enum_errorcodetype.dita @@ -13,7 +13,7 @@ ERR_FAILED - (1): A general error with unspecified reason. Please retry the method. + (1): General error with unspecified reason. Please retry the method. ERR_INVALID_ARGUMENT @@ -21,23 +21,23 @@ ERR_NOT_READY - (3): SDK is not ready. Possible reasons include: initialization failed; method called before joining a channel; or called before leaving the channel; audio module is disabled; incomplete program. + (3): SDK is not ready. Possible causes include: failed to initialize; the method was called before joining a channel; or was called before leaving the channel; the audio module is disabled; the program is incomplete. ERR_NOT_SUPPORTED - (4): does not support the request. Possible reasons include incorrect built-in encryption mode setting or SDK failed to load external encryption library. Please check the encryption mode setting or reload the external encryption library. + (4): does not support the request. Possible causes include: incorrect built-in encryption mode setting, or SDK failed to load the external encryption library. Please check the encryption mode setting or reload the external encryption library. ERR_REFUSED - (5): Request is refused. Possible reasons include: initialization failed; channel name is empty when joining; channel name already used when calling to join multiple channels. + (5): Request was refused. Possible causes include: failed to initialize; the channel name is empty when joining a channel; the channel name is already in use when calling to join multiple channels. ERR_BUFFER_TOO_SMALL - (6): Buffer size is too small to store returned data. + (6): Buffer size is insufficient to store the returned data. ERR_NOT_INITIALIZED - (7): Method is called before is initialized. Please ensure the object is initialized before calling the method. + (7): Method called before initialization. Please ensure the object is initialized before calling this method. ERR_INVALID_STATE @@ -49,31 +49,31 @@ ERR_TIMEDOUT - (10): Request timed out. Some API calls require the SDK to return execution results. If no result is returned within 10 seconds, this error is triggered. + (10): Request timed out. Some API calls require the SDK to return the execution result. If no result is returned within 10 seconds, this error is triggered. ERR_CANCELED - (11): Request is canceled. This error is for internal use only and is not returned to the application via any method or callback. + (11): Request was canceled. This error is for internal use only and is not returned to the app via any method or callback. ERR_TOO_OFTEN - (12): Method is called too frequently. This error is for internal use only and is not returned to the application via any method or callback. + (12): Method called too frequently. This error is for internal use only and is not returned to the app via any method or callback. ERR_BIND_SOCKET - (13): SDK failed to bind network socket. This error is for internal use only and is not returned to the application via any method or callback. + (13): SDK failed to bind network socket. This error is for internal use only and is not returned to the app via any method or callback. ERR_NET_DOWN - (14): Network is unavailable. This error is for internal use only and is not returned to the application via any method or callback. + (14): Network is unavailable. This error is for internal use only and is not returned to the app via any method or callback. ERR_JOIN_CHANNEL_REJECTED - (17): Join channel request is rejected. Possible reasons include: user is already in the channel; is called without calling before joining the channel. + (17): Join channel request was rejected. Possible causes include: the user is already in a channel; was called but was not called before attempting to join a channel. ERR_LEAVE_CHANNEL_REJECTED - (18): Leave channel failed. Possible reasons include: user already left the channel before calling leaveChannel; leaveChannel is called before joining the channel. + (18): Failed to leave the channel. Possible causes include: the user already left the channel before calling leaveChannel; leaveChannel was called before joining a channel. ERR_ALREADY_IN_USE @@ -81,7 +81,7 @@ ERR_ABORTED - (20): Request is aborted by the SDK, possibly due to too frequent requests. + (20): Request was aborted by the SDK, possibly due to sending requests too frequently. ERR_INIT_NET_ENGINE @@ -93,11 +93,11 @@ ERR_INVALID_CHANNEL_NAME - (102): The specified channel name is invalid. Possible reason is incorrect parameter type. Please use a valid channel name to rejoin the channel. + (102): The specified channel name is invalid. Possible cause: incorrect parameter type. Please use a valid channel name to rejoin the channel. ERR_NO_SERVER_RESOURCES - (103): Failed to obtain server resources in the specified region. Try using another region when initializing . + (103): Unable to obtain server resources in the specified region. Please try using another region when initializing . ERR_TOKEN_EXPIRED @@ -105,36 +105,36 @@ ERR_INVALID_TOKEN - (110): Invalid Token. Common reasons include: + (110): Invalid Token. Common causes include:
                  -
                • App certificate is enabled in the Agora console, but App ID is still used for authentication in code. When App certificate is enabled, the project must use Token for authentication.
                  • +
                • The App certificate is enabled in the Agora Console, but the code still uses the App ID for authentication. When the App certificate is enabled, the project must use Token authentication.
                • The uid used to generate the Token is inconsistent with the uid used to join the channel.
                                 ERR_CONNECTION_INTERRUPTED - (111): Network connection is interrupted. After the connection is established, if the client instance is disconnected from the server for more than 4 seconds, the SDK triggers this callback. + (111): Network connection interrupted. After the connection is established, if the client instance is disconnected from the server for more than 4 seconds, the SDK triggers this callback. ERR_CONNECTION_LOST - (112): Network connection is lost. After disconnection, if the client instance fails to reconnect to the Agora edge server within 10 seconds, this error is triggered. + (112): Network connection lost. After the connection is interrupted, if the client instance fails to reconnect to the Agora edge server within 10 seconds, this error is triggered. ERR_NOT_IN_CHANNEL - (113): User is not in the channel when calling the method. + (113): The user is not in a channel when calling the method. ERR_SIZE_TOO_LARGE - (114): Data size exceeds 1 KB when calling the method. + (114): The data size exceeds 1 KB when calling the method. ERR_BITRATE_LIMIT - (115): Data bitrate exceeds 6 KB/s when calling the method. + (115): The data bitrate exceeds 6 KB/s when calling the method. ERR_TOO_MANY_DATA_STREAMS - (116): More than five data streams are created when calling the createDataStream(int* streamId, const DataStreamConfig& config) method. + (116): More than five data streams were created when calling the createDataStream(int* streamId, const DataStreamConfig& config) method. ERR_STREAM_MESSAGE_TIMEOUT @@ -142,11 +142,11 @@ ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED - (119): Failed to switch role. Please try rejoining the channel. + (119): Failed to switch roles. Please try rejoining the channel. ERR_DECRYPTION_FAILED - (120): Media stream decryption failed. The user may have joined the channel with an incorrect password. Please check the entered password or advise the user to rejoin the channel. + (120): Failed to decrypt media stream. The user may have joined the channel using an incorrect password. Please check the input password or advise the user to rejoin the channel. ERR_INVALID_USER_ID @@ -154,11 +154,11 @@ ERR_DATASTREAM_DECRYPTION_FAILED - (122): Data stream decryption failed. The user may have joined the channel with an incorrect password. Please check the entered password or advise the user to rejoin the channel. + (122): Failed to decrypt data stream. The user may have joined the channel using an incorrect password. Please check the input password or advise the user to rejoin the channel. ERR_CLIENT_IS_BANNED_BY_SERVER - (123): User is banned by the server. + (123): The user is banned by the server. ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH @@ -170,11 +170,11 @@ ERR_ADM_GENERAL_ERROR - (1005): A general error occurred (no specific reason). Please check whether the audio device is occupied by another app or try rejoining the channel. + (1005): General error occurred (no specific reason). Please check if the audio device is occupied by another app or try rejoining the channel. ERR_ADM_INIT_PLAYOUT - (1008): Error occurred while initializing playback device. Please check whether the playback device is occupied by another app or try rejoining the channel. + (1008): Error occurred while initializing playback device. Please check if the playback device is occupied by another app or try rejoining the channel. ERR_ADM_START_PLAYOUT @@ -198,7 +198,15 @@ ERR_VDM_CAMERA_NOT_AUTHORIZED - (1501): Camera access permission is not granted. Please check whether camera permission is granted. + (1501): Camera access permission not granted. Please check if camera permission has been granted. + + + ERR_PCMSEND_FORMAT + (200): Unsupported PCM format. + + + ERR_PCMSEND_BUFFEROVERFLOW + (201): Buffer overflow due to excessive PCM send rate.
                diff --git a/en-US/dita/RTC-AIDOC/API/enum_localvideoeventtype.dita b/en-US/dita/RTC-AIDOC/API/enum_localvideoeventtype.dita new file mode 100644 index 00000000000..7fb75e3b01a --- /dev/null +++ b/en-US/dita/RTC-AIDOC/API/enum_localvideoeventtype.dita @@ -0,0 +1,37 @@ + + + + <ph keyref="LOCAL_VIDEO_EVENT_TYPE"/> + Local video event types. + +
                +
                + +
                Since
                +
                Available since v4.6.1.
                +                 +
                +
                +
                + Enumerations + + + LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_HIDDEN + (1): Screen capture window is hidden (Android only). + + + LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN + (2): Screen capture window recovers from hidden state (Android only). + + + LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_STOPPED_BY_USER + (3): Screen capture is stopped by the user (Android only). + + + LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_SYSTEM_INTERNAL_ERROR + (4): A system internal error occurs during screen capture (Android only). + + +
                +                 +                 \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/API/enum_localvideostreamreason.dita b/en-US/dita/RTC-AIDOC/API/enum_localvideostreamreason.dita index f62901e770c..5693eef9177 100644 --- a/en-US/dita/RTC-AIDOC/API/enum_localvideostreamreason.dita +++ b/en-US/dita/RTC-AIDOC/API/enum_localvideostreamreason.dita @@ -2,14 +2,14 @@ <ph keyref="LOCAL_VIDEO_STREAM_REASON"/> - The reason for local video state change. + Reason for local video state changes.
                Enumerations LOCAL_VIDEO_STREAM_REASON_OK - (0): Local video is working properly. + (0): Local video is functioning normally. LOCAL_VIDEO_STREAM_REASON_FAILURE @@ -21,11 +21,11 @@ LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY - (3): The local video capture device is occupied. Prompt the user to check whether the camera is being used by another app or try rejoining the channel. + (3): The local video capture device is occupied. Prompt the user to check whether the camera is being used by another application or try rejoining the channel. LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE - (4): Failed to capture local video. Prompt the user to check whether the video capture device is functioning properly, whether the camera is occupied by another app, or try rejoining the channel. + (4): Failed to capture local video. Prompt the user to check whether the video capture device is working properly, whether the camera is being used by another application, or try rejoining the channel. LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT @@ -33,11 +33,11 @@ LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND - (6): (iOS only) The app is in the background. Prompt the user that video cannot be captured while the app is in the background. + (6): (iOS only) The app is in the background. Prompt the user that video cannot be captured properly while the app is in the background. LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS - (7): (iOS only) The app window is in Slide Over, Split View, or Picture-in-Picture mode, and the camera is occupied by another app. Prompt the user that in these modes, if the camera is occupied by another app, video cannot be captured properly. + (7): (iOS only) The app window is in Slide Over, Split View, or Picture-in-Picture mode, and the camera is being used by another app. Prompt the user that in these modes, if the camera is occupied by another app, video capture may not work properly. LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND @@ -45,7 +45,7 @@ LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED - (9): (macOS and Windows only) The current video capture device was disconnected (e.g., unplugged). + (9): (macOS and Windows only) The current video capture device has been disconnected (e.g., unplugged). LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID @@ -53,15 +53,15 @@ LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT - (14): (Android only) Video capture was interrupted. Possible reasons include: the camera is occupied by another app; the app switched to the background. You can use a foreground service notification to inform the system to continue video capture even when the app is in the background. + (14): (Android only) Video capture was interrupted. Possible reasons include: the camera is occupied by another app; the app switched to the background. You can use a foreground service notification to inform the OS to continue capturing video when the app is in the background. LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR - (15): (Android only) A fatal error occurred with the video capture device. Prompt the user to turn off and restart the camera. If the issue persists, check for hardware failure. + (15): (Android only) A fatal error occurred in the video capture device. Prompt the user to turn off and restart the camera to restore functionality. If the issue persists, check for hardware failure. LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE - (101): The video capture device is unavailable due to high system pressure. + (101): The current video capture device is unavailable due to high system pressure. LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED @@ -69,19 +69,19 @@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED - (12): (macOS and Windows only) The shared window is closed, or a fullscreen window exited fullscreen mode. After exiting fullscreen, remote users will not see the shared window. To avoid showing a black screen to remote users, it is recommended to stop screen sharing immediately. Common scenarios include: local user closes the shared window; local user starts fullscreen slideshow and shares the window, then exits fullscreen; local user watches fullscreen web video or document and shares the window, then exits fullscreen. + (12): (macOS and Windows only) The shared window is closed, or a fullscreen window exited fullscreen mode. After exiting fullscreen, remote users will not see the shared window. To avoid showing a black screen to remote users, it is recommended to stop screen sharing immediately. Common scenarios include: the local user closes the shared window; the user shares a slideshow window after entering fullscreen, and exits fullscreen triggering this error; the user watches a web video or document in fullscreen and shares the window, exiting fullscreen triggers this error. LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED - (13): (Windows only) The shared window is occluded by another window, and the SDK blacks out the occluded area. + (13): (Windows only) The shared window is occluded by another window. The SDK blacks out the occluded area. LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED - (20): Local screen sharing of the window is not supported. + (20): Local screen sharing window is not supported. LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE - (21): (Windows and Android only) No data is available in the captured window. + (21): (Windows and Android only) The currently captured window has no data. LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_NO_PERMISSION @@ -89,13 +89,13 @@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_AUTO_FALLBACK - (24): (Windows only) An error occurred during screen sharing (possibly due to failure to occlude windows), causing performance degradation, but the screen sharing itself is not affected. - During screen sharing, if window occlusion fails due to driver issues, the SDK reports this event and automatically falls back to sharing the entire screen. If your use case requires occluding specific windows for privacy, we recommend listening for this event and implementing additional privacy protection mechanisms when triggered. + (24): (Windows only) An exception occurred during screen sharing (possibly due to failure in occluding a window), leading to performance degradation, but the screen sharing process itself is not affected. + During screen sharing, if occluding a specific window fails due to device driver issues, the SDK reports this event and automatically falls back to sharing the entire screen. If your use case requires occluding specific windows for privacy, it is recommended to listen for this event and implement additional privacy protection mechanisms when triggered. LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN - (25): (Windows only) The shared window is hidden and not visible on the current screen. + (25): (Windows only) The currently shared window is hidden and not visible on the screen. LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN @@ -107,7 +107,7 @@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_PAUSED - (28): (Windows only) Screen sharing is paused. Common scenarios include switching to a secure desktop such as UAC dialog or Winlogon desktop. + (28): (Windows only) Screen sharing is paused. Common scenarios include switching to a secure desktop, such as a UAC dialog or Winlogon desktop. LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_RESUMED @@ -131,7 +131,7 @@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_EXCLUDE_WINDOW_FAILED - (34): (Windows only) Failed to exclude some windows in the exclude list during screen sharing. + (34): (Windows only) Failed to exclude some windows in the exclusion list during screen sharing.
                diff --git a/en-US/dita/RTC-AIDOC/API/rtc_api_data_type.dita b/en-US/dita/RTC-AIDOC/API/rtc_api_data_type.dita index b5eb576d30e..f3562085991 100644 --- a/en-US/dita/RTC-AIDOC/API/rtc_api_data_type.dita +++ b/en-US/dita/RTC-AIDOC/API/rtc_api_data_type.dita @@ -357,6 +357,7 @@
                • +
                • diff --git a/en-US/dita/RTC-AIDOC/API/rtc_api_overview.dita b/en-US/dita/RTC-AIDOC/API/rtc_api_overview.dita index b35363e6ce4..779baf16754 100644 --- a/en-US/dita/RTC-AIDOC/API/rtc_api_overview.dita +++ b/en-US/dita/RTC-AIDOC/API/rtc_api_overview.dita @@ -980,6 +980,10 @@ + + + + @@ -1562,7 +1566,7 @@ -
                +
                Encoded Video Data @@ -1577,7 +1581,7 @@ - + @@ -2003,13 +2007,17 @@
                -
                +
                Media Player Information API Description + + + + @@ -3196,6 +3204,10 @@ + + + + diff --git a/en-US/dita/RTC-AIDOC/API/rtc_api_sunset.dita b/en-US/dita/RTC-AIDOC/API/rtc_api_sunset.dita new file mode 100644 index 00000000000..18555cae702 --- /dev/null +++ b/en-US/dita/RTC-AIDOC/API/rtc_api_sunset.dita @@ -0,0 +1,870 @@ + + + + API Sunset Notice + This page introduces the deprecated and deleted APIs in the SDK. + +
                + 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.

                + +
                + + + + + + + + + + + API + Description + Alternative API + Deprecated version + + + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + - + v4.6.0 + + + + + - + v4.6.0 + + + + + - + v4.6.0 + + + + + Use instead. + v4.6.0 + + + + + + v4.4.0 + + + + + + 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 + + + +
                +
                +
                + + + + + + + + + + + API + Description + Alternative API + Deprecated version + + + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use Media Push instead. + v4.6.0 + + + + + Use instead. + v4.6.0 + + + + + + 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 +

                The APIs have been deleted from the SDK. Use the recommended alternative APIs to implement the related functionality.

                +
                + + + + + + + + + API + Description + Alternative API + Deleted version + + + + + setLocalPublishFallbackOption + Sets the fallback option for the published video stream based on the network conditions. + - + v4.6.0 + + + onLocalPublishFallbackToAudioOnlydidLocalPublishFallbackToAudioOnly + Occurs when the published media stream falls back to an audio-only stream. + - + v4.6.0 + + + onDownlinkNetworkInfoUpdateddownlinkNetworkInfoUpdate + Occurs when the downlink network information changes. + - + v4.6.0 + + + receivedFrameRate is deleted in AgoraRtcRemoteVideoStats + The frame rate (Kbps) received since the last count. + - + v4.6.0 + + + enableWirelessAccelerate + Enables or disable Wi-Fi acceleration. + - + v4.6.0 + + + onWlAccStats + Report on Wi-Fi acceleration effect. + - + v4.6.0 + + + onWlAccMessagewlAccMessage + Report on Wi-Fi acceleration effect. + - + v4.6.0 + + + WLACC_MESSAGE_REASONAgoraWlAccReason + Wi-Fi acceleration message. + - + v4.6.0 + + + WLACC_SUGGEST_ACTIONAgoraWlAccAction + Wi-Fi acceleration recommended operation. + - + v4.6.0 + + + WlAccStatsAgoraWlAccStats + Wi-Fi acceleration statistics. + - + v4.6.0 + + + + setVideoProfilesetVideoProfile:profile:swapWidthAndHeight: + Sets the video encoder configuration. + + v4.4.0 + + + setRemoteRenderMode(userId, renderMode)setRemoteRenderMode:uid:mode: + Sets the video display mode of a specified remote user. + + v4.4.0 + + + CreateRendererView + Creates a RendererView. + The Android native method . + v4.4.0 + + + CreateTextureView + + Creates a TextureView. + The Android native method . + v4.4.0 + + + openWithCustomSourceopenWithCustomSourceAtStartPos + Opens the custom media resource file. + + v4.4.0 + + + setVideoQualityParameters + + Sets the preferences for high-quality video. (LIVE_BROADCASTING only). + Use the degradationPreference parameter in + v4.4.0 + + + startEchoTest()startEchoTest + Starts an audio call test. + + v4.4.0 + + + startEchoTest(intervalInSeconds)startEchoTestWithInterval + Starts an audio call test. + + v4.4.0 + + + setEncryptionMode + Sets the built-in encryption mode. + + v4.4.0 + + + setEncryptionSecret + Enables built-in encryption with an encryption password before users join a channel. + + v4.4.0 + + + onExtensionEventonEvent + The event callback of the extension. + + v4.4.0 + + + onExtensionStartedonStarted + Occurs when the extension is enabled. + + v4.4.0 + + + onExtensionStoppedonStopped + Occurs when the extension is disabled. + + v4.4.0 + + + onExtensionErroronError + Occurs when the extension runs incorrectly. + + v4.4.0 + + + +
                +
                +
                + +                 \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/API/rtc_lite_api.dita b/en-US/dita/RTC-AIDOC/API/rtc_lite_api.dita new file mode 100644 index 00000000000..3f80c8c4232 --- /dev/null +++ b/en-US/dita/RTC-AIDOC/API/rtc_lite_api.dita @@ -0,0 +1,588 @@ + + + +Lite SDK API List +This page lists the APIs supported by Lite SDK. + +
                If you cannot find the API you are looking for on this page, it means the Lite SDK does not support this API, and calling it returns error code -2.
                +
                + <apiname keyref="IRtcEngine"/> +
                  +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                • In , the following screen capture-related parameter settings are invalid:
                    +
                  • publishScreenCaptureVideo
                    • +
                  • publishScreenCaptureAudio
                    • +
                  • +
                  • +
                • In , the following screen capture-related parameter settings are invalid:
                    +
                  • publishScreenCaptureVideo
                    • +
                  • publishScreenCaptureAudio
                    • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                • In , the encodingType parameter in config only supports the OPUS format for audio encoding.
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                • In , the following screen capture-related parameter settings are invalid:
                    +
                  • publishScreenCaptureVideo
                    • +
                  • publishScreenCaptureAudio
                    • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                +
                +
                + <apiname keyref="IRtcEngineEx"/> +
                  +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                • In , the following screen capture-related parameter settings are invalid:
                    +
                  • publishScreenCaptureVideo
                    • +
                  • publishScreenCaptureAudio
                    • +
                  • +
                  • +
                  • +
                  • +
                +
                +
                + <apiname keyref="IRtcEngineEventHandler"/> +
                  +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                +
                +
                + <apiname keyref="IMediaExtensionObserver"/> +
                  +
                  • +
                  • +
                  • +
                  • +
                +
                +
                + <apiname keyref="IMediaPlayer"/> + The APIs in this group only support processing audio media files and di not support processing video media files. +
                  +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                +
                +
                + <apiname keyref="IVideoEncodedFrameObserver"/> +
                  +
                  • +
                +
                +
                + <apiname keyref="IVideoFrameObserver"/> + In the video data returned by the , , and callbacks, the alphabuffer is . +
                  +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                +
                +
                + <apiname keyref="IMediaExtensionObserver"/> +
                  +
                  • +
                  • +
                  • +
                  • +
                +
                +
                + <apiname keyref="IMusicPlayer"/> +
                  +
                  • +
                  • +
                  • +
                  • +
                  • +
                  • +
                +
                +                 +                 \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/RTC_NG_API_Android.ditamap b/en-US/dita/RTC-AIDOC/RTC_NG_API_Android.ditamap index 3237ff81325..1e4e1c9dc1a 100644 --- a/en-US/dita/RTC-AIDOC/RTC_NG_API_Android.ditamap +++ b/en-US/dita/RTC-AIDOC/RTC_NG_API_Android.ditamap @@ -289,6 +289,7 @@ + @@ -611,6 +612,7 @@ + @@ -853,6 +855,7 @@ + diff --git a/en-US/dita/RTC-AIDOC/RTC_NG_API_CPP.ditamap b/en-US/dita/RTC-AIDOC/RTC_NG_API_CPP.ditamap index a7f2bba282b..21757622936 100644 --- a/en-US/dita/RTC-AIDOC/RTC_NG_API_CPP.ditamap +++ b/en-US/dita/RTC-AIDOC/RTC_NG_API_CPP.ditamap @@ -287,6 +287,7 @@ + @@ -594,6 +595,7 @@ + @@ -892,6 +894,7 @@ + diff --git a/en-US/dita/RTC-AIDOC/RTC_NG_API_iOS.ditamap b/en-US/dita/RTC-AIDOC/RTC_NG_API_iOS.ditamap new file mode 100644 index 00000000000..c1707b89d02 --- /dev/null +++ b/en-US/dita/RTC-AIDOC/RTC_NG_API_iOS.ditamap @@ -0,0 +1,35 @@ + + + + iOS API Reference + + {platform2} API Reference + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/RTC_NG_API_macOS.ditamap b/en-US/dita/RTC-AIDOC/RTC_NG_API_macOS.ditamap new file mode 100644 index 00000000000..d9c2eea5c0f --- /dev/null +++ b/en-US/dita/RTC-AIDOC/RTC_NG_API_macOS.ditamap @@ -0,0 +1,28 @@ + + + + macOS API Reference + + {platform2} API Reference + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/config/filter-product.ditaval b/en-US/dita/RTC-AIDOC/config/filter-product.ditaval index d7cccb89653..35be9c1128c 100644 --- a/en-US/dita/RTC-AIDOC/config/filter-product.ditaval +++ b/en-US/dita/RTC-AIDOC/config/filter-product.ditaval @@ -1,4 +1,4 @@ - - + + diff --git a/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-cpp.ditamap b/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-cpp.ditamap index 33abfbdbb93..c2c9c073450 100644 --- a/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-cpp.ditamap +++ b/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-cpp.ditamap @@ -1381,6 +1381,13 @@ + + + + getAudioBufferDelay + + + @@ -4827,6 +4834,13 @@ + + + + onLocalVideoEvent + + + @@ -4932,6 +4946,13 @@ + + + + onPermissionGranted + + + @@ -6644,6 +6665,13 @@ + + + + LOCAL_VIDEO_EVENT_TYPE + + + diff --git a/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-ios.ditamap b/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-ios.ditamap new file mode 100644 index 00000000000..d425de30ec3 --- /dev/null +++ b/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-ios.ditamap @@ -0,0 +1,201 @@ + + + + Keys RTC NG Objective-C API + + + + iOS + + + + + + + Objective-C + + + + + + + Agora iOS API Reference + + + + + + + Full SDK API 列表 + Full SDK API List + + + + + + + 参数 + Parameters + + + + + + + 返回值 + Returns + + + + + + + Class 及 Enum + Class and Enum + + + + + + + Class + + + + + + + Enum + + + + + + + + + + getAudioBufferDelay + + + + + + + + + onEncodedVideoFrameReceived:length:info:channelId:uid: + + + + + + + + + + + /var/mobile/Containers/Data/audio.mp4 + + + + + + + /var/mobile/Containers/Data/audio.aac + + + + + + + /AppSandbox/Library/Caches/example.jpg + + + + + + + AgoraVideoBitrateStandard + + + + + + + AgoraVideoBitrateCompatible + + + + + + + YES + + + + + + + NO + + + + + + + nil + + + + + + + AgoraClearVisionExtension.xcframework + + + + + + + AgoraSuperResolutionExtension.xcframework + + + + + + + AgoraAiNoiseSuppressionExtension.xcframework + + + + + + + AgoraAudioBeautyExtension.xcframework + + + + + + + AgoraSpatialAudioExtension.xcframework + + + + + + + AgoraContentInspectExtension.xcframework + + + + + + + AgoraVideoSegmentationExtension.xcframework + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-java.ditamap b/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-java.ditamap index 9b89d651775..3d913d6b6aa 100644 --- a/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-java.ditamap +++ b/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-java.ditamap @@ -1324,6 +1324,13 @@ + + + + getAudioBufferDelay + + + @@ -4728,6 +4735,13 @@ + + + + onLocalVideoEvent + + + @@ -4833,6 +4847,13 @@ + + + + onPermissionGranted + + + diff --git a/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-macos.ditamap b/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-macos.ditamap new file mode 100644 index 00000000000..c1095274583 --- /dev/null +++ b/en-US/dita/RTC-AIDOC/config/keys-rtc-ng-api-macos.ditamap @@ -0,0 +1,179 @@ + + + + Keys RTC NG Objective-C API + + + + macOS + + + + + + + Objective-C + + + + + + + Agora macOS API Reference + + + + + + + API 列表 + API List + + + + + + + 参数 + Parameters + + + + + + + 返回值 + Returns + + + + + + + + + + + onEncodedVideoFrameReceived:length:info:channelId:uid: + + + + + + + + + + + /var/mobile/Containers/Data/audio.mp4 + + + + + + + /var/mobile/Containers/Data/audio.aac + + + + + + + ～/Library/Logs/example.jpg + + + + + + + AgoraVideoBitrateStandard + + + + + + + AgoraVideoBitrateCompatible + + + + + + + YES + + + + + + + NO + + + + + + + nil + + + + + + + AgoraClearVisionExtension.framework + + + + + + + AgoraAudioBeautyExtension.framework + + + + + + + AgoraSpatialAudioExtension.framework + + + + + + + AgoraAiNoiseSuppressionExtension.xcframework + + + + + + + AgoraContentInspectExtension.framework + + + + + + + AgoraVideoSegmentationExtension.framework + + + + + + + Class 及 Enum + Class and Enum + + + + + + + Class + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-cpp.ditamap b/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-cpp.ditamap index 0994a26bafe..1ca0f37434d 100644 --- a/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-cpp.ditamap +++ b/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-cpp.ditamap @@ -204,6 +204,7 @@ + @@ -714,6 +715,7 @@ + @@ -721,6 +723,7 @@ + diff --git a/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-ios.ditamap b/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-ios.ditamap new file mode 100644 index 00000000000..045c5d40bf4 --- /dev/null +++ b/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-ios.ditamap @@ -0,0 +1,27 @@ + + + + iOS API Relations + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-java.ditamap b/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-java.ditamap index 8caa8bd829e..1108fb2a09e 100644 --- a/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-java.ditamap +++ b/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-java.ditamap @@ -149,6 +149,7 @@ + @@ -686,6 +687,7 @@ + @@ -693,6 +695,7 @@ + diff --git a/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-macos.ditamap b/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-macos.ditamap new file mode 100644 index 00000000000..2dfbe44d35c --- /dev/null +++ b/en-US/dita/RTC-AIDOC/config/relations-rtc-ng-api-macos.ditamap @@ -0,0 +1,19 @@ + + + + macOS API Relations + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_destroymusicplayer.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_destroymusicplayer.dita new file mode 100644 index 00000000000..da6b604efc1 --- /dev/null +++ b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_destroymusicplayer.dita @@ -0,0 +1,61 @@ + + + + <ph keyref="destroyMusicPlayer"/> + 销毁音乐播放器对象。 + + + + + + + + +
                +

                + public abstract int destroyMusicPlayer(IAgoraMusicPlayer player); + - (NSInteger)destroyMusicPlayer:(id<AgoraMusicPlayerProtocol>)musicPlayer; + virtual int destroyMusicPlayer(agora_refptr<IMusicPlayer> music_player) = 0; + + abstract destroyMusicPlayer(musicPlayer: IMusicPlayer): number; + public abstract int DestroyMusicPlayer(IMusicPlayer music_player); + abstract destroyMusicPlayer(musicPlayer: IMusicPlayer): number; + Future<void> destroyMusicPlayer(MusicPlayer musicPlayer);

                +
                +
                +
                + +
                自从
                +
                v4.4.0
                +                 +
                +

                当你不再需要使用音乐播放器时，你可以调用该方法来销毁音乐播放器对象。销毁之后如果需要重新使用音乐播放器，需要调用 重新创建一个音乐播放器对象。

                +
                +
                + 调用时机 +

                该方法在加入频道前后均可调用，但请确保在 的 方法前调用。

                +
                +
                + 调用限制 +

                无。

                +
                +
                + 参数 + + + player + musicPlayer + music_player + 对象。 + 指向 对象的指针。 + +
                +
                + <ph keyref="return-section-title"/> +

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

                +
                  +
                • 0: 方法调用成功。
                  • +
                • < 0: 方法调用失败。详见了解详情和解决建议。
                  • +
                +                 +                 diff --git a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita new file mode 100644 index 00000000000..eccbf636d0d --- /dev/null +++ b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getinternalsongcode.dita @@ -0,0 +1,91 @@ + + + + <ph keyref="getInternalSongCode"/> + 创建音乐资源的副歌片段编号。 + + + + + + + + +
                +

                + public abstract long getInternalSongCode(long songCode, String jsonOption); + + - (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; + public abstract int GetInternalSongCode(Int64 songCode, string jsonOption, ref Int64 internalSongCode); + abstract getInternalSongCode(songCode: number, jsonOption: string): number; + Future<int> getInternalSongCode( + {required int songCode, required String jsonOption});

                +
                +
                + 详情 +
                + +
                自从
                +
                v4.2.2
                +                 +
                +
                +
                + 适用场景 +

                当你需要播放某一音乐资源的副歌片段前，你需要调用此方法，通过 jsonOption 参数和该音乐资源的 songCode 来为该音乐资源的副歌片段创建一个编号，作为该资源的唯一标识。当你获取到该片段的编号后，在你调用相应方法打开、预加载、移除该资源时，将该内部歌曲编号传入 songCode 参数。

                +
                +
                + 参数 + + + songCode + 音乐资源编号，用于标识音乐资源。你可以通过调用 或 方法来获取音乐资源，并通过由此触发的 回调获取音乐资源的编号（songCode）。 + + + jsonOption + 扩展 JSON 字段，默认为 。目前支持传入下列值： + + + Key 值 + Value 值 + 示例 + + + sceneType + 场景类型： +
                  +
                • 1：直播场景：K 歌及背景音乐播放。
                  • +
                • 2：直播场景：背景音乐播放。
                  • +
                • 3：（默认）语聊场景：K 歌。
                  • +
                • 4：语聊场景：背景音乐播放。
                  • +
                • 5：VR 场景：K 歌及背景音乐播放。
                  • +
                声网会根据你在 sceneType 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 sceneType 的值。                 + {"sceneType":1} +                 + + highPart + 副歌片段的索引。你可以从 回调中获取副歌片段的索引然后传值。索引序号从 0 开始。 + + {"format": {"highpart": 0}} + +                 +                 + + internalSongCode + 输出参数，音乐资源的内部歌曲编号。 + +
                +
                + <ph keyref="return-section-title"/> +
                  +
                • 0: 方法调用成功。
                  • +
                • < 0: 方法调用失败。详见了解详情和解决建议。
                  • +
                +
                  +
                • 方法调用成功，返回创建的音乐资源内部编号。
                  • +
                • < 0: 方法调用失败。详见了解详情和解决建议。
                  • +
                +                 +                 diff --git a/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getsongsimpleinfo.dita b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getsongsimpleinfo.dita new file mode 100644 index 00000000000..ea8a897072a --- /dev/null +++ b/en-US/dita/RTC-NG/API/api_imusiccontentcenter_getsongsimpleinfo.dita @@ -0,0 +1,50 @@ + + + + <ph keyref="getSongSimpleInfo"/> + 获取某一音乐资源的详细信息。 + + + + + + + + +
                +

                + public abstract String getSongSimpleInfo(long songCode); + + - (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; + public abstract int GetSongSimpleInfo(ref string requestId, Int64 songCode); + abstract getSongSimpleInfo(songCode: number): string; + Future<String> getSongSimpleInfo(int songCode);

                +
                +
                + 详情 +
                + +
                自从
                +
                v4.2.2
                +                 +
                +

                在调用该方法前，你需要先获取到对应的音乐资源的编号。你可以通过调用 或 方法来获取音乐资源，并通过由此触发的 回调获取音乐资源的编号（songCode）。

                +

                当你调用该方法后，SDK 会触发 回调报告音乐资源的详细信息。

                +
                +
                + 参数 + + + + + + + + + +
                +
                +                 +                 diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createmediarecorder.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createmediarecorder.dita index 61bbee987d5..18540cedf41 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createmediarecorder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createmediarecorder.dita @@ -32,7 +32,7 @@
                v4.2.0
                -

                Before you start recording, you need to call this method to create a recording object. Agora SDKs support recording the audio and video streams of both local and remote users. You can call this method as needed to create muitiple recording objects and specify the streams that you want to record through the info parameter.

                +

                Before you start recording, you need to call this method to create a recording object. Agora SDKs support recording the audio and video streams of both local and remote users. You can call this method as needed to create multiple recording objects and specify the streams that you want to record through the info parameter.

                After successfully creating a recording object, you need to call to register a recording observer to listen for recording callbacks, and then call to start recording.

                diff --git a/en-US/dita/RTC-NG/API/class_rtcimage.dita b/en-US/dita/RTC-NG/API/class_rtcimage.dita index f23ec8c6df1..cc52eb3732e 100644 --- a/en-US/dita/RTC-NG/API/class_rtcimage.dita +++ b/en-US/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 The HTTP/HTTPS URL address of the image in the live video. The maximum length of this parameter is 1024 bytes. - + x The x-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin). - + y The y-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin). - + width The width (px) of the image on the video frame. - + height The height (px) of the image on the video frame. @@ -262,4 +262,4 @@ struct FRtcImage
                - + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_userinfo.dita b/en-US/dita/RTC-NG/API/class_userinfo.dita index 8832473dbe0..193790e32f0 100644 --- a/en-US/dita/RTC-NG/API/class_userinfo.dita +++ b/en-US/dita/RTC-NG/API/class_userinfo.dita @@ -32,7 +32,7 @@ char userAccount[MAX_USER_ACCOUNT_LENGTH]; UserInfo() : uid(0) { - userAccount[0] = '\0'; + userAccount[0] = ''; } }; USTRUCT(BlueprintType) diff --git a/en-US/dita/RTC-NG/API/enum_recorderstreamtype.dita b/en-US/dita/RTC-NG/API/enum_recorderstreamtype.dita new file mode 100644 index 00000000000..b8ab625b22b --- /dev/null +++ b/en-US/dita/RTC-NG/API/enum_recorderstreamtype.dita @@ -0,0 +1,20 @@ + + + + <ph keyref="RecorderStreamType"/> + 需录制的视频流类型。 + +
                + 枚举值 + + + + 0: （默认）频道内的视频流。 + + + + 1: 加入频道前，在本地预览的视频流。 + +
                +                 +                 diff --git a/en-US/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita b/en-US/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita new file mode 100644 index 00000000000..9f7c342840b --- /dev/null +++ b/en-US/dita/RTC-NG/API/enum_rteabrfallbacklayer.dita @@ -0,0 +1,54 @@ + + + + <ph keyref="RteAbrSubscriptionLayer"/> + Quality levels for subscribing to video streams. + +
                +
                + +
                Since
                +
                v4.5.0
                +                 +
                + To customize and subscribe to video resolution levels from to , you must enable the ABR feature. +
                +
                + Enumerations + + + + 0: The highest quality video stream with the highest resolution. + + + + 1: (Default) The lowest quality video stream with the lowest resolution. + + + + 2: Video quality level 1. The resolution is only slightly lower than . + + + + 3: Video quality level 2. The resolution is slightly lower than . + + + + 4: Video quality level 3. The resolution is slightly lower than . + + + + 5: Video quality level 4. The resolution is slightly lower than . + + + + 6: Video quality level 5. The resolution is slightly lower than . + + + + 7: Video quality level 6. The resolution is slightly lower than . + + +
                +                 +                 diff --git a/en-US/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita b/en-US/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita new file mode 100644 index 00000000000..9f7c342840b --- /dev/null +++ b/en-US/dita/RTC-NG/API/enum_rteabrsubscriptionlayer.dita @@ -0,0 +1,54 @@ + + + + <ph keyref="RteAbrSubscriptionLayer"/> + Quality levels for subscribing to video streams. + +
                +
                + +
                Since
                +
                v4.5.0
                +                 +
                + To customize and subscribe to video resolution levels from to , you must enable the ABR feature. +
                +
                + Enumerations + + + + 0: The highest quality video stream with the highest resolution. + + + + 1: (Default) The lowest quality video stream with the lowest resolution. + + + + 2: Video quality level 1. The resolution is only slightly lower than . + + + + 3: Video quality level 2. The resolution is slightly lower than . + + + + 4: Video quality level 3. The resolution is slightly lower than . + + + + 5: Video quality level 4. The resolution is slightly lower than . + + + + 6: Video quality level 5. The resolution is slightly lower than . + + + + 7: Video quality level 6. The resolution is slightly lower than . + + +
                +                 +                 diff --git a/en-US/dita/RTC-NG/API/enum_rteerrorcode.dita b/en-US/dita/RTC-NG/API/enum_rteerrorcode.dita new file mode 100644 index 00000000000..faad457936b --- /dev/null +++ b/en-US/dita/RTC-NG/API/enum_rteerrorcode.dita @@ -0,0 +1,49 @@ + + + + <ph keyref="RteErrorCode"/> + RTE related status codes and error codes. + +
                +
                + +
                Since
                +
                v4.5.0
                +                 +
                +
                +
                + Enum Values + + + + 0: Operation succeeded. + + + + 1: General error (not classified under specific error reasons). + + + + 2: Invalid argument set in the method. For example, illegal characters in parameters, or a null object passed. Please reset the parameters. + + + + 3: Operation not supported in the current state, such as the object being destroyed or invalid. + + + + 4: Network error. Please check your connection. + + + + 5: Token authentication failed. Possible reasons include an invalid or expired token. Please check your token. + + + + 6: Media stream not found. For example, after joining a channel, no stream is received from the host for over 10 seconds. + + +
                +                 +                 diff --git a/en-US/dita/RTC-NG/API/rtc_lite_api.dita b/en-US/dita/RTC-NG/API/rtc_lite_api.dita index 75c0d65346c..e2ddf8a336e 100644 --- a/en-US/dita/RTC-NG/API/rtc_lite_api.dita +++ b/en-US/dita/RTC-NG/API/rtc_lite_api.dita @@ -27,7 +27,7 @@
                • -
                • +
                • @@ -573,7 +573,7 @@
              -
              +
              <apiname keyref="IMusicPlayer"/>
                • diff --git a/en-US/dita/RTC-NG/RTC_NG_API_Android.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_Android.ditamap index 8fea72410dd..574528e2086 100644 --- a/en-US/dita/RTC-NG/RTC_NG_API_Android.ditamap +++ b/en-US/dita/RTC-NG/RTC_NG_API_Android.ditamap @@ -18,7 +18,8 @@ for - + + @@ -31,18 +32,28 @@ + + + + + + + - - - - + + + + + + + diff --git a/en-US/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap new file mode 100644 index 00000000000..435061e14c6 --- /dev/null +++ b/en-US/dita/RTC-NG/RTC_NG_API_Blueprint.ditamap @@ -0,0 +1,758 @@ + + + + <keyword keyref="sdk-name"/> v<keyword keyref="sdk-version"/> for <keyword keyref="platform"/> + + v for + + + + + + + + + + + + + for + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/en-US/dita/RTC-NG/RTC_NG_API_CPP.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_CPP.ditamap index 7227c6122fb..7047dc57039 100644 --- a/en-US/dita/RTC-NG/RTC_NG_API_CPP.ditamap +++ b/en-US/dita/RTC-NG/RTC_NG_API_CPP.ditamap @@ -18,13 +18,15 @@ for - + + + @@ -36,19 +38,25 @@ + - + + + + + + @@ -67,6 +75,7 @@ + @@ -77,12 +86,16 @@ + + + + @@ -91,10 +104,13 @@ + + + @@ -116,10 +132,16 @@ + + + + + + @@ -128,32 +150,39 @@ - + + + + + + + + @@ -162,20 +191,23 @@ - - + + - - + + + + + @@ -183,8 +215,10 @@ + + @@ -196,26 +230,31 @@ + - - + + + + + + @@ -223,56 +262,56 @@ + + - - - - + + + - + + - - + - - + - + + - - - - + + - + + @@ -281,13 +320,17 @@ + + + + @@ -300,14 +343,20 @@ + + + + + + @@ -315,24 +364,26 @@ - - + + + - - + + + @@ -342,7 +393,6 @@ - @@ -353,10 +403,10 @@ - - - - + + + + @@ -374,7 +424,9 @@ + + @@ -383,10 +435,11 @@ - + + @@ -397,6 +450,7 @@ + @@ -407,7 +461,7 @@ - + @@ -415,15 +469,16 @@ - - - + + + + @@ -431,8 +486,7 @@ - - + @@ -442,7 +496,7 @@ - + @@ -451,12 +505,13 @@ + - - + + @@ -477,19 +532,21 @@ - - + + + - - + + + - - + + - + @@ -502,7 +559,9 @@ + + @@ -526,13 +585,14 @@ + + - - + @@ -558,26 +618,27 @@ - + + + - - - + + + - - + @@ -604,8 +665,6 @@ - - @@ -620,14 +679,12 @@ - + - - - - - + + + @@ -642,74 +699,169 @@ - - - - - - - - - - - - - - - - - - - - - - - - - + - - - + - - + + + + + + + + + + + + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/en-US/dita/RTC-NG/RTC_NG_API_Electron.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_Electron.ditamap index a93c7c2b13e..a0168a41ccf 100644 --- a/en-US/dita/RTC-NG/RTC_NG_API_Electron.ditamap +++ b/en-US/dita/RTC-NG/RTC_NG_API_Electron.ditamap @@ -8,9 +8,9 @@ - + - + @@ -18,13 +18,14 @@ for - + + @@ -33,13 +34,17 @@ - + + + + + @@ -48,24 +53,26 @@ + + + - + - @@ -75,23 +82,30 @@ + + + - + + + + + @@ -109,7 +123,11 @@ + + + + @@ -127,46 +145,53 @@ + + + + - - + + - - + + + + + @@ -181,6 +206,8 @@ + + @@ -195,6 +222,7 @@ + @@ -202,49 +230,51 @@ - - - - + + + + + - + + + - - + + - - - + + - - + - - + + - + + @@ -255,11 +285,15 @@ + + + + @@ -271,6 +305,7 @@ + @@ -281,23 +316,24 @@ + + + - - - + @@ -305,20 +341,19 @@ - - + - - - - + + + + @@ -335,6 +370,7 @@ + @@ -343,10 +379,12 @@ + + @@ -365,6 +403,7 @@ + @@ -373,13 +412,15 @@ - - - + + + + + @@ -389,19 +430,18 @@ - + - - + - + @@ -410,18 +450,46 @@ + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -437,13 +505,20 @@ + + + + + + + @@ -457,7 +532,6 @@ - @@ -479,6 +553,7 @@ + @@ -486,32 +561,37 @@ + - + + + - - - - - + + + + + + + @@ -531,17 +611,16 @@ - - - - - + + + + @@ -558,19 +637,22 @@ - + - - + + + + + diff --git a/en-US/dita/RTC-NG/RTC_NG_API_Flutter.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_Flutter.ditamap index 4e2127b8590..db504cdb270 100644 --- a/en-US/dita/RTC-NG/RTC_NG_API_Flutter.ditamap +++ b/en-US/dita/RTC-NG/RTC_NG_API_Flutter.ditamap @@ -8,22 +8,23 @@ - + - + for - - + + + @@ -33,6 +34,7 @@ + @@ -40,29 +42,34 @@ + + + + + - + @@ -74,17 +81,20 @@ + + + - - + + @@ -93,13 +103,16 @@ + + + - + @@ -120,8 +133,13 @@ + + - + + + + @@ -137,26 +155,32 @@ + + + + + + @@ -165,25 +189,31 @@ - - + + + - - + + + + + + + @@ -199,10 +229,12 @@ + + @@ -213,65 +245,66 @@ + - - - + + + + - + + + - - + - - + - + + - - - - + + - + + - - + @@ -279,11 +312,15 @@ + + + + @@ -303,25 +340,27 @@ + - + + + - - + @@ -331,7 +370,6 @@ - @@ -341,10 +379,10 @@ - - - - + + + + @@ -362,6 +400,7 @@ + @@ -371,6 +410,7 @@ + @@ -382,6 +422,7 @@ + @@ -393,6 +434,7 @@ + @@ -400,30 +442,31 @@ - - - + + + + - + - + - + @@ -432,12 +475,13 @@ + - - + + @@ -458,14 +502,21 @@ + + + + + + + @@ -483,13 +534,17 @@ + + + + @@ -511,23 +566,27 @@ - + + + - - + + + + @@ -546,14 +605,12 @@ - - - - - + + + @@ -574,18 +631,16 @@ - + - - + - - + @@ -601,19 +656,23 @@ - - + + + + - + + + @@ -623,9 +682,11 @@ + + diff --git a/en-US/dita/RTC-NG/RTC_NG_API_RN.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_RN.ditamap index 2ea7dc9be3e..fc52fe7482b 100644 --- a/en-US/dita/RTC-NG/RTC_NG_API_RN.ditamap +++ b/en-US/dita/RTC-NG/RTC_NG_API_RN.ditamap @@ -8,9 +8,9 @@ - + - + @@ -18,13 +18,14 @@ for - + + @@ -32,12 +33,13 @@ - - + + + @@ -46,7 +48,9 @@ + + @@ -54,15 +58,16 @@ + - + @@ -75,30 +80,39 @@ + + + - + + + + + + + @@ -116,12 +130,19 @@ + + + + + + + @@ -133,26 +154,32 @@ + + + + + + @@ -161,27 +188,30 @@ - - + + - - + + + + + @@ -197,8 +227,10 @@ - + + + @@ -210,54 +242,58 @@ - + - - - - + + + + - + + + + - - + - + + + - - + - + + @@ -269,10 +305,15 @@ + + + + + @@ -284,32 +325,32 @@ + - + + + - - - - + @@ -319,20 +360,19 @@ - - + - - - - + + + + @@ -350,6 +390,7 @@ + @@ -358,6 +399,7 @@ + @@ -370,6 +412,7 @@ + @@ -383,20 +426,22 @@ + - - - + + + + @@ -404,19 +449,18 @@ - + - - + - + @@ -425,18 +469,46 @@ + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -457,42 +529,49 @@ + + + + + + - + + + - - - - - + + + + @@ -509,19 +588,18 @@ + - - - - - + + + @@ -542,26 +620,26 @@ - + - - + - - - + - + + + + - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/RTC_NG_API_Unity.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_Unity.ditamap index 62d545d1a40..7341c96354d 100644 --- a/en-US/dita/RTC-NG/RTC_NG_API_Unity.ditamap +++ b/en-US/dita/RTC-NG/RTC_NG_API_Unity.ditamap @@ -8,9 +8,9 @@ - + - + @@ -18,7 +18,7 @@ for - + @@ -26,6 +26,7 @@ + @@ -39,9 +40,13 @@ + + + + @@ -49,25 +54,28 @@ + + + - + @@ -82,18 +90,23 @@ + + + - - + + + + @@ -101,11 +114,14 @@ + + + @@ -128,47 +144,58 @@ + + - - + + + + + - + + - + + + + + + @@ -177,21 +204,24 @@ - - + + - - + + + + + @@ -199,8 +229,11 @@ + + + @@ -219,9 +252,11 @@ - + + + @@ -232,6 +267,7 @@ + @@ -241,58 +277,58 @@ - - - - + + + + + - - + - - + - + + - - - - + + + - + - + + @@ -306,8 +342,11 @@ + + + @@ -323,34 +362,35 @@ + - - + + + - - + @@ -360,7 +400,6 @@ - @@ -369,17 +408,17 @@ - - + + - - - - + + + + - + @@ -394,6 +433,7 @@ + @@ -402,7 +442,7 @@ - + @@ -416,6 +456,7 @@ + @@ -426,6 +467,7 @@ + @@ -433,14 +475,15 @@ - + - - + + + @@ -451,8 +494,7 @@ - - + @@ -460,7 +502,7 @@ - + @@ -474,14 +516,14 @@ - - + + - + @@ -502,12 +544,13 @@ - - + + + @@ -525,17 +568,18 @@ - - + + - - + + + - - + + - + @@ -544,18 +588,14 @@ + + + - - - - - - - @@ -563,9 +603,11 @@ - + + + @@ -580,38 +622,17 @@ - - - - - - - - - - - - - - - - - - - - - - - + + + - @@ -626,32 +647,42 @@ - + - + - + + + + + + + + + + + @@ -659,6 +690,7 @@ + diff --git a/en-US/dita/RTC-NG/RTC_NG_API_Unreal.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_Unreal.ditamap index bc1720d3b27..f9315883a9f 100644 --- a/en-US/dita/RTC-NG/RTC_NG_API_Unreal.ditamap +++ b/en-US/dita/RTC-NG/RTC_NG_API_Unreal.ditamap @@ -8,9 +8,9 @@ - + - + @@ -18,13 +18,14 @@ for - + + @@ -34,6 +35,7 @@ + @@ -42,13 +44,16 @@ + + + @@ -57,16 +62,17 @@ + - + @@ -77,12 +83,16 @@ + + + + @@ -90,11 +100,14 @@ + + + @@ -110,16 +123,23 @@ + + + + + - - + + + + @@ -128,13 +148,14 @@ - + + @@ -142,18 +163,23 @@ + + + + + @@ -162,20 +188,23 @@ - - + + - - + + + + + @@ -183,8 +212,10 @@ + + @@ -194,15 +225,16 @@ - + - + + @@ -214,64 +246,66 @@ + + - + + - - - - + + + + + + - - + - - - + + - - - - + + - + + @@ -285,8 +319,11 @@ + + + @@ -300,6 +337,7 @@ + @@ -307,6 +345,7 @@ + @@ -314,22 +353,24 @@ - + + + - - + + @@ -340,7 +381,6 @@ - @@ -351,10 +391,10 @@ - - - - + + + + @@ -372,6 +412,7 @@ + @@ -381,7 +422,7 @@ - + @@ -394,6 +435,7 @@ + @@ -412,13 +454,14 @@ - - - + + + + @@ -428,8 +471,7 @@ - - + @@ -439,7 +481,7 @@ - + @@ -448,12 +490,13 @@ + - - + + @@ -474,19 +517,21 @@ - - + + + - - + + + - - + + - + @@ -499,7 +544,9 @@ + + @@ -523,13 +570,16 @@ + + + - + - + @@ -555,23 +605,25 @@ - + + + + + + - - - @@ -601,14 +653,15 @@ - - + + + @@ -617,14 +670,9 @@ - + - - - - - @@ -640,73 +688,68 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - + + + + + + + + - + - + + + + + + + + + + + + + + + + diff --git a/en-US/dita/RTC-NG/RTC_NG_API_iOS.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_iOS.ditamap index 84b61ee672e..a366a1538d3 100644 --- a/en-US/dita/RTC-NG/RTC_NG_API_iOS.ditamap +++ b/en-US/dita/RTC-NG/RTC_NG_API_iOS.ditamap @@ -18,7 +18,7 @@ for - + @@ -27,6 +27,7 @@ + @@ -38,6 +39,8 @@ + + @@ -48,6 +51,7 @@ + @@ -96,6 +100,7 @@ + @@ -129,6 +134,7 @@ + @@ -366,6 +372,7 @@ + @@ -451,7 +458,7 @@ - + diff --git a/en-US/dita/RTC-NG/RTC_NG_API_macOS.ditamap b/en-US/dita/RTC-NG/RTC_NG_API_macOS.ditamap index c0494dbafcf..5d844480ff7 100644 --- a/en-US/dita/RTC-NG/RTC_NG_API_macOS.ditamap +++ b/en-US/dita/RTC-NG/RTC_NG_API_macOS.ditamap @@ -18,7 +18,7 @@ for - + @@ -26,6 +26,7 @@ + @@ -49,6 +50,7 @@ + @@ -90,11 +92,13 @@ + + @@ -129,6 +133,7 @@ + @@ -256,7 +261,6 @@ - @@ -356,6 +360,7 @@ + @@ -440,7 +445,7 @@ - + diff --git a/en-US/dita/RTC-NG/config/filter-product.ditaval b/en-US/dita/RTC-NG/config/filter-product.ditaval index d7cccb89653..35be9c1128c 100644 --- a/en-US/dita/RTC-NG/config/filter-product.ditaval +++ b/en-US/dita/RTC-NG/config/filter-product.ditaval @@ -1,4 +1,4 @@ - - + + diff --git a/en-US/dita/RTC-NG/config/filter-review-rtc-ng.ditaval b/en-US/dita/RTC-NG/config/filter-review-rtc-ng.ditaval index 3b77fb3c32d..a179c7af85c 100644 --- a/en-US/dita/RTC-NG/config/filter-review-rtc-ng.ditaval +++ b/en-US/dita/RTC-NG/config/filter-review-rtc-ng.ditaval @@ -18,6 +18,7 @@ + diff --git a/en-US/dita/RTC-NG/config/keys-global.ditamap b/en-US/dita/RTC-NG/config/keys-global.ditamap index 197f3b74af3..6534fc33754 100644 --- a/en-US/dita/RTC-NG/config/keys-global.ditamap +++ b/en-US/dita/RTC-NG/config/keys-global.ditamap @@ -13,9 +13,12 @@ - 6.1.0 - 4.1.1 - 4.1.0 + 6.5.2 + 4.6.1 + 4.6.0 + 4.5.2 + 4.5.1 + 4.5.1 diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap index 047167e85bb..0fdb54384bd 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-blueprint.ditamap @@ -5,7 +5,7 @@ - Unreal + Blueprint diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap index af860b00b7b..c10e33f4ffa 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap @@ -3861,7 +3861,7 @@ - + @@ -4725,7 +4725,7 @@ - + @@ -4957,7 +4957,7 @@ - + @@ -5113,7 +5113,7 @@ - + @@ -5715,7 +5715,7 @@ - + @@ -5878,7 +5878,7 @@ - + diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap index bfe8b26c523..1ba1b07a16c 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap @@ -466,7 +466,7 @@ - + @@ -2805,7 +2805,7 @@ - + @@ -3923,7 +3923,7 @@ - + @@ -4079,7 +4079,7 @@ - + @@ -4571,7 +4571,7 @@ - + @@ -4587,7 +4587,7 @@ - + @@ -12428,4 +12428,4 @@ - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap index 9542ba43698..ba4860a3ef0 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-flutter.ditamap @@ -2926,7 +2926,7 @@ - + @@ -3525,13 +3525,6 @@ - - - - onSongSimpleInfoResult - - - @@ -3975,7 +3968,7 @@ - + @@ -4131,7 +4124,7 @@ - + @@ -4640,7 +4633,7 @@ - + @@ -4729,7 +4722,7 @@ - + @@ -12407,4 +12400,4 @@ - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap index fea7fda41ef..0209b01d55e 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap @@ -2556,7 +2556,7 @@ - + @@ -4053,7 +4053,7 @@ - + @@ -4400,7 +4400,7 @@ - + @@ -4556,7 +4556,7 @@ - + @@ -5136,7 +5136,7 @@ - + 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 a306cb5363a..96fe30ac6fa 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 @@ -112,6 +112,13 @@ + + + + IMediaEngine + + + @@ -4179,7 +4186,7 @@ - + @@ -4608,7 +4615,7 @@ - + @@ -4853,7 +4860,7 @@ - + @@ -5009,7 +5016,7 @@ - + @@ -5728,7 +5735,7 @@ - + diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap index 915c57bb4c1..0dfa2a7f83c 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap @@ -4139,7 +4139,7 @@ - + @@ -4295,7 +4295,7 @@ - + @@ -4894,7 +4894,7 @@ - + diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-rn.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-rn.ditamap index 1c5ef11b452..fbbfaea52e4 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-rn.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-rn.ditamap @@ -3860,7 +3860,7 @@ - + @@ -4016,7 +4016,7 @@ - + @@ -4517,7 +4517,7 @@ - + @@ -4533,7 +4533,7 @@ - + @@ -4606,7 +4606,7 @@ - + diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap index c4c5990fce4..03ded714438 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-unity.ditamap @@ -3762,7 +3762,7 @@ - + @@ -4003,7 +4003,7 @@ - + @@ -4159,7 +4159,7 @@ - + @@ -4712,7 +4712,7 @@ - + @@ -4873,7 +4873,7 @@ - + diff --git a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap index 36e3cadc612..717d48b61db 100644 --- a/en-US/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap +++ b/en-US/dita/RTC-NG/config/keys-rtc-ng-api-unreal.ditamap @@ -5,7 +5,7 @@ - Unreal + Unreal Engine @@ -2827,21 +2827,21 @@ - onPlaybackAudioEncodedFrame + OnPlaybackAudioEncodedFrame - onRecordAudioEncodedFrame + OnRecordAudioEncodedFrame - onMixedAudioEncodedFrame + OnMixedAudioEncodedFrame @@ -3165,7 +3165,7 @@ - + @@ -3992,7 +3992,7 @@ - + @@ -4224,7 +4224,7 @@ - + @@ -4380,7 +4380,7 @@ - + @@ -4982,7 +4982,7 @@ - + @@ -5021,7 +5021,7 @@ - + @@ -5145,7 +5145,7 @@ - + @@ -5154,7 +5154,7 @@ - + @@ -5170,7 +5170,7 @@ - + @@ -5624,6 +5624,13 @@ + + + + MusicCacheInfo + + + diff --git a/en-US/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/en-US/dita/RTC-NG/config/relations-rtc-ng-api.ditamap index a9db0e9f602..f9c154eb850 100644 --- a/en-US/dita/RTC-NG/config/relations-rtc-ng-api.ditamap +++ b/en-US/dita/RTC-NG/config/relations-rtc-ng-api.ditamap @@ -17,12 +17,12 @@ - + - + @@ -60,7 +60,7 @@ - + @@ -94,7 +94,7 @@ - + @@ -104,7 +104,7 @@ - + @@ -118,7 +118,7 @@ - + @@ -127,7 +127,7 @@ - + @@ -150,7 +150,7 @@ - + @@ -169,8 +169,8 @@ - - + + @@ -183,7 +183,7 @@ - + @@ -202,7 +202,7 @@ - + @@ -215,7 +215,7 @@ - + @@ -242,7 +242,7 @@ - + @@ -251,19 +251,19 @@ - + - + - - - + + + - + @@ -280,7 +280,7 @@ - + @@ -289,7 +289,7 @@ - + @@ -306,7 +306,7 @@ - + @@ -368,10 +368,10 @@ - + - + @@ -384,7 +384,7 @@ - + @@ -397,7 +397,7 @@ - + @@ -414,7 +414,7 @@ - + @@ -425,7 +425,7 @@ - + @@ -441,7 +441,7 @@ - + @@ -453,7 +453,7 @@ - + @@ -479,7 +479,7 @@ - + @@ -493,7 +493,7 @@ - + @@ -512,7 +512,7 @@ - + @@ -520,7 +520,7 @@ - + @@ -528,7 +528,7 @@ - + @@ -553,8 +553,8 @@ - - + + @@ -586,7 +586,7 @@ - + @@ -667,8 +667,8 @@ - - + + @@ -737,9 +737,9 @@ - - - + + + @@ -757,7 +757,7 @@ - + @@ -778,7 +778,7 @@ - + @@ -846,7 +846,7 @@ - + @@ -872,7 +872,7 @@ - + @@ -887,7 +887,7 @@ - + @@ -898,14 +898,14 @@ - + - + - + @@ -921,7 +921,7 @@ - + @@ -945,7 +945,7 @@ - + @@ -954,7 +954,7 @@ - + @@ -973,7 +973,7 @@ - + @@ -1012,7 +1012,7 @@ - + @@ -1020,7 +1020,7 @@ - + @@ -1029,7 +1029,7 @@ - + @@ -1038,7 +1038,7 @@ - + @@ -1057,13 +1057,13 @@ - + - + @@ -1158,7 +1158,7 @@ - + @@ -1192,7 +1192,7 @@ - + @@ -1201,7 +1201,7 @@ - + @@ -1210,7 +1210,7 @@ - + @@ -1219,25 +1219,7 @@ - - - - - - - - - - - - - - - - - - - + @@ -1269,7 +1251,7 @@ - + @@ -1277,15 +1259,6 @@ - - - - - - - - - @@ -1331,7 +1304,7 @@ - + @@ -1353,7 +1326,7 @@ - + @@ -1443,14 +1416,14 @@ - - + + - + - + @@ -1459,17 +1432,17 @@ - + - + - + @@ -1479,7 +1452,7 @@ - + @@ -1487,7 +1460,7 @@ - + @@ -1504,10 +1477,10 @@ - + - + @@ -1543,7 +1516,7 @@ - + @@ -1569,7 +1542,7 @@ - + @@ -1585,7 +1558,7 @@ - + @@ -1593,7 +1566,7 @@ - + @@ -1620,7 +1593,7 @@ - + @@ -1637,7 +1610,7 @@ - + @@ -1657,7 +1630,7 @@ - + @@ -1684,7 +1657,7 @@ - + @@ -1813,7 +1786,7 @@ - + @@ -1830,7 +1803,7 @@ - + @@ -1839,7 +1812,7 @@ - + @@ -1848,7 +1821,7 @@ - + @@ -1859,7 +1832,7 @@ - + @@ -1878,14 +1851,14 @@ - + - + @@ -1893,10 +1866,10 @@ - + - + @@ -1904,7 +1877,7 @@ - + @@ -1914,7 +1887,7 @@ - + @@ -1936,7 +1909,7 @@ - + @@ -2005,7 +1978,7 @@ - + @@ -2013,7 +1986,7 @@ - + @@ -2047,7 +2020,7 @@ - + @@ -2091,7 +2064,7 @@ - + @@ -2107,7 +2080,7 @@ - + @@ -2120,7 +2093,7 @@ - + @@ -2177,7 +2150,7 @@ - + @@ -2193,7 +2166,7 @@ - + @@ -2220,28 +2193,31 @@ - + - + - + + - + + + @@ -2252,19 +2228,20 @@ - + - + + - + - + @@ -2275,6 +2252,7 @@ + @@ -2282,8 +2260,9 @@ - + + @@ -2292,29 +2271,32 @@ + - + + + - - - - - - - - + + + + + + + + - + - + - + @@ -2339,7 +2321,7 @@ - + @@ -2348,15 +2330,18 @@ - + + + + - + @@ -2372,39 +2357,41 @@ - + + - + + - - - - - - - - + + + + + + + + - + - - - - + + + + - + @@ -2421,10 +2408,11 @@ - + + @@ -2443,6 +2431,7 @@ + @@ -2451,76 +2440,77 @@ - - + + + - + - - - - + + + + - - + + + - - - + + - - - - - - + + + + + + - + - + - - - + + - - - + + + + + - + - + - @@ -2538,16 +2528,18 @@ - + + + - + - - + + @@ -2561,7 +2553,7 @@ - + @@ -2569,10 +2561,12 @@ - + + + @@ -2588,30 +2582,31 @@ - + - + + - - - + + + - - + + @@ -2628,9 +2623,9 @@ - + - + @@ -2645,6 +2640,7 @@ + @@ -2661,6 +2657,7 @@ + @@ -2677,11 +2674,12 @@ - + + @@ -2702,34 +2700,37 @@ - - - + + + + + + - - + + - - - - - + + + + + @@ -2739,16 +2740,16 @@ - + - - + + - - + + @@ -2764,7 +2765,7 @@ - + @@ -2782,7 +2783,7 @@ - + @@ -2794,14 +2795,14 @@ - + - + @@ -2812,15 +2813,14 @@ - + - - + @@ -2836,13 +2836,13 @@ - + - + @@ -2851,7 +2851,7 @@ - + @@ -2862,7 +2862,7 @@ - + @@ -2899,7 +2899,7 @@ - + @@ -2908,10 +2908,10 @@ - + - + @@ -2925,30 +2925,21 @@ - + - - - - - - - - - - - + - + - + + @@ -2957,24 +2948,24 @@ - - - - - + + + + + - + - + - + @@ -2987,7 +2978,7 @@ - + @@ -3000,12 +2991,12 @@ - + - + - + @@ -3019,19 +3010,15 @@ - - - - - + + + + + - - + + - - - - @@ -3046,11 +3033,11 @@ - + - + @@ -3073,7 +3060,7 @@ - + @@ -3090,7 +3077,7 @@ - + @@ -3109,20 +3096,18 @@ - + - - - + @@ -3131,14 +3116,16 @@ - + - + + + @@ -3155,15 +3142,18 @@ - + + + + - + diff --git a/en-US/dita/RTC-NG/config/subject-scheme-rtc.ditamap b/en-US/dita/RTC-NG/config/subject-scheme-rtc.ditamap index 670eadb29e5..191f44b71f9 100644 --- a/en-US/dita/RTC-NG/config/subject-scheme-rtc.ditamap +++ b/en-US/dita/RTC-NG/config/subject-scheme-rtc.ditamap @@ -73,7 +73,7 @@ - Unreal + Unreal Engine diff --git a/en-US/dita/RTC-NG/ditamaps/canvas.ditamap b/en-US/dita/RTC-NG/ditamaps/canvas.ditamap new file mode 100644 index 00000000000..c766fef0c39 --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/canvas.ditamap @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/ditamaps/icloudspatialaudioengine.ditamap b/en-US/dita/RTC-NG/ditamaps/icloudspatialaudioengine.ditamap deleted file mode 100644 index 9741fdc005d..00000000000 --- a/en-US/dita/RTC-NG/ditamaps/icloudspatialaudioengine.ditamap +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - diff --git a/en-US/dita/RTC-NG/ditamaps/icloudspatialaudioeventhandler.ditamap b/en-US/dita/RTC-NG/ditamaps/icloudspatialaudioeventhandler.ditamap deleted file mode 100644 index 303e2f15de8..00000000000 --- a/en-US/dita/RTC-NG/ditamaps/icloudspatialaudioeventhandler.ditamap +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/en-US/dita/RTC-NG/ditamaps/ifaceinfoobserver.ditamap b/en-US/dita/RTC-NG/ditamaps/ifaceinfoobserver.ditamap new file mode 100644 index 00000000000..78ee9dc1acc --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/ifaceinfoobserver.ditamap @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/ditamaps/ilocalspatialaudioengine.ditamap b/en-US/dita/RTC-NG/ditamaps/ilocalspatialaudioengine.ditamap index 2549f01a6a6..10e400f81d0 100644 --- a/en-US/dita/RTC-NG/ditamaps/ilocalspatialaudioengine.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/ilocalspatialaudioengine.ditamap @@ -8,6 +8,5 @@ - diff --git a/en-US/dita/RTC-NG/ditamaps/imediaengine.ditamap b/en-US/dita/RTC-NG/ditamaps/imediaengine.ditamap new file mode 100644 index 00000000000..ea341d42a52 --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/imediaengine.ditamap @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/ditamaps/imediaextensionobserver.ditamap b/en-US/dita/RTC-NG/ditamaps/imediaextensionobserver.ditamap index 317b99e155e..7615e9d7d9e 100644 --- a/en-US/dita/RTC-NG/ditamaps/imediaextensionobserver.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/imediaextensionobserver.ditamap @@ -2,9 +2,9 @@ - - - - + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/ditamaps/imediaplayer.ditamap b/en-US/dita/RTC-NG/ditamaps/imediaplayer.ditamap index d1cca92d3ce..6955cf5e646 100644 --- a/en-US/dita/RTC-NG/ditamaps/imediaplayer.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/imediaplayer.ditamap @@ -5,13 +5,14 @@ - - - + + + + @@ -20,8 +21,7 @@ - - + @@ -30,7 +30,7 @@ - + @@ -39,14 +39,16 @@ + - - + + - + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/ditamaps/imediaplayeraudioframeobserver.ditamap b/en-US/dita/RTC-NG/ditamaps/imediaplayeraudioframeobserver.ditamap index 2e1ef399139..1967fb79d4b 100644 --- a/en-US/dita/RTC-NG/ditamaps/imediaplayeraudioframeobserver.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/imediaplayeraudioframeobserver.ditamap @@ -2,7 +2,7 @@ - + - - \ No newline at end of file + + diff --git a/en-US/dita/RTC-NG/ditamaps/imediaplayersourceobserver.ditamap b/en-US/dita/RTC-NG/ditamaps/imediaplayersourceobserver.ditamap index 43c7d44dc2b..77aeee3300e 100644 --- a/en-US/dita/RTC-NG/ditamaps/imediaplayersourceobserver.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/imediaplayersourceobserver.ditamap @@ -3,11 +3,14 @@ - + + + + diff --git a/en-US/dita/RTC-NG/ditamaps/imediarecorder.ditamap b/en-US/dita/RTC-NG/ditamaps/imediarecorder.ditamap index c87d683a561..d4c466b032c 100644 --- a/en-US/dita/RTC-NG/ditamaps/imediarecorder.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/imediarecorder.ditamap @@ -1,11 +1,9 @@ - - + - diff --git a/en-US/dita/RTC-NG/ditamaps/imediarecorderobserver.ditamap b/en-US/dita/RTC-NG/ditamaps/imediarecorderobserver.ditamap index 55dfe2ddb96..d01438de45d 100644 --- a/en-US/dita/RTC-NG/ditamaps/imediarecorderobserver.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/imediarecorderobserver.ditamap @@ -1,7 +1,7 @@ - + diff --git a/en-US/dita/RTC-NG/ditamaps/imusiccontentcenter.ditamap b/en-US/dita/RTC-NG/ditamaps/imusiccontentcenter.ditamap new file mode 100644 index 00000000000..ba9e1c18b03 --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/imusiccontentcenter.ditamap @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/ditamaps/imusiccontentcentereventhandler.ditamap b/en-US/dita/RTC-NG/ditamaps/imusiccontentcentereventhandler.ditamap new file mode 100644 index 00000000000..2db5dbaf2a1 --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/imusiccontentcentereventhandler.ditamap @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/ditamaps/imusicplayer.ditamap b/en-US/dita/RTC-NG/ditamaps/imusicplayer.ditamap new file mode 100644 index 00000000000..b570e10517f --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/imusicplayer.ditamap @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/en-US/dita/RTC-NG/ditamaps/irtcengine.ditamap b/en-US/dita/RTC-NG/ditamaps/irtcengine.ditamap index cace2fc4d63..ceb63951ffb 100644 --- a/en-US/dita/RTC-NG/ditamaps/irtcengine.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/irtcengine.ditamap @@ -2,11 +2,15 @@ - + + + + + @@ -16,23 +20,25 @@ - - - + + + + + - + @@ -50,6 +56,8 @@ + + @@ -61,6 +69,11 @@ + + + + + @@ -69,15 +82,19 @@ + + + + @@ -96,47 +113,57 @@ + + - - - - - + + + + + + + + + + + + + - + @@ -146,22 +173,29 @@ + - - + + + + + + - - + + + + @@ -169,8 +203,10 @@ + + @@ -178,20 +214,28 @@ + + - + - + + + + + + + @@ -199,9 +243,9 @@ + - - + @@ -209,13 +253,16 @@ - - - - + + + - + + + + + @@ -225,10 +272,14 @@ + - + + + + @@ -236,12 +287,16 @@ + + + + - + diff --git a/en-US/dita/RTC-NG/ditamaps/irtcengineeventhandler.ditamap b/en-US/dita/RTC-NG/ditamaps/irtcengineeventhandler.ditamap index 00e1244208d..85383daa0ae 100644 --- a/en-US/dita/RTC-NG/ditamaps/irtcengineeventhandler.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/irtcengineeventhandler.ditamap @@ -3,9 +3,9 @@ - + @@ -15,7 +15,6 @@ - @@ -43,8 +42,7 @@ - - + @@ -53,10 +51,11 @@ - + + @@ -66,6 +65,7 @@ + diff --git a/en-US/dita/RTC-NG/ditamaps/irtcengineex.ditamap b/en-US/dita/RTC-NG/ditamaps/irtcengineex.ditamap index 87250a1f2e3..cecbe847070 100644 --- a/en-US/dita/RTC-NG/ditamaps/irtcengineex.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/irtcengineex.ditamap @@ -3,12 +3,16 @@ + + + + @@ -23,33 +27,38 @@ + + + + - - + - + + + + - - + + - diff --git a/en-US/dita/RTC-NG/ditamaps/irtcenginereleasecallback.ditamap b/en-US/dita/RTC-NG/ditamaps/irtcenginereleasecallback.ditamap new file mode 100644 index 00000000000..9e6d024e265 --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/irtcenginereleasecallback.ditamap @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/en-US/dita/RTC-NG/ditamaps/ivideoeffectsobject.ditamap b/en-US/dita/RTC-NG/ditamaps/ivideoeffectsobject.ditamap new file mode 100644 index 00000000000..d0805e05694 --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/ivideoeffectsobject.ditamap @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/en-US/dita/RTC-NG/ditamaps/ivideoframeobserver.ditamap b/en-US/dita/RTC-NG/ditamaps/ivideoframeobserver.ditamap index 3a91285a3a4..b2fca3ac7bb 100644 --- a/en-US/dita/RTC-NG/ditamaps/ivideoframeobserver.ditamap +++ b/en-US/dita/RTC-NG/ditamaps/ivideoframeobserver.ditamap @@ -8,10 +8,8 @@ - + - - diff --git a/en-US/dita/RTC-NG/ditamaps/player.ditamap b/en-US/dita/RTC-NG/ditamaps/player.ditamap new file mode 100644 index 00000000000..049d8083e22 --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/player.ditamap @@ -0,0 +1,71 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/en-US/dita/RTC-NG/ditamaps/rte.ditamap b/en-US/dita/RTC-NG/ditamaps/rte.ditamap new file mode 100644 index 00000000000..ae7aea27aec --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/rte.ditamap @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/en-US/dita/RTC-NG/ditamaps/watermark.ditamap b/en-US/dita/RTC-NG/ditamaps/watermark.ditamap new file mode 100644 index 00000000000..e3e395413ac --- /dev/null +++ b/en-US/dita/RTC-NG/ditamaps/watermark.ditamap @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/en-US/dita/rtc_api.xpr b/en-US/dita/rtc_api.xpr index 31c982f700d..3f6f21b2027 100644 --- a/en-US/dita/rtc_api.xpr +++ b/en-US/dita/rtc_api.xpr @@ -202,7 +202,7 @@ - RTC-AIDOC/RTC_NG_API_CPP.ditamap + RTC-NG/RTC_NG_API_CPP.ditamap @@ -220,46 +220,6 @@ - - - RTC-AIDOC/RTC_NG_API_Android.ditamap - - - - DITA Map HTML5 - NG Android - - - - - DITAMAP - - - - - 2 - - - - - - RTC-NG/RTC_NG_API_macOS.ditamap - - - - DITA Map HTML5 - NG macOS - - - - - DITAMAP - - - - - 2 - - - RTC-AIDOC/RTC_NG_API_macOS.ditamap @@ -380,26 +340,6 @@ - - - RTC-AIDOC-FRAMEWORK/RTC_NG_API_Blueprint.ditamap - - - - DITA Map HTML5 - NG Blueprint - - - - - DITAMAP - - - - - 2 - - - RTC-AIDOC-FRAMEWORK/RTC_NG_API_Unreal.ditamap @@ -422,71 +362,11 @@ - RTC-AIDOC-FRAMEWORK/RTC_NG_API_CS.ditamap - - - - DITA Map HTML5 - NG CS - - - - - DITAMAP - - - - - 2 - - - - - - RTC-AIDOC-FRAMEWORK/RTC_NG_API_Harmony.ditamap - - - - DITA Map HTML5 - NG Harmony - - - - - DITAMAP - - - - - 2 - - - - - - RTC-NG/RTC_NG_API_CPP.ditamap - - - - DITA Map HTML5 - NG CPP - - - - - DITAMAP - - - - - 2 - - - - - - RTC-NG/RTC_NG_API_Flutter.ditamap + RTC-NG/RTC_NG_Release_Unreal.ditamap - DITA Map HTML5 - NG Flutter + Release Notes HTML5 - NG Unity @@ -502,11 +382,11 @@ - RTC-NG/RTC_NG_API_Blueprint.ditamap + RTC-NG/RTC_NG_Release_Unity.ditamap - DITA Map HTML5 - NG Blueprint + Release Notes HTML5 - NG Unity @@ -522,11 +402,11 @@ - RTC-NG/RTC_NG_API_Harmony.ditamap + RTC-NG/RTC_NG_Release_RN.ditamap - DITA Map HTML5 - NG Harmony + Release Notes HTML5 - NG RN @@ -542,11 +422,11 @@ - RTC-NG/RTC_NG_API_Unity.ditamap + RTC-NG/RTC_NG_Release_macOS.ditamap - DITA Map HTML5 - NG Unity + Release Notes HTML5 - NG macOS @@ -562,11 +442,11 @@ - RTC-NG/RTC_NG_API_iOS.ditamap + RTC-NG/RTC_NG_Release_iOS.ditamap - DITA Map HTML5 - NG iOS + Release Notes HTML5 - NG iOS @@ -582,11 +462,11 @@ - RTC-NG/RTC_NG_API_CS.ditamap + RTC-NG/RTC_NG_Release_Flutter.ditamap - DITA Map HTML5 - NG CS + Release Notes HTML5 - NG Flutter @@ -602,11 +482,11 @@ - RTC-NG/RTC_NG_Release_Unreal.ditamap + RTC-NG/RTC_NG_Release_Electron.ditamap - Release Notes HTML5 - NG Unreal + Release Notes HTML5 - NG Electron @@ -622,11 +502,11 @@ - RTC-NG/RTC_NG_Release_Unity.ditamap + RTC-NG/RTC_NG_Release_CS.ditamap - Release Notes HTML5 - NG Unity + Release Notes HTML5 - NG CS @@ -642,11 +522,11 @@ - RTC-NG/RTC_NG_Release_RN.ditamap + RTC-NG/RTC_NG_Release_CPP.ditamap - Release Notes HTML5 - NG RN + Release Notes HTML5 - NG CPP @@ -662,11 +542,11 @@ - RTC-NG/RTC_NG_Release_macOS.ditamap + RTC-NG/RTC_NG_Release_Android.ditamap - Release Notes HTML5 - NG macOS + Release Notes HTML5 - NG Android @@ -682,11 +562,11 @@ - RTC-NG/RTC_NG_Release_iOS.ditamap + RTC/RTC_API_CS.ditamap - Release Notes HTML5 - NG iOS + DITA Map HTML5 - C# @@ -702,11 +582,11 @@ - RTC-NG/RTC_NG_Release_Flutter.ditamap + RTC/RTC_API_Flutter.ditamap - Release Notes HTML5 - NG Flutter + DITA Map HTML5 - Flutter @@ -722,11 +602,11 @@ - RTC-NG/RTC_NG_Release_Electron.ditamap + RTC-NG/API/api_ivideodevicemanager_setdevice.dita - Release Notes HTML5 - NG Electron + DITA Map HTML5 - NG Flutter @@ -742,11 +622,11 @@ - RTC-NG/RTC_NG_Release_CS.ditamap + RTC/RTC_API_CPP.ditamap - Release Notes HTML5 - NG CS + DITA Map HTML5 - CPP @@ -762,11 +642,11 @@ - RTC-NG/RTC_NG_Release_CPP.ditamap + RTC/RTC_NG_API_CPP.ditamap - Release Notes HTML5 - NG CPP + DITA Map HTML5 - NG CPP @@ -782,71 +662,34 @@ - RTC-NG/RTC_NG_Release_Android.ditamap + RTC/RTC_NG_API_iOS.ditamap - Release Notes HTML5 - NG Android + DITA Map HTML5 - NG iOS + DITA Map HTML5 - NG macOS DITAMAP - - - - - 2 - - - - - - RTC-NG/RTC_NG_API_RN.ditamap - - - - DITA Map HTML5 - NG RN - - - - DITAMAP 2 - - - - - - RTC-NG/RTC_NG_API_Unreal.ditamap - - - - DITA Map HTML5 - NG Unreal - - - - - DITAMAP - - - - 2 - RTC-NG/RTC_NG_API_Electron.ditamap + RTC-NG/RTC_NG_API_Unity.ditamap - DITA Map HTML5 - NG Electron + DITA Map HTML5 - NG Unity @@ -882,11 +725,11 @@ - RTC/RTC_API_CS.ditamap + RTC-NG/RTC_NG_API_RN.ditamap - DITA Map HTML5 - C# + DITA Map HTML5 - NG RN @@ -902,11 +745,11 @@ - RTC/RTC_API_Flutter.ditamap + RTC-NG/RTC_NG_API_macOS.ditamap - DITA Map HTML5 - Flutter + DITA Map HTML5 - NG macOS @@ -922,11 +765,11 @@ - RTC-NG/API/api_ivideodevicemanager_setdevice.dita + RTC-NG/RTC_NG_API_iOS.ditamap - DITA Map HTML5 - NG Flutter + DITA Map HTML5 - NG iOS @@ -942,11 +785,11 @@ - RTC/RTC_API_CPP.ditamap + RTC-NG/RTC_NG_API_Flutter.ditamap - DITA Map HTML5 - CPP + DITA Map HTML5 - NG Flutter @@ -962,11 +805,11 @@ - RTC/RTC_NG_API_CPP.ditamap + RTC-NG/RTC_NG_API_Unreal.ditamap - DITA Map HTML5 - NG CPP + DITA Map HTML5 - NG Unreal @@ -982,24 +825,21 @@ - RTC/RTC_NG_API_iOS.ditamap + RTC-NG/RTC_NG_API_Electron.ditamap - DITA Map HTML5 - NG iOS - DITA Map HTML5 - NG macOS + DITA Map HTML5 - NG Electron DITAMAP - DITAMAP 2 - 2 @@ -1015,9 +855,6 @@ false - - false - ${pd} @@ -1256,9 +1093,6 @@ false - - false - ${pd} @@ -1497,9 +1331,6 @@ false - - false - ${pd} @@ -1738,9 +1569,6 @@ false - - false - ${pd} @@ -1979,9 +1807,6 @@ false - - false - ${pd} @@ -2220,9 +2045,6 @@ false - - false - ${pd} @@ -2461,9 +2283,6 @@ false - - false - ${pd} @@ -2702,9 +2521,6 @@ false - - true - ${pd} @@ -2801,33 +2617,1793 @@ - nav-toc + nav-toc + + + + + + full + + + none + + + 4 + + + + none + partial + full + + + + + + No TOC + Partial TOC that shows the current topic + Full TOC + + + + + + + + + + false + + + + + + false + + + + + + + + + true + + + + + + DITA Map HTML5 - NG RN + + + + + + + + + + + + + + + + + + + + + + + + false + + + false + + + DITAMAP + + + true + + + true + + + + + + false + + + + + + false + + + false + + + false + + + false + + + false + + + false + + + + + + + + + DITA-OT + + + + + + + + false + + + false + + + ${pd} + + + ${pd}/out/unity-ng + + + ${pd}/temp/html5 + + + html5 + + + + + true + + + false + + + + + + ${cfd}/config/filter-unity-rtc-ng.ditaval + + + + + + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + args.rellinks + + + + + + all + + + + + + 4 + + + + none + all + noparent + nofamily + + + + + + No links are included. + All links are included. + Parent links are not included. + Parent, child, next, and previous links are not included. + + + + + + nav-toc + + + + + + full + + + none + + + 4 + + + + none + partial + full + + + + + + No TOC + Partial TOC that shows the current topic + Full TOC + + + + + + + + + + false + + + + + + false + + + + + + + + + true + + + + + + DITA Map HTML5 - NG Unity + + + + + + + + + + + + + + + + + + + + + + + + false + + + false + + + DITAMAP + + + true + + + true + + + + + + false + + + + + + false + + + false + + + false + + + false + + + false + + + false + + + + + + + + + DITA-OT + + + + + + + + false + + + false + + + ${pd} + + + ${pd}/out/unreal-ng + + + ${pd}/temp/html5 + + + html5 + + + + + true + + + false + + + + + + ${cfd}/config/filter-unreal-rtc-ng.ditaval + + + + + + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + args.rellinks + + + + + + all + + + + + + 4 + + + + none + all + noparent + nofamily + + + + + + No links are included. + All links are included. + Ancestor and parent links are not included. + Parent, ancestor, child, descendant, sibling, next, previous, and cousin links are not included. + + + + + + nav-toc + + + + + + full + + + none + + + 4 + + + + none + partial + full + + + + + + No TOC + Partial TOC that shows the current topic + Full TOC + + + + + + + + + + false + + + + + + false + + + + + + + + + true + + + + + + DITA Map HTML5 - NG Unreal + + + + + + + + + + + + + + + + + + + + + + + + false + + + false + + + DITAMAP + + + true + + + true + + + + + + false + + + + + + false + + + false + + + false + + + false + + + false + + + false + + + + + + + + + DITA-OT + + + + + + + + false + + + false + + + ${pd} + + + ${pd}/out/ios-ng + + + ${pd}/temp/html5 + + + html5 + + + + + true + + + false + + + + + + ${cfd}/config/filter-ios-rtc-ng.ditaval + + + + + + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + args.rellinks + + + + + + all + + + + + + 4 + + + + none + all + noparent + nofamily + + + + + + No links are included. + All links are included. + Parent links are not included. + Parent, child, next, and previous links are not included. + + + + + + nav-toc + + + + + + full + + + none + + + 4 + + + + none + partial + full + + + + + + No TOC + Partial TOC that shows the current topic + Full TOC + + + + + + + + + + false + + + + + + false + + + + + + + + + true + + + + + + DITA Map HTML5 - NG iOS + + + + + + + + + + + + + + + + + + + + + + + + false + + + false + + + DITAMAP + + + true + + + true + + + + + + false + + + + + + false + + + false + + + false + + + false + + + false + + + false + + + + + + + + + DITA-OT + + + + + + + + false + + + false + + + ${pd} + + + ${pd}/out/mac-ng + + + ${pd}/temp/html5 + + + html5 + + + + + true + + + false + + + + + + ${cfd}/config/filter-mac-rtc-ng.ditaval + + + + + + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + args.rellinks + + + + + + all + + + + + + 4 + + + + none + all + noparent + nofamily + + + + + + No links are included. + All links are included. + Parent links are not included. + Parent, child, next, and previous links are not included. + + + + + + nav-toc + + + + + + full + + + none + + + 4 + + + + none + partial + full + + + + + + No TOC + Partial TOC that shows the current topic + Full TOC + + + + + + + + + + false + + + + + + false + + + + + + + + + true + + + + + + DITA Map HTML5 - NG macOS + + + + + + + + + + + + + + + + + + + + + + + + false + + + false + + + DITAMAP + + + true + + + true + + + + + + false + + + + + + false + + + false + + + false + + + false + + + false + + + false + + + + + + + + + DITA-OT + + + + + + + + false + + + false + + + ${cfd} + + + ${cfd}/out/markdown/android + + + ${cfd}/temp/markdown + + + markdown + + + + + true + + + false + + + + + + file:/D:/Git/agora_doc_source/en-US/dita/RTC-NG/config/filter-android-rtc-ng.ditaval + + + + + + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + args.gen.task.lbl + + + + + + NO + + + + + + 4 + + + + YES + NO + + + + + + + + + + + + + + + + + false + + + + + + false + + + + + + + + + true + + + + + + DITA Map Markdown - Android + + + + + + + + + + + + + + + + + + + + + + + + false + + + false + + + DITAMAP + + + true + + + true + + + + + + false + + + + + + false + + + false + + + false + + + false + + + false + + + false + + + + + + + + + DITA-OT + + + + + + + + false + + + false + + + ${cfd} + + + ${cfd}/out/markdown/blueprint + + + ${cfd}/temp/markdown + + + markdown + + + + + true + + + false + + + + + + file:/D:/Git/agora_doc_source/en-US/dita/RTC-NG/config/filter-bp-rtc-ng.ditaval + + + + + + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + args.gen.task.lbl + + + + + + NO + + + + + + 4 + + + + YES + NO + + + + + + + + + + + + + + + + + false + + + + + + false + + + + + + + + + true + + + + + + DITA Map Markdown - Blueprint + + + + + + + + + + + + + + + + + + + + + + + + false + + + false + + + DITAMAP + + + true + + + true + + + + + + false + + + + + + false + + + false + + + false + + + false + + + false + + + false + + + + + + + + + DITA-OT + + + + + + + + false + + + false + + + ${cfd} + + + ${cfd}/out/markdown/cpp + + + ${cfd}/temp/markdown + + + markdown + + + + + true + + + false + + + + + + file:/D:/Git/agora_doc_source/en-US/dita/RTC-NG/config/filter-cpp-rtc-ng.ditaval + + + + + + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + args.gen.task.lbl + + + + + + NO + + + + + + 4 + + + + YES + NO + + + + + + + + + + + + + + + + + false + + + + + + false + + + + + + + + + true + + + + + + DITA Map Markdown - C++ + + + + + + + + + + + + + + + + + + + + + + + + false + + + false + + + DITAMAP + + + true + + + true + + + + + + false + + + + + + false + + + false + + + false + + + false + + + false + + + false + + + + + + + + + DITA-OT + + + + + + + + false + + + false + + + ${cfd} + + + ${cfd}/out/markdown/electron + + + ${cfd}/temp/markdown + + + markdown + + + + + true + + + false + + + + + + file:/D:/Git/agora_doc_source/en-US/dita/RTC-NG/config/filter-electron-rtc-ng.ditaval + + + + + + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + args.gen.task.lbl - full + NO - none + 4 - none - partial - full + YES + NO - No TOC - Partial TOC that shows the current topic - Full TOC + + @@ -2858,7 +4434,7 @@ - DITA Map HTML5 - NG RN + DITA Map Markdown - Electron @@ -2943,20 +4519,17 @@ false - - true - - ${pd} + ${cfd} - ${pd}/out/unity-ng + ${cfd}/out/markdown/flutter - ${pd}/temp/html5 + ${cfd}/temp/markdown - html5 + markdown @@ -2970,7 +4543,7 @@ - ${cfd}/config/filter-unity-rtc-ng.ditaval + file:/D:/Git/agora_doc_source/en-US/dita/RTC-NG/config/filter-flutter-rtc-ng.ditaval @@ -3008,13 +4581,13 @@ - args.rellinks + args.gen.task.lbl - all + NO @@ -3024,51 +4597,15 @@ - none - all - noparent - nofamily - - - - - - No links are included. - All links are included. - Parent links are not included. - Parent, child, next, and previous links are not included. - - - - - - nav-toc - - - - - - full - - - none - - - 4 - - - - none - partial - full + YES + NO - No TOC - Partial TOC that shows the current topic - Full TOC + + @@ -3099,7 +4636,7 @@ - DITA Map HTML5 - NG Unity + DITA Map Markdown - Flutter @@ -3184,20 +4721,17 @@ false - - false - - ${pd} + ${cfd} - ${pd}/out/unreal-ng + ${cfd}/out/markdown/react-native - ${pd}/temp/html5 + ${cfd}/temp/markdown - html5 + markdown @@ -3211,7 +4745,7 @@ - ${cfd}/config/filter-unreal-rtc-ng.ditaval + file:/D:/Git/agora_doc_source/en-US/dita/RTC-NG/config/filter-rn-rtc-ng.ditaval @@ -3249,13 +4783,13 @@ - args.rellinks + args.gen.task.lbl - all + NO @@ -3265,51 +4799,15 @@ - none - all - noparent - nofamily - - - - - - No links are included. - All links are included. - Ancestor and parent links are not included. - Parent, ancestor, child, descendant, sibling, next, previous, and cousin links are not included. - - - - - - nav-toc - - - - - - full - - - none - - - 4 - - - - none - partial - full + YES + NO - No TOC - Partial TOC that shows the current topic - Full TOC + + @@ -3340,7 +4838,7 @@ - DITA Map HTML5 - NG Unreal + DITA Map Markdown - RN @@ -3425,20 +4923,17 @@ false - - true - - ${pd} + ${cfd} - ${pd}/out/ios-ng + ${cfd}/out/markdown/unity - ${pd}/temp/html5 + ${cfd}/temp/markdown - html5 + markdown @@ -3452,7 +4947,7 @@ - ${cfd}/config/filter-ios-rtc-ng.ditaval + file:/D:/Git/agora_doc_source/en-US/dita/RTC-NG/config/filter-unity-rtc-ng.ditaval @@ -3490,13 +4985,13 @@ - args.rellinks + args.gen.task.lbl - all + NO @@ -3506,51 +5001,15 @@ - none - all - noparent - nofamily - - - - - - No links are included. - All links are included. - Parent links are not included. - Parent, child, next, and previous links are not included. - - - - - - nav-toc - - - - - - full - - - none - - - 4 - - - - none - partial - full + YES + NO - No TOC - Partial TOC that shows the current topic - Full TOC + + @@ -3581,7 +5040,7 @@ - DITA Map HTML5 - NG iOS + DITA Map Markdown - Unity @@ -3666,20 +5125,17 @@ false - - true - - ${pd} + ${cfd} - ${pd}/out/mac-ng + ${cfd}/out/markdown/unreal-engine - ${pd}/temp/html5 + ${cfd}/temp/markdown - html5 + markdown @@ -3693,7 +5149,7 @@ - ${cfd}/config/filter-mac-rtc-ng.ditaval + file:/D:/Git/agora_doc_source/en-US/dita/RTC-NG/config/filter-unreal-rtc-ng.ditaval @@ -3731,13 +5187,13 @@ - args.rellinks + args.gen.task.lbl - all + NO @@ -3747,51 +5203,15 @@ - none - all - noparent - nofamily - - - - - - No links are included. - All links are included. - Parent links are not included. - Parent, child, next, and previous links are not included. - - - - - - nav-toc - - - - - - full - - - none - - - 4 - - - - none - partial - full + YES + NO - No TOC - Partial TOC that shows the current topic - Full TOC + + @@ -3822,7 +5242,7 @@ - DITA Map HTML5 - NG macOS + DITA Map Markdown - Unreal @@ -3907,9 +5327,6 @@ false - - false - ${pd} @@ -4148,9 +5565,6 @@ false - - false - ${pd} @@ -4389,9 +5803,6 @@ false - - false - ${pd} @@ -4630,9 +6041,6 @@ false - - false - ${pd} @@ -4871,9 +6279,6 @@ false - - false - ${pd} @@ -5112,9 +6517,6 @@ false - - false - ${pd} @@ -5353,9 +6755,6 @@ false - - false - ${pd} @@ -5594,9 +6993,6 @@ false - - false - ${pd} @@ -5835,9 +7231,6 @@ false - - false - ${pd} @@ -6076,9 +7469,6 @@ false - - false - ${pd} @@ -6399,9 +7789,6 @@ - - - @@ -6446,9 +7833,6 @@ - - - @@ -6480,9 +7864,6 @@ - - - diff --git a/markdown/RTC 4.x/release-notes/en-US/native/release_android_ng.md b/markdown/RTC 4.x/release-notes/en-US/native/release_android_ng.md index 119b2684e58..d5906d53910 100644 --- a/markdown/RTC 4.x/release-notes/en-US/native/release_android_ng.md +++ b/markdown/RTC 4.x/release-notes/en-US/native/release_android_ng.md @@ -193,7 +193,7 @@ This version adds the `AUDIO_SCENARIO_AI_CLIENT` audio scenario specifically des This release fixed the following issues: -- Apps that integrated the Agora SDK and set the `targetSdkVersion` to 34 encountered crashes when attempting to enable screen sharing for the first time on an Android 14 system. +- Apps that integrated Agora SDK and set the `targetSdkVersion` to 34 encountered crashes when attempting to enable screen sharing for the first time on an Android 14 system. - When joining two or more channels simultaneously, and calling the `takeSnapshotEx [1/2]` method to take screenshots of the local video streams in each channel consecutively, the screenshot of the first channel failed. - When using the `pause` method to pause playback, then calling `seek` to move to a specified position, and finally calling `play` to continue playback, the Media Player resumed from the position where it was paused, not the new specified position. - When using the Media Player, the file path of the media resource returned by the `getPlaySrc [1/2]` did not change after calling the `switchSrc` method to switch to a new media resource. diff --git a/package-lock.json b/package-lock.json index 16815eea12c..2e7998ebf72 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,6 +5,9 @@ "packages": { "": { "name": "docs", + "dependencies": { + "docs": "file:" + }, "devDependencies": { "chalk": "^3.0.0", "husky": "^7.0.4", @@ -336,6 +339,10 @@ } } }, + "node_modules/docs": { + "resolved": "", + "link": true + }, "node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", @@ -1325,6 +1332,802 @@ "ms": "2.1.2" } }, + "docs": { + "version": "file:", + "requires": { + "chalk": "^3.0.0", + "docs": "file:", + "husky": "^7.0.4", + "lint-staged": "11.2.6", + "prettier": "^2.5.1" + }, + "dependencies": { + "@babel/code-frame": { + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.16.0.tgz", + "integrity": "sha512-IF4EOMEV+bfYwOmNxGzSnjR2EmQod7f1UXOpZM3l4i4o4QNwzjtJAu/HxdjHq0aYBvdqMuQEY1eg0nqW9ZPORA==", + "dev": true, + "requires": { + "@babel/highlight": "^7.16.0" + } + }, + "@babel/helper-validator-identifier": { + "version": "7.15.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.15.7.tgz", + "integrity": "sha512-K4JvCtQqad9OY2+yTU8w+E82ywk/fe+ELNlt1G8z3bVGlZfn/hOcQQsUhGhW/N+tb3fxK800wLtKOE/aM0m72w==", + "dev": true + }, + "@babel/highlight": { + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.16.0.tgz", + "integrity": "sha512-t8MH41kUQylBtu2+4IQA3atqevA2lRgqA2wyVB/YiWmsDSuylZZuXOUy9ric30hfzauEFfdsuk/eXTRrGrfd0g==", + "dev": true, + "requires": { + "@babel/helper-validator-identifier": "^7.15.7", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "requires": { + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "@types/parse-json": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.0.tgz", + "integrity": "sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==", + "dev": true + }, + "aggregate-error": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", + "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", + "dev": true, + "requires": { + "clean-stack": "^2.0.0", + "indent-string": "^4.0.0" + } + }, + "ansi-colors": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", + "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", + "dev": true + }, + "ansi-escapes": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", + "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "dev": true, + "requires": { + "type-fest": "^0.21.3" + } + }, + "ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true + }, + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "astral-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", + "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", + "dev": true + }, + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, + "callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "clean-stack": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", + "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", + "dev": true + }, + "cli-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", + "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "dev": true, + "requires": { + "restore-cursor": "^3.1.0" + } + }, + "cli-truncate": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-2.1.0.tgz", + "integrity": "sha512-n8fOixwDD6b/ObinzTrp1ZKFzbgvKZvuz/TvejnLn1aQfC6r52XEx85FmuC+3HI+JM7coBRXUvNqEU2PHVrHpg==", + "dev": true, + "requires": { + "slice-ansi": "^3.0.0", + "string-width": "^4.2.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "colorette": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz", + "integrity": "sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g==", + "dev": true + }, + "commander": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", + "integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==", + "dev": true + }, + "cosmiconfig": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-7.0.1.tgz", + "integrity": "sha512-a1YWNUV2HwGimB7dU2s1wUMurNKjpx60HxBB6xUM8Re+2s1g1IIfJvFR0/iCF+XHdE0GMTKTuLR32UQff4TEyQ==", + "dev": true, + "requires": { + "@types/parse-json": "^4.0.0", + "import-fresh": "^3.2.1", + "parse-json": "^5.0.0", + "path-type": "^4.0.0", + "yaml": "^1.10.0" + } + }, + "cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "requires": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + } + }, + "debug": { + "version": "4.3.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.3.tgz", + "integrity": "sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true + }, + "enquirer": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz", + "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==", + "dev": true, + "requires": { + "ansi-colors": "^4.1.1" + } + }, + "error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "requires": { + "is-arrayish": "^0.2.1" + } + }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "get-own-enumerable-property-symbols": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz", + "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "husky": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/husky/-/husky-7.0.4.tgz", + "integrity": "sha512-vbaCKN2QLtP/vD4yvs6iz6hBEo6wkSzs8HpRah1Z6aGmF2KW5PdYuAd7uX5a+OyBZHBhd+TFLqgjUgytQr4RvQ==", + "dev": true + }, + "import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "requires": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + } + }, + "indent-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", + "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "dev": true + }, + "is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", + "dev": true + }, + "is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true + }, + "is-obj": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", + "integrity": "sha1-PkcprB9f3gJc19g6iW2rn09n2w8=", + "dev": true + }, + "is-regexp": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz", + "integrity": "sha1-/S2INUXEa6xaYz57mgnof6LLUGk=", + "dev": true + }, + "is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true + }, + "isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", + "dev": true + }, + "js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true + }, + "json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true + }, + "lines-and-columns": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", + "dev": true + }, + "lint-staged": { + "version": "11.2.6", + "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-11.2.6.tgz", + "integrity": "sha512-Vti55pUnpvPE0J9936lKl0ngVeTdSZpEdTNhASbkaWX7J5R9OEifo1INBGQuGW4zmy6OG+TcWPJ3m5yuy5Q8Tg==", + "dev": true, + "requires": { + "cli-truncate": "2.1.0", + "colorette": "^1.4.0", + "commander": "^8.2.0", + "cosmiconfig": "^7.0.1", + "debug": "^4.3.2", + "enquirer": "^2.3.6", + "execa": "^5.1.1", + "listr2": "^3.12.2", + "micromatch": "^4.0.4", + "normalize-path": "^3.0.0", + "please-upgrade-node": "^3.2.0", + "string-argv": "0.3.1", + "stringify-object": "3.3.0", + "supports-color": "8.1.1" + }, + "dependencies": { + "execa": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "dev": true, + "requires": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.0", + "human-signals": "^2.1.0", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.1", + "onetime": "^5.1.2", + "signal-exit": "^3.0.3", + "strip-final-newline": "^2.0.0" + } + }, + "get-stream": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", + "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", + "dev": true + }, + "human-signals": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", + "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "dev": true + }, + "supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } + } + }, + "listr2": { + "version": "3.13.5", + "resolved": "https://registry.npmjs.org/listr2/-/listr2-3.13.5.tgz", + "integrity": "sha512-3n8heFQDSk+NcwBn3CgxEibZGaRzx+pC64n3YjpMD1qguV4nWus3Al+Oo3KooqFKTQEJ1v7MmnbnyyNspgx3NA==", + "dev": true, + "requires": { + "cli-truncate": "^2.1.0", + "colorette": "^2.0.16", + "log-update": "^4.0.0", + "p-map": "^4.0.0", + "rfdc": "^1.3.0", + "rxjs": "^7.4.0", + "through": "^2.3.8", + "wrap-ansi": "^7.0.0" + }, + "dependencies": { + "colorette": { + "version": "2.0.16", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.16.tgz", + "integrity": "sha512-hUewv7oMjCp+wkBv5Rm0v87eJhq4woh5rSR+42YSQJKecCqgIqNkZ6lAlQms/BwHPJA5NKMRlpxPRv0n8HQW6g==", + "dev": true + } + } + }, + "log-update": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/log-update/-/log-update-4.0.0.tgz", + "integrity": "sha512-9fkkDevMefjg0mmzWFBW8YkFP91OrizzkW3diF7CpG+S2EYdy4+TVfGwz1zeF8x7hCx1ovSPTOE9Ngib74qqUg==", + "dev": true, + "requires": { + "ansi-escapes": "^4.3.0", + "cli-cursor": "^3.1.0", + "slice-ansi": "^4.0.0", + "wrap-ansi": "^6.2.0" + }, + "dependencies": { + "slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + } + }, + "wrap-ansi": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", + "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + } + } + } + }, + "merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "dev": true + }, + "micromatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", + "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", + "dev": true, + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.2.3" + } + }, + "mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "dev": true + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "dev": true + }, + "npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, + "requires": { + "path-key": "^3.0.0" + } + }, + "onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "dev": true, + "requires": { + "mimic-fn": "^2.1.0" + } + }, + "p-map": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", + "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", + "dev": true, + "requires": { + "aggregate-error": "^3.0.0" + } + }, + "parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "requires": { + "callsites": "^3.0.0" + } + }, + "parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + } + }, + "path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true + }, + "path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true + }, + "picomatch": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.0.tgz", + "integrity": "sha512-lY1Q/PiJGC2zOv/z391WOTD+Z02bCgsFfvxoXXf6h7kv9o+WmsmzYqrAwY63sNgOxE4xEdq0WyUnXfKeBrSvYw==", + "dev": true + }, + "please-upgrade-node": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz", + "integrity": "sha512-gQR3WpIgNIKwBMVLkpMUeR3e1/E1y42bqDQZfql+kDeXd8COYfM8PQA4X6y7a8u9Ua9FHmsrrmirW2vHs45hWg==", + "dev": true, + "requires": { + "semver-compare": "^1.0.0" + } + }, + "prettier": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.5.1.tgz", + "integrity": "sha512-vBZcPRUR5MZJwoyi3ZoyQlc1rXeEck8KgeC9AwwOn+exuxLxq5toTRDTSaVrXHxelDMHy9zlicw8u66yxoSUFg==", + "dev": true + }, + "resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true + }, + "restore-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", + "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "dev": true, + "requires": { + "onetime": "^5.1.0", + "signal-exit": "^3.0.2" + } + }, + "rfdc": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.3.0.tgz", + "integrity": "sha512-V2hovdzFbOi77/WajaSMXk2OLm+xNIeQdMMuB7icj7bk6zi2F8GGAxigcnDFpJHbNyNcgyJDiP+8nOrY5cZGrA==", + "dev": true + }, + "rxjs": { + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.4.0.tgz", + "integrity": "sha512-7SQDi7xeTMCJpqViXh8gL/lebcwlp3d831F05+9B44A4B0WfsEwUQHR64gsH1kvJ+Ep/J9K2+n1hVl1CsGN23w==", + "dev": true, + "requires": { + "tslib": "~2.1.0" + } + }, + "semver-compare": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/semver-compare/-/semver-compare-1.0.0.tgz", + "integrity": "sha1-De4hahyUGrN+nvsXiPavxf9VN/w=", + "dev": true + }, + "shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "requires": { + "shebang-regex": "^3.0.0" + } + }, + "shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true + }, + "signal-exit": { + "version": "3.0.6", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.6.tgz", + "integrity": "sha512-sDl4qMFpijcGw22U5w63KmD3cZJfBuFlVNbVMKje2keoKML7X2UzWbc4XrmEbDwg0NXJc3yv4/ox7b+JWb57kQ==", + "dev": true + }, + "slice-ansi": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-3.0.0.tgz", + "integrity": "sha512-pSyv7bSTC7ig9Dcgbw9AuRNUb5k5V6oDudjZoMBSr13qpLBG7tB+zgCkARjq7xIUgdz5P1Qe8u+rSGdouOOIyQ==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + } + }, + "string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true + }, + "string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "requires": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + } + }, + "stringify-object": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", + "integrity": "sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==", + "dev": true, + "requires": { + "get-own-enumerable-property-symbols": "^3.0.0", + "is-obj": "^1.0.1", + "is-regexp": "^1.0.0" + } + }, + "strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "requires": { + "ansi-regex": "^5.0.1" + } + }, + "strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "dev": true + }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + }, + "through": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", + "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=", + "dev": true + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "requires": { + "is-number": "^7.0.0" + } + }, + "tslib": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.1.0.tgz", + "integrity": "sha512-hcVC3wYEziELGGmEEXue7D75zbwIIVUMWAVbHItGPx0ziyXxrOMQx4rQEVEV45Ut/1IotuEvwqPopzIOkDMf0A==", + "dev": true + }, + "type-fest": { + "version": "0.21.3", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", + "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "dev": true + }, + "which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "requires": { + "isexe": "^2.0.0" + } + }, + "wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + } + }, + "yaml": { + "version": "1.10.2", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", + "integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==", + "dev": true + } + } + }, "emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", diff --git a/package.json b/package.json index 7471968dd7a..12bc33f397e 100644 --- a/package.json +++ b/package.json @@ -25,5 +25,8 @@ "*.{css,json,md,scss,yaml,yml}": [ "prettier --write" ] + }, + "dependencies": { + "docs": "file:" } } diff --git a/yarn.lock b/yarn.lock index b1958cce17c..3875110b14b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3,34 +3,34 @@ "@babel/code-frame@^7.0.0": - version "7.16.7" - resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.16.7.tgz#44416b6bd7624b998f5b1af5d470856c40138789" - integrity sha512-iAXqUn8IIeBTNd72xsFlgaXHkMBMt6y4HJp1tIaK465CWLT/fG1aqB7ykr95gHHmlBdGbFeWWfyB4NJJ0nmeIg== + version "7.16.0" + resolved "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.16.0.tgz" + integrity sha512-IF4EOMEV+bfYwOmNxGzSnjR2EmQod7f1UXOpZM3l4i4o4QNwzjtJAu/HxdjHq0aYBvdqMuQEY1eg0nqW9ZPORA== dependencies: - "@babel/highlight" "^7.16.7" + "@babel/highlight" "^7.16.0" -"@babel/helper-validator-identifier@^7.16.7": - version "7.16.7" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.16.7.tgz#e8c602438c4a8195751243da9031d1607d247cad" - integrity sha512-hsEnFemeiW4D08A5gUAZxLBTXpZ39P+a+DGDsHw1yxqyQ/jzFEnxf5uTEGp+3bzAbNOxU1paTgYS4ECU/IgfDw== +"@babel/helper-validator-identifier@^7.15.7": + version "7.15.7" + resolved "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.15.7.tgz" + integrity sha512-K4JvCtQqad9OY2+yTU8w+E82ywk/fe+ELNlt1G8z3bVGlZfn/hOcQQsUhGhW/N+tb3fxK800wLtKOE/aM0m72w== -"@babel/highlight@^7.16.7": - version "7.16.10" - resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.16.10.tgz#744f2eb81579d6eea753c227b0f570ad785aba88" - integrity sha512-5FnTQLSLswEj6IkgVw5KusNUUFY9ZGqe/TRFnP/BKYHYgfh7tc+C7mwiy95/yNP7Dh9x580Vv8r7u7ZfTBFxdw== +"@babel/highlight@^7.16.0": + version "7.16.0" + resolved "https://registry.npmjs.org/@babel/highlight/-/highlight-7.16.0.tgz" + integrity sha512-t8MH41kUQylBtu2+4IQA3atqevA2lRgqA2wyVB/YiWmsDSuylZZuXOUy9ric30hfzauEFfdsuk/eXTRrGrfd0g== dependencies: - "@babel/helper-validator-identifier" "^7.16.7" + "@babel/helper-validator-identifier" "^7.15.7" chalk "^2.0.0" js-tokens "^4.0.0" "@types/parse-json@^4.0.0": version "4.0.0" - resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.0.tgz#2f8bb441434d163b35fb8ffdccd7138927ffb8c0" + resolved "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.0.tgz" integrity sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA== aggregate-error@^3.0.0: version "3.1.0" - resolved "https://registry.yarnpkg.com/aggregate-error/-/aggregate-error-3.1.0.tgz#92670ff50f5359bdb7a3e0d40d0ec30c5737687a" + resolved "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz" integrity sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA== dependencies: clean-stack "^2.0.0" @@ -38,55 +38,55 @@ aggregate-error@^3.0.0: ansi-colors@^4.1.1: version "4.1.1" - resolved "https://registry.yarnpkg.com/ansi-colors/-/ansi-colors-4.1.1.tgz#cbb9ae256bf750af1eab344f229aa27fe94ba348" + resolved "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz" integrity sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA== ansi-escapes@^4.3.0: version "4.3.2" - resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-4.3.2.tgz#6b2291d1db7d98b6521d5f1efa42d0f3a9feb65e" + resolved "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz" integrity sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ== dependencies: type-fest "^0.21.3" ansi-regex@^5.0.1: version "5.0.1" - resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" + resolved "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz" integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== ansi-styles@^3.2.1: version "3.2.1" - resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" + resolved "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz" integrity sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== dependencies: color-convert "^1.9.0" ansi-styles@^4.0.0, ansi-styles@^4.1.0: version "4.3.0" - resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" + resolved "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz" integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== dependencies: color-convert "^2.0.1" astral-regex@^2.0.0: version "2.0.0" - resolved "https://registry.yarnpkg.com/astral-regex/-/astral-regex-2.0.0.tgz#483143c567aeed4785759c0865786dc77d7d2e31" + resolved "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz" integrity sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ== braces@^3.0.1: version "3.0.2" - resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107" + resolved "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz" integrity sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A== dependencies: fill-range "^7.0.1" callsites@^3.0.0: version "3.1.0" - resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" + resolved "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz" integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ== chalk@^2.0.0: version "2.4.2" - resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" + resolved "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz" integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== dependencies: ansi-styles "^3.2.1" @@ -95,7 +95,7 @@ chalk@^2.0.0: chalk@^3.0.0: version "3.0.0" - resolved "https://registry.yarnpkg.com/chalk/-/chalk-3.0.0.tgz#3f73c2bf526591f574cc492c51e2456349f844e4" + resolved "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz" integrity sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg== dependencies: ansi-styles "^4.1.0" @@ -103,19 +103,19 @@ chalk@^3.0.0: clean-stack@^2.0.0: version "2.2.0" - resolved "https://registry.yarnpkg.com/clean-stack/-/clean-stack-2.2.0.tgz#ee8472dbb129e727b31e8a10a427dee9dfe4008b" + resolved "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz" integrity sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A== cli-cursor@^3.1.0: version "3.1.0" - resolved "https://registry.yarnpkg.com/cli-cursor/-/cli-cursor-3.1.0.tgz#264305a7ae490d1d03bf0c9ba7c925d1753af307" + resolved "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz" integrity sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw== dependencies: restore-cursor "^3.1.0" -cli-truncate@2.1.0, cli-truncate@^2.1.0: +cli-truncate@^2.1.0, cli-truncate@2.1.0: version "2.1.0" - resolved "https://registry.yarnpkg.com/cli-truncate/-/cli-truncate-2.1.0.tgz#c39e28bf05edcde5be3b98992a22deed5a2b93c7" + resolved "https://registry.npmjs.org/cli-truncate/-/cli-truncate-2.1.0.tgz" integrity sha512-n8fOixwDD6b/ObinzTrp1ZKFzbgvKZvuz/TvejnLn1aQfC6r52XEx85FmuC+3HI+JM7coBRXUvNqEU2PHVrHpg== dependencies: slice-ansi "^3.0.0" @@ -123,46 +123,46 @@ cli-truncate@2.1.0, cli-truncate@^2.1.0: color-convert@^1.9.0: version "1.9.3" - resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8" + resolved "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz" integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== dependencies: color-name "1.1.3" color-convert@^2.0.1: version "2.0.1" - resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + resolved "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz" integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== dependencies: color-name "~1.1.4" -color-name@1.1.3: - version "1.1.3" - resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" - integrity sha1-p9BVi9icQveV3UIyj3QIMcpTvCU= - color-name@~1.1.4: version "1.1.4" - resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz" integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz" + integrity sha1-p9BVi9icQveV3UIyj3QIMcpTvCU= + colorette@^1.4.0: version "1.4.0" - resolved "https://registry.yarnpkg.com/colorette/-/colorette-1.4.0.tgz#5190fbb87276259a86ad700bff2c6d6faa3fca40" + resolved "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz" integrity sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g== colorette@^2.0.16: version "2.0.16" - resolved "https://registry.yarnpkg.com/colorette/-/colorette-2.0.16.tgz#713b9af84fdb000139f04546bd4a93f62a5085da" + resolved "https://registry.npmjs.org/colorette/-/colorette-2.0.16.tgz" integrity sha512-hUewv7oMjCp+wkBv5Rm0v87eJhq4woh5rSR+42YSQJKecCqgIqNkZ6lAlQms/BwHPJA5NKMRlpxPRv0n8HQW6g== commander@^8.2.0: version "8.3.0" - resolved "https://registry.yarnpkg.com/commander/-/commander-8.3.0.tgz#4837ea1b2da67b9c616a67afbb0fafee567bca66" + resolved "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz" integrity sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww== cosmiconfig@^7.0.1: version "7.0.1" - resolved "https://registry.yarnpkg.com/cosmiconfig/-/cosmiconfig-7.0.1.tgz#714d756522cace867867ccb4474c5d01bbae5d6d" + resolved "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-7.0.1.tgz" integrity sha512-a1YWNUV2HwGimB7dU2s1wUMurNKjpx60HxBB6xUM8Re+2s1g1IIfJvFR0/iCF+XHdE0GMTKTuLR32UQff4TEyQ== dependencies: "@types/parse-json" "^4.0.0" @@ -173,7 +173,7 @@ cosmiconfig@^7.0.1: cross-spawn@^7.0.3: version "7.0.3" - resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6" + resolved "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz" integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w== dependencies: path-key "^3.1.0" @@ -182,38 +182,43 @@ cross-spawn@^7.0.3: debug@^4.3.2: version "4.3.3" - resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.3.tgz#04266e0b70a98d4462e6e288e38259213332b664" + resolved "https://registry.npmjs.org/debug/-/debug-4.3.3.tgz" integrity sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q== dependencies: ms "2.1.2" +"docs@file:": + resolved "file:" + dependencies: + docs "file:" + emoji-regex@^8.0.0: version "8.0.0" - resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + resolved "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz" integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== -enquirer@^2.3.6: +enquirer@^2.3.6, "enquirer@>= 2.3.0 < 3": version "2.3.6" - resolved "https://registry.yarnpkg.com/enquirer/-/enquirer-2.3.6.tgz#2a7fe5dd634a1e4125a975ec994ff5456dc3734d" + resolved "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz" integrity sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg== dependencies: ansi-colors "^4.1.1" error-ex@^1.3.1: version "1.3.2" - resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.2.tgz#b4ac40648107fdcdcfae242f428bea8a14d4f1bf" + resolved "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz" integrity sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g== dependencies: is-arrayish "^0.2.1" escape-string-regexp@^1.0.5: version "1.0.5" - resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + resolved "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz" integrity sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ= execa@^5.1.1: version "5.1.1" - resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" + resolved "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz" integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== dependencies: cross-spawn "^7.0.3" @@ -228,44 +233,44 @@ execa@^5.1.1: fill-range@^7.0.1: version "7.0.1" - resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.0.1.tgz#1919a6a7c75fe38b2c7c77e5198535da9acdda40" + resolved "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz" integrity sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ== dependencies: to-regex-range "^5.0.1" get-own-enumerable-property-symbols@^3.0.0: version "3.0.2" - resolved "https://registry.yarnpkg.com/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz#b5fde77f22cbe35f390b4e089922c50bce6ef664" + resolved "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz" integrity sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g== get-stream@^6.0.0: version "6.0.1" - resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-6.0.1.tgz#a262d8eef67aced57c2852ad6167526a43cbf7b7" + resolved "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz" integrity sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== has-flag@^3.0.0: version "3.0.0" - resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd" + resolved "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz" integrity sha1-tdRU3CGZriJWmfNGfloH87lVuv0= has-flag@^4.0.0: version "4.0.0" - resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" + resolved "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz" integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== human-signals@^2.1.0: version "2.1.0" - resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" + resolved "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz" integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== husky@^7.0.4: version "7.0.4" - resolved "https://registry.yarnpkg.com/husky/-/husky-7.0.4.tgz#242048245dc49c8fb1bf0cc7cfb98dd722531535" + resolved "https://registry.npmjs.org/husky/-/husky-7.0.4.tgz" integrity sha512-vbaCKN2QLtP/vD4yvs6iz6hBEo6wkSzs8HpRah1Z6aGmF2KW5PdYuAd7uX5a+OyBZHBhd+TFLqgjUgytQr4RvQ== import-fresh@^3.2.1: version "3.3.0" - resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-3.3.0.tgz#37162c25fcb9ebaa2e6e53d5b4d88ce17d9e0c2b" + resolved "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz" integrity sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw== dependencies: parent-module "^1.0.0" @@ -273,62 +278,62 @@ import-fresh@^3.2.1: indent-string@^4.0.0: version "4.0.0" - resolved "https://registry.yarnpkg.com/indent-string/-/indent-string-4.0.0.tgz#624f8f4497d619b2d9768531d58f4122854d7251" + resolved "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz" integrity sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg== is-arrayish@^0.2.1: version "0.2.1" - resolved "https://registry.yarnpkg.com/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d" + resolved "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz" integrity sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0= is-fullwidth-code-point@^3.0.0: version "3.0.0" - resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + resolved "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz" integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== is-number@^7.0.0: version "7.0.0" - resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + resolved "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz" integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== is-obj@^1.0.1: version "1.0.1" - resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-1.0.1.tgz#3e4729ac1f5fde025cd7d83a896dab9f4f67db0f" + resolved "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz" integrity sha1-PkcprB9f3gJc19g6iW2rn09n2w8= is-regexp@^1.0.0: version "1.0.0" - resolved "https://registry.yarnpkg.com/is-regexp/-/is-regexp-1.0.0.tgz#fd2d883545c46bac5a633e7b9a09e87fa2cb5069" + resolved "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz" integrity sha1-/S2INUXEa6xaYz57mgnof6LLUGk= is-stream@^2.0.0: version "2.0.1" - resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077" + resolved "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz" integrity sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg== isexe@^2.0.0: version "2.0.0" - resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + resolved "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz" integrity sha1-6PvzdNxVb/iUehDcsFctYz8s+hA= js-tokens@^4.0.0: version "4.0.0" - resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" + resolved "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz" integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== json-parse-even-better-errors@^2.3.0: version "2.3.1" - resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d" + resolved "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz" integrity sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w== lines-and-columns@^1.1.6: version "1.2.4" - resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" + resolved "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz" integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== lint-staged@11.2.6: version "11.2.6" - resolved "https://registry.yarnpkg.com/lint-staged/-/lint-staged-11.2.6.tgz#f477b1af0294db054e5937f171679df63baa4c43" + resolved "https://registry.npmjs.org/lint-staged/-/lint-staged-11.2.6.tgz" integrity sha512-Vti55pUnpvPE0J9936lKl0ngVeTdSZpEdTNhASbkaWX7J5R9OEifo1INBGQuGW4zmy6OG+TcWPJ3m5yuy5Q8Tg== dependencies: cli-truncate "2.1.0" @@ -347,22 +352,22 @@ lint-staged@11.2.6: supports-color "8.1.1" listr2@^3.12.2: - version "3.14.0" - resolved "https://registry.yarnpkg.com/listr2/-/listr2-3.14.0.tgz#23101cc62e1375fd5836b248276d1d2b51fdbe9e" - integrity sha512-TyWI8G99GX9GjE54cJ+RrNMcIFBfwMPxc3XTFiAYGN4s10hWROGtOg7+O6u6LE3mNkyld7RSLE6nrKBvTfcs3g== + version "3.13.5" + resolved "https://registry.npmjs.org/listr2/-/listr2-3.13.5.tgz" + integrity sha512-3n8heFQDSk+NcwBn3CgxEibZGaRzx+pC64n3YjpMD1qguV4nWus3Al+Oo3KooqFKTQEJ1v7MmnbnyyNspgx3NA== dependencies: cli-truncate "^2.1.0" colorette "^2.0.16" log-update "^4.0.0" p-map "^4.0.0" rfdc "^1.3.0" - rxjs "^7.5.1" + rxjs "^7.4.0" through "^2.3.8" wrap-ansi "^7.0.0" log-update@^4.0.0: version "4.0.0" - resolved "https://registry.yarnpkg.com/log-update/-/log-update-4.0.0.tgz#589ecd352471f2a1c0c570287543a64dfd20e0a1" + resolved "https://registry.npmjs.org/log-update/-/log-update-4.0.0.tgz" integrity sha512-9fkkDevMefjg0mmzWFBW8YkFP91OrizzkW3diF7CpG+S2EYdy4+TVfGwz1zeF8x7hCx1ovSPTOE9Ngib74qqUg== dependencies: ansi-escapes "^4.3.0" @@ -372,12 +377,12 @@ log-update@^4.0.0: merge-stream@^2.0.0: version "2.0.0" - resolved "https://registry.yarnpkg.com/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60" + resolved "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz" integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== micromatch@^4.0.4: version "4.0.4" - resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.4.tgz#896d519dfe9db25fce94ceb7a500919bf881ebf9" + resolved "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz" integrity sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg== dependencies: braces "^3.0.1" @@ -385,50 +390,50 @@ micromatch@^4.0.4: mimic-fn@^2.1.0: version "2.1.0" - resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" + resolved "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz" integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== ms@2.1.2: version "2.1.2" - resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009" + resolved "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz" integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w== normalize-path@^3.0.0: version "3.0.0" - resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" + resolved "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz" integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== npm-run-path@^4.0.1: version "4.0.1" - resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-4.0.1.tgz#b7ecd1e5ed53da8e37a55e1c2269e0b97ed748ea" + resolved "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz" integrity sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw== dependencies: path-key "^3.0.0" onetime@^5.1.0, onetime@^5.1.2: version "5.1.2" - resolved "https://registry.yarnpkg.com/onetime/-/onetime-5.1.2.tgz#d0e96ebb56b07476df1dd9c4806e5237985ca45e" + resolved "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz" integrity sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg== dependencies: mimic-fn "^2.1.0" p-map@^4.0.0: version "4.0.0" - resolved "https://registry.yarnpkg.com/p-map/-/p-map-4.0.0.tgz#bb2f95a5eda2ec168ec9274e06a747c3e2904d2b" + resolved "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz" integrity sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ== dependencies: aggregate-error "^3.0.0" parent-module@^1.0.0: version "1.0.1" - resolved "https://registry.yarnpkg.com/parent-module/-/parent-module-1.0.1.tgz#691d2709e78c79fae3a156622452d00762caaaa2" + resolved "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz" integrity sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g== dependencies: callsites "^3.0.0" parse-json@^5.0.0: version "5.2.0" - resolved "https://registry.yarnpkg.com/parse-json/-/parse-json-5.2.0.tgz#c76fc66dee54231c962b22bcc8a72cf2f99753cd" + resolved "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz" integrity sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg== dependencies: "@babel/code-frame" "^7.0.0" @@ -438,39 +443,39 @@ parse-json@^5.0.0: path-key@^3.0.0, path-key@^3.1.0: version "3.1.1" - resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" + resolved "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz" integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== path-type@^4.0.0: version "4.0.0" - resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" + resolved "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz" integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== picomatch@^2.2.3: - version "2.3.1" - resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" - integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + version "2.3.0" + resolved "https://registry.npmjs.org/picomatch/-/picomatch-2.3.0.tgz" + integrity sha512-lY1Q/PiJGC2zOv/z391WOTD+Z02bCgsFfvxoXXf6h7kv9o+WmsmzYqrAwY63sNgOxE4xEdq0WyUnXfKeBrSvYw== please-upgrade-node@^3.2.0: version "3.2.0" - resolved "https://registry.yarnpkg.com/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz#aeddd3f994c933e4ad98b99d9a556efa0e2fe942" + resolved "https://registry.npmjs.org/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz" integrity sha512-gQR3WpIgNIKwBMVLkpMUeR3e1/E1y42bqDQZfql+kDeXd8COYfM8PQA4X6y7a8u9Ua9FHmsrrmirW2vHs45hWg== dependencies: semver-compare "^1.0.0" prettier@^2.5.1: version "2.5.1" - resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.5.1.tgz#fff75fa9d519c54cf0fce328c1017d94546bc56a" + resolved "https://registry.npmjs.org/prettier/-/prettier-2.5.1.tgz" integrity sha512-vBZcPRUR5MZJwoyi3ZoyQlc1rXeEck8KgeC9AwwOn+exuxLxq5toTRDTSaVrXHxelDMHy9zlicw8u66yxoSUFg== resolve-from@^4.0.0: version "4.0.0" - resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" + resolved "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz" integrity sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== restore-cursor@^3.1.0: version "3.1.0" - resolved "https://registry.yarnpkg.com/restore-cursor/-/restore-cursor-3.1.0.tgz#39f67c54b3a7a58cea5236d95cf0034239631f7e" + resolved "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz" integrity sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA== dependencies: onetime "^5.1.0" @@ -478,41 +483,41 @@ restore-cursor@^3.1.0: rfdc@^1.3.0: version "1.3.0" - resolved "https://registry.yarnpkg.com/rfdc/-/rfdc-1.3.0.tgz#d0b7c441ab2720d05dc4cf26e01c89631d9da08b" + resolved "https://registry.npmjs.org/rfdc/-/rfdc-1.3.0.tgz" integrity sha512-V2hovdzFbOi77/WajaSMXk2OLm+xNIeQdMMuB7icj7bk6zi2F8GGAxigcnDFpJHbNyNcgyJDiP+8nOrY5cZGrA== -rxjs@^7.5.1: - version "7.5.4" - resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-7.5.4.tgz#3d6bd407e6b7ce9a123e76b1e770dc5761aa368d" - integrity sha512-h5M3Hk78r6wAheJF0a5YahB1yRQKCsZ4MsGdZ5O9ETbVtjPcScGfrMmoOq7EBsCRzd4BDkvDJ7ogP8Sz5tTFiQ== +rxjs@^7.4.0: + version "7.4.0" + resolved "https://registry.npmjs.org/rxjs/-/rxjs-7.4.0.tgz" + integrity sha512-7SQDi7xeTMCJpqViXh8gL/lebcwlp3d831F05+9B44A4B0WfsEwUQHR64gsH1kvJ+Ep/J9K2+n1hVl1CsGN23w== dependencies: - tslib "^2.1.0" + tslib "~2.1.0" semver-compare@^1.0.0: version "1.0.0" - resolved "https://registry.yarnpkg.com/semver-compare/-/semver-compare-1.0.0.tgz#0dee216a1c941ab37e9efb1788f6afc5ff5537fc" + resolved "https://registry.npmjs.org/semver-compare/-/semver-compare-1.0.0.tgz" integrity sha1-De4hahyUGrN+nvsXiPavxf9VN/w= shebang-command@^2.0.0: version "2.0.0" - resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea" + resolved "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz" integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== dependencies: shebang-regex "^3.0.0" shebang-regex@^3.0.0: version "3.0.0" - resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" + resolved "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz" integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== signal-exit@^3.0.2, signal-exit@^3.0.3: - version "3.0.7" - resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9" - integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== + version "3.0.6" + resolved "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.6.tgz" + integrity sha512-sDl4qMFpijcGw22U5w63KmD3cZJfBuFlVNbVMKje2keoKML7X2UzWbc4XrmEbDwg0NXJc3yv4/ox7b+JWb57kQ== slice-ansi@^3.0.0: version "3.0.0" - resolved "https://registry.yarnpkg.com/slice-ansi/-/slice-ansi-3.0.0.tgz#31ddc10930a1b7e0b67b08c96c2f49b77a789787" + resolved "https://registry.npmjs.org/slice-ansi/-/slice-ansi-3.0.0.tgz" integrity sha512-pSyv7bSTC7ig9Dcgbw9AuRNUb5k5V6oDudjZoMBSr13qpLBG7tB+zgCkARjq7xIUgdz5P1Qe8u+rSGdouOOIyQ== dependencies: ansi-styles "^4.0.0" @@ -521,7 +526,7 @@ slice-ansi@^3.0.0: slice-ansi@^4.0.0: version "4.0.0" - resolved "https://registry.yarnpkg.com/slice-ansi/-/slice-ansi-4.0.0.tgz#500e8dd0fd55b05815086255b3195adf2a45fe6b" + resolved "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz" integrity sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ== dependencies: ansi-styles "^4.0.0" @@ -530,12 +535,12 @@ slice-ansi@^4.0.0: string-argv@0.3.1: version "0.3.1" - resolved "https://registry.yarnpkg.com/string-argv/-/string-argv-0.3.1.tgz#95e2fbec0427ae19184935f816d74aaa4c5c19da" + resolved "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz" integrity sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg== string-width@^4.1.0, string-width@^4.2.0: version "4.2.3" - resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" + resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz" integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== dependencies: emoji-regex "^8.0.0" @@ -544,7 +549,7 @@ string-width@^4.1.0, string-width@^4.2.0: stringify-object@3.3.0: version "3.3.0" - resolved "https://registry.yarnpkg.com/stringify-object/-/stringify-object-3.3.0.tgz#703065aefca19300d3ce88af4f5b3956d7556629" + resolved "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz" integrity sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw== dependencies: get-own-enumerable-property-symbols "^3.0.0" @@ -553,69 +558,69 @@ stringify-object@3.3.0: strip-ansi@^6.0.0, strip-ansi@^6.0.1: version "6.0.1" - resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" + resolved "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz" integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== dependencies: ansi-regex "^5.0.1" strip-final-newline@^2.0.0: version "2.0.0" - resolved "https://registry.yarnpkg.com/strip-final-newline/-/strip-final-newline-2.0.0.tgz#89b852fb2fcbe936f6f4b3187afb0a12c1ab58ad" + resolved "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz" integrity sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA== -supports-color@8.1.1: - version "8.1.1" - resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c" - integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== - dependencies: - has-flag "^4.0.0" - supports-color@^5.3.0: version "5.5.0" - resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" + resolved "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz" integrity sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== dependencies: has-flag "^3.0.0" supports-color@^7.1.0: version "7.2.0" - resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da" + resolved "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz" integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw== dependencies: has-flag "^4.0.0" +supports-color@8.1.1: + version "8.1.1" + resolved "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz" + integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== + dependencies: + has-flag "^4.0.0" + through@^2.3.8: version "2.3.8" - resolved "https://registry.yarnpkg.com/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5" + resolved "https://registry.npmjs.org/through/-/through-2.3.8.tgz" integrity sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU= to-regex-range@^5.0.1: version "5.0.1" - resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + resolved "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz" integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== dependencies: is-number "^7.0.0" -tslib@^2.1.0: - version "2.3.1" - resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.3.1.tgz#e8a335add5ceae51aa261d32a490158ef042ef01" - integrity sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw== +tslib@~2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/tslib/-/tslib-2.1.0.tgz" + integrity sha512-hcVC3wYEziELGGmEEXue7D75zbwIIVUMWAVbHItGPx0ziyXxrOMQx4rQEVEV45Ut/1IotuEvwqPopzIOkDMf0A== type-fest@^0.21.3: version "0.21.3" - resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37" + resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz" integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w== which@^2.0.1: version "2.0.2" - resolved "https://registry.yarnpkg.com/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1" + resolved "https://registry.npmjs.org/which/-/which-2.0.2.tgz" integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== dependencies: isexe "^2.0.0" wrap-ansi@^6.2.0: version "6.2.0" - resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" + resolved "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz" integrity sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA== dependencies: ansi-styles "^4.0.0" @@ -624,7 +629,7 @@ wrap-ansi@^6.2.0: wrap-ansi@^7.0.0: version "7.0.0" - resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" + resolved "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz" integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== dependencies: ansi-styles "^4.0.0" @@ -633,5 +638,5 @@ wrap-ansi@^7.0.0: yaml@^1.10.0: version "1.10.2" - resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" + resolved "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz" integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==