copy staging to beta

agora-analytics/reference/pricing.mdx → agora-analytics/overview/pricing.mdx

@@ -1,6 +1,6 @@
 ---
 title: 'Pricing'
-sidebar_position: 1
+sidebar_position: 3
 platform_selector: false
 description: >
   Provides you with information on billing, fee deductions, free-of-charge policy, and any suspension to your account based on the account type.

agora-analytics/overview/product-overview.mdx

@@ -10,7 +10,7 @@ description: >
 <ProductOverview
     title="Analytics"
     img="/images/analytics/analytics-overview.png"
-    apiQuickStartLink="/agora-analytics/analyze/video-voice-sdk/call-search"
+    quickStartLink="/agora-analytics/analyze/video-voice-sdk/call-search"
     apiReferenceLink="/api-reference"
 
     productFeatures={[

agora-analytics/reference/release-notes.mdx → agora-analytics/overview/release-notes.mdx

@@ -1,6 +1,6 @@
 ---
 title: 'Release notes'
-sidebar_position: 2.5
+sidebar_position: 4
 type: docs
 platform_selector: false
 description: >

agora-analytics/reference/supported-platforms.mdx → agora-analytics/overview/supported-platforms.mdx

@@ -1,10 +1,10 @@
 ---
 title: 'Supported platforms'
-sidebar_position: 6
+sidebar_position: 5
 type: docs
 platform_selector: false
 description: >
-  A list of terms used in Agora documentation.
+  A list of platforms supported by Agora Analytics.
 ---
 
 import SupportedPlatform from '@docs/shared/common/_supported-platforms.mdx';

agora-chat/get-started/get-started-uikit.mdx

@@ -1,5 +1,5 @@
 ---
-title: 'UI Samples quickstart'
+title: 'UI Kit quickstart'
 sidebar_position: 2
 type: docs
 description: >

agora-chat/reference/release-notes.mdx → agora-chat/overview/release-notes.mdx

@@ -1,6 +1,6 @@
 ---
 title: 'Release notes'
-sidebar_position: 1
+sidebar_position: 4
 type: docs
 description: >
   Provides release notes of Agora Chat.

agora-chat/reference/supported-platforms.mdx → agora-chat/overview/supported-platforms.mdx

@@ -1,6 +1,6 @@
 ---
 title: 'Supported platforms'
-sidebar_position: 2
+sidebar_position: 5
 type: docs
 description: >
   Lists the platform that Chat supports.

assets/code/signaling/storage/set-channel-metadata.mdx

@@ -70,7 +70,7 @@
     - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage">RtmStorage</Link>
         - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/createmetadata()">createMetadata()</Link>
         - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmmetadata/setmetadataitem(_:)">setMetadataItem(_:)</Link>
-        - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
+        - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
         - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/setmetadata(forchannel:data:options:lock:)">setMetadata(forChannel:data:options:lock​:)</Link>
         - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/setmetadata(forchannel:data:options:lock:completion:)">setMetadata(forChannel:data:options:lock​:completion:)</Link>
     </PlatformWrapper>
@@ -83,7 +83,7 @@
     - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage">RtmStorage</Link>
         - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/createmetadata()">createMetadata()</Link>
         - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmmetadata/setmetadataitem(_:)">setMetadataItem(_:)</Link>
-        - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
+        - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
         - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/setmetadata(forchannel:data:options:lock:)">setMetadata(forChannel:data:options:lock​:)</Link>
         - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/setmetadata(forchannel:data:options:lock:completion:)">setMetadata(forChannel:data:options:lock​:completion:)</Link>
     </PlatformWrapper>

assets/code/signaling/storage/set-user-metadata.mdx

@@ -46,14 +46,14 @@
     <PlatformWrapper platform="ios">
       - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/createmetadata()">createMetadata()</Link>
       - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmmetadata/setmetadataitem(_:)">setMetadataItem(_:)</Link>
-      - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
+      - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
       - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/setmetadata(foruser:data:options:)">setMetadata(forUser:data:options:)</Link>
       - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/setmetadata(foruser:data:options:completion:)">setMetadata(forUser:data:options:completion:)</Link>
     </PlatformWrapper>
     <PlatformWrapper platform="macos">
       - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/createmetadata()">createMetadata()</Link>
       - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmmetadata/setmetadataitem(_:)">setMetadataItem(_:)</Link>
-      - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
+      - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
       - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/setmetadata(foruser:data:options:)">setMetadata(forUser:data:options:)</Link>
       - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/setmetadata(foruser:data:options:completion:)">setMetadata(forUser:data:options:completion:)</Link>
     </PlatformWrapper>

assets/code/signaling/storage/update-user-metadata.mdx

@@ -47,14 +47,14 @@
     <PlatformWrapper platform="ios">
     - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/createmetadata()">createMetadata()</Link>
     - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmmetadata/setmetadataitem(_:)">setMetadataItem(_:)</Link>
-    - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
+    - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
     - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/updatemetadata(foruser:data:options:)">updateMetadata(forUser:data:options:)</Link>
     - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstorage/updatemetadata(foruser:data:options:completion:)">updateMetadata(forUser:data:options:completion:)</Link>
     </PlatformWrapper>
     <PlatformWrapper platform="macos">
     - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/createmetadata()">createMetadata()</Link>
     - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmmetadata/setmetadataitem(_:)">setMetadataItem(_:)</Link>
-    - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
+    - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmmetadataitem/init(key:value:revision:)">RtmMetadataItem(key:value:revision:)</Link>
     - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/updatemetadata(foruser:data:options:)">updateMetadata(forUser:data:options:)</Link>
     - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstorage/updatemetadata(foruser:data:options:completion:)">updateMetadata(forUser:data:options:completion:)</Link>
     </PlatformWrapper>

assets/code/signaling/stream-channel/publish-message.mdx

@@ -31,12 +31,12 @@
 
     <PlatformWrapper platform="ios">
     - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstreamchannel/publishtopicmessage(message:intopic:with:)">publishTopicMessage(message:inTopic:with:)</Link>
-    - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstreamchannel/publishtopicmessage(message:intopic:with:completion:)">publishTopicMessage(message:inTopic:with:completion:)</Link>
+    - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmstreamchannel/publishtopicmessage(_:in:with:completion:)">publishTopicMessage(_:in:with:completion:)</Link>
     - <Link to="{{Global.SIG2_SDK_API_IOS}}/rtmpublishoptions">RtmPublishOptions</Link>
     </PlatformWrapper>
     <PlatformWrapper platform="macos">
     - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstreamchannel/publishtopicmessage(message:intopic:with:)">publishTopicMessage(message:inTopic:with:)</Link>
-    - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstreamchannel/publishtopicmessage(message:intopic:with:completion:)">publishTopicMessage(message:inTopic:with:completion:)</Link>
+    - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmstreamchannel/publishtopicmessage(_:in:with:completion:)">publishTopicMessage(_:in:with:completion:)</Link>
     - <Link to="{{Global.SIG2_SDK_API_MACOS}}/rtmpublishoptions">RtmPublishOptions</Link>
     </PlatformWrapper>
 </PlatformWrapper>

assets/code/video-sdk/ai-noise-suppression/configure-engine.mdx

@@ -0,0 +1,18 @@
+<PlatformWrapper placeholder="react-js">
+   ```typescript
+   export function AINoiseReduction() {
+    const agoraEngine = useRTCClient(AgoraRTC.createClient({ codec: "vp8", mode: "rtc" }));
+
+    return (
+        <div>
+            <h1>AI Noise Suppression</h1>
+            <AgoraRTCProvider client={agoraEngine}>
+                <AuthenticationWorkflowManager>
+                    <AINoiseSuppressionComponent />
+                </AuthenticationWorkflowManager>      
+            </AgoraRTCProvider>
+        </div>
+    );
+   }
+   ```
+</PlatformWrapper>

assets/code/video-sdk/ai-noise-suppression/configure-extension.mdx

@@ -0,0 +1,41 @@
+<PlatformWrapper placeholder="react-js">
+    ```typescript
+    const extension = useRef(new AIDenoiserExtension({assetsPath:'./node_modules/agora-extension-ai-denoiser/external'}));
+    const processor = useRef<IAIDenoiserProcessor>();
+
+    useEffect(() => {
+        const initializeAIDenoiserProcessor = async () => {
+            AgoraRTC.registerExtensions([extension.current]);
+            if (!extension.current.checkCompatibility()) {
+                console.error("Does not support AI Denoiser!");
+                return;
+            }
+
+            if (agoraContext.localMicrophoneTrack) 
+            {
+                console.log("Initializing an ai noise processor...");
+                try {
+                    processor.current = extension.current.createProcessor();
+                    agoraContext.localMicrophoneTrack.pipe(processor.current).pipe(agoraContext.localMicrophoneTrack.processorDestination);
+                    await processor.current.enable();
+                } catch (error) {
+                    console.error("Error applying noise reduction:", error);
+                }
+            }
+        };
+    void initializeAIDenoiserProcessor();
+
+    return () => {
+        const disableAIDenoiser = async () => {
+        processor.current?.unpipe();
+        agoraContext.localMicrophoneTrack.unpipe();
+        await processor.current?.disable();
+        };
+        void disableAIDenoiser();
+      };
+    }, [agoraContext.localMicrophoneTrack]);
+    ```
+    * <Link to = "{{global.API_REF_WEB_ROOT}}/interfaces/ilocalaudiotrack.html#pipe">pipe</Link>
+    * <Link to = "{{global.API_REF_WEB_ROOT}}/interfaces/ilocalaudiotrack.html#unpipe">unpipe</Link>
+
+</PlatformWrapper>

assets/code/video-sdk/ai-noise-suppression/enable-denoiser.mdx

@@ -0,0 +1,74 @@
+<PlatformWrapper platform="web">
+    ```javascript
+    // Create an AIDenoiserExtension instance, and pass in the host URL of the Wasm files
+    const denoiser = new AIDenoiserExtension({ assetsPath: "/node_modules/agora-extension-ai-denoiser/external/" });
+    // Check compatibility
+    if (!denoiser.checkCompatibility()) {
+        // The extension might not be supported in the current browser. You can stop executing further code logic
+        console.error("Does not support AI Denoiser!");
+    }
+    // Register the extension
+    AgoraRTC.registerExtensions([denoiser]);
+    // (Optional) Listen for the callback reporting that the Wasm files fail to load
+    denoiser.onloaderror = (e) => {
+        // If the Wasm files fail to load, you can disable the plugin, for example:
+        // openDenoiserButton.enabled = false;
+        console.log(e);
+    };
+
+    // Create a processor
+    const processor = denoiser.createProcessor();
+
+    // Inject the extension to the audio processing pipeline
+    channelParameters.localAudioTrack
+    .pipe(processor)
+    .pipe(channelParameters.localAudioTrack.processorDestination);
+
+    await processor.enable();
+    ```
+    - [createProcessor](#createprocessor)
+    - [enable](#enable)
+</PlatformWrapper>
+<PlatformWrapper platform="android">
+    ```kotlin
+    override fun setupAgoraEngine(): Boolean {
+        val result = super.setupAgoraEngine()
+
+        // Enable AI noise suppression
+        val mode = 2
+        // Choose a noise suppression mode from the following:
+        // 0: (Default) Balanced noise reduction mode
+        // 1: Aggressive mode
+        // 2: Aggressive mode with low latency
+        agoraEngine!!.setAINSMode(true, mode)
+
+        return result
+    }    
+    ```
+    - <Link to="{{global.API_REF_ANDROID_ROOT}}/class_irtcengine.html#api_irtcengine_setainsmode">setAINSMode</Link>
+</PlatformWrapper>
+
+<PlatformWrapper platform="ios, macos">
+    ```swift
+    func setNoiseSuppression(_ enable: Bool, mode: AUDIO_AINS_MODE) -> Int32 {
+        self.agoraEngine.setAINSMode(enable, mode: mode)
+    }
+    ```
+    <PlatformWrapper platform="ios">
+    - <Link to="{{Global.API_REF_IOS_ROOT_RTC_KIT}}/agorartcenginekit/setainsmode(_:mode:)">setAINSMode(_:mode:)</Link>
+    - <Link to="{{Global.API_REF_IOS_ROOT_RTC_KIT}}/audio_ains_mode">AUDIO_AINS_MODE</Link>
+    </PlatformWrapper>
+    <PlatformWrapper platform="macos">
+    - <Link to="{{Global.API_REF_MACOS_ROOT_RTC_KIT}}/agorartcenginekit/setainsmode(_:mode:)">setAINSMode(_:mode:)</Link>
+    - <Link to="{{Global.API_REF_MACOS_ROOT_RTC_KIT}}/audio_ains_mode">AUDIO_AINS_MODE</Link>
+    </PlatformWrapper>
+
+</PlatformWrapper>
+<PlatformWrapper platform="unity">
+    Enable AI noise suppression when you configure the engine.
+
+    ```csharp
+    agoraEngine.SetAINSMode(true, AUDIO_AINS_MODE.AINS_MODE_AGGRESSIVE);
+    ```
+    * <Link to = "{{global.API_REF_UNITY_ROOT}}/class_irtcengine.html#api_irtcengine_setainsmode">setAINSMode</Link>
+</PlatformWrapper>

assets/code/video-sdk/ai-noise-suppression/import-library.mdx

@@ -0,0 +1,23 @@
+<PlatformWrapper platform="web">
+```javascript
+import AgoraManager from "../agora_manager/agora_manager.js";
+import AgoraRTC from "agora-rtc-sdk-ng";
+import { AIDenoiserExtension } from "agora-extension-ai-denoiser";
+```
+</PlatformWrapper>
+<PlatformWrapper platform="react-js">
+```typescript
+import AgoraRTC from "agora-rtc-sdk-ng";
+import { useRTCClient, AgoraRTCProvider } from "agora-rtc-react";
+import { useEffect, useRef, useState } from "react";
+import AuthenticationWorkflowManager from "../authentication-workflow/authenticationWorkflowManager";
+import {AIDenoiserExtension, AIDenoiserProcessorLevel, AIDenoiserProcessorMode, IAIDenoiserProcessor} from "agora-extension-ai-denoiser";
+import { useConnectionState } from 'agora-rtc-react';
+import { useAgoraContext } from "../agora-manager/agoraManager";
+```
+</PlatformWrapper>
+<PlatformWrapper platform="unity">
+```csharp
+using Agora.Rtc;
+```
+</PlatformWrapper>

assets/code/video-sdk/ai-noise-suppression/import-plugin.mdx

@@ -0,0 +1,25 @@
+<PlatformWrapper platform={["ios", "macos"]}>
+    To enable <Vg k="RTEE_NS"/>, you must import the plugin to your target.
+
+        * **Swift Package Manager**
+
+            Add the product "AINS" to your app target. This is part of the AgoraRtcEngine Swift Package.
+
+        * **CocoaPods**
+
+            Include "AINS" in the subspecs in your Podfile:
+            <PlatformWrapper platform="ios">
+            ```rb
+            target 'Your App' do
+                pod 'AgoraRtcEngine_iOS', '~> 4.2', :subspecs => ['RtcBasic', 'AINS']
+            end
+            ```
+            </PlatformWrapper>
+            <PlatformWrapper platform="macos">
+            ```rb
+            target 'Your App' do
+                pod 'AgoraRtcEngine_macOS', '~> 4.2', :subspecs => ['RtcBasic', 'AINS']
+            end
+            ```
+            </PlatformWrapper>
+</PlatformWrapper>

assets/code/video-sdk/ai-noise-suppression/set-noise-reduction-mode.mdx

@@ -0,0 +1,34 @@
+<PlatformWrapper platform="react-js">
+```typescript
+const changeNoiseReductionMode = (selectedOption: string) => {
+    if (!processor.current) {
+      console.error("AI noise reduction processor not initialized");
+      return;
+    }
+    if(selectedOption === "STATIONARY_NS")
+    {
+        processor.current.setMode(AIDenoiserProcessorMode.STATIONARY_NS)
+        .then(() =>
+        {
+            console.log("Mode set to:", selectedOption);
+        })
+        .catch((error) =>
+        {
+            console.log(error);
+        });
+    }
+    else
+    {
+        processor.current.setMode(AIDenoiserProcessorMode.NSNG)
+        .then(() =>
+        {
+            console.log("Mode set to:", selectedOption);
+        })
+        .catch((error) =>
+        {
+            console.log(error);
+        });
+    }
+}
+```
+</PlatformWrapper>

assets/code/video-sdk/ai-noise-suppression/set-reduction-level.mdx

@@ -0,0 +1,34 @@
+<PlatformWrapper platform="react-js">
+```typescript
+const changeNoiseReductionLevel = (selectedOption: string) => {
+    if (!processor.current) {
+      console.error("AI noise reduction processor not initialized");
+      return;
+    }
+    if(selectedOption === "aggressive")
+    {
+        processor.current.setLevel(AIDenoiserProcessorLevel.AGGRESSIVE)
+        .then(() =>
+        {
+            console.log("Level set to:", selectedOption);
+        })
+        .catch((error) =>
+        {
+            console.log(error);
+        });
+    }
+    else
+    {
+      processor.current.setLevel(AIDenoiserProcessorLevel.SOFT)
+      .then(() =>
+        {
+            console.log("Level set to:", selectedOption);
+        })
+        .catch((error) =>
+        {
+            console.log(error);
+        });
+    }
+}
+```
+</PlatformWrapper>