-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c881229
commit a07cef4
Showing
1,414 changed files
with
30,162 additions
and
39,908 deletions.
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
agora-analytics/reference/pricing.mdx → agora-analytics/overview/pricing.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
agora-analytics/reference/release-notes.mdx → agora-analytics/overview/release-notes.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...alytics/reference/supported-platforms.mdx → ...nalytics/overview/supported-platforms.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| title: 'UI Samples quickstart' | ||
| title: 'UI Kit quickstart' | ||
| sidebar_position: 2 | ||
| type: docs | ||
| description: > | ||
|
|
||
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
agora-chat/reference/release-notes.mdx → agora-chat/overview/release-notes.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
agora-chat/reference/supported-platforms.mdx → agora-chat/overview/supported-platforms.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
assets/code/video-sdk/ai-noise-suppression/configure-engine.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
41 changes: 41 additions & 0 deletions
41
assets/code/video-sdk/ai-noise-suppression/configure-extension.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
74 changes: 74 additions & 0 deletions
74
assets/code/video-sdk/ai-noise-suppression/enable-denoiser.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
23 changes: 23 additions & 0 deletions
23
assets/code/video-sdk/ai-noise-suppression/import-library.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
25 changes: 25 additions & 0 deletions
25
assets/code/video-sdk/ai-noise-suppression/import-plugin.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
34 changes: 34 additions & 0 deletions
34
assets/code/video-sdk/ai-noise-suppression/set-noise-reduction-mode.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
34 changes: 34 additions & 0 deletions
34
assets/code/video-sdk/ai-noise-suppression/set-reduction-level.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
Oops, something went wrong.