From 10d3d847cef6a4feeb9bc2327ab810fd62c17e21 Mon Sep 17 00:00:00 2001 From: Kishan Dhakan Date: Wed, 28 Feb 2024 14:29:49 +0530 Subject: [PATCH 1/3] add media gateway doc set, rtt doc set, super clarity doc, video compositor doc, image enhancer doc, keep references as in beta --- shared/video-sdk/reference/release-notes/android.mdx | 2 +- shared/video-sdk/reference/release-notes/ios.mdx | 2 +- shared/voice-sdk/reference/release-notes/ios.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/shared/video-sdk/reference/release-notes/android.mdx b/shared/video-sdk/reference/release-notes/android.mdx index d419bd7d6..c56a50123 100644 --- a/shared/video-sdk/reference/release-notes/android.mdx +++ b/shared/video-sdk/reference/release-notes/android.mdx @@ -1070,4 +1070,4 @@ This release improves the implementation logic of `startPreview`. You can call t **6. Video types of subscription** You can call the `setRemoteDefaultVideoStreamType` method to choose the video stream type when subscribing to streams. - \ No newline at end of file + diff --git a/shared/video-sdk/reference/release-notes/ios.mdx b/shared/video-sdk/reference/release-notes/ios.mdx index 281d28b38..315ea9aa6 100644 --- a/shared/video-sdk/reference/release-notes/ios.mdx +++ b/shared/video-sdk/reference/release-notes/ios.mdx @@ -1462,4 +1462,4 @@ This release can achieve the same switching speed as `switchChannelByToken` in v **2. Voice pitch of the local user** This release adds `voicePitch` in `AgoraRtcAudioVolumeInfo` of `reportAudioVolumeIndicationOfSpeakers`. You can use `voicePitch` to get the local user's voice pitch and perform business functions such as rating for singing. - \ No newline at end of file + diff --git a/shared/voice-sdk/reference/release-notes/ios.mdx b/shared/voice-sdk/reference/release-notes/ios.mdx index f0bfc7892..6c7c4334d 100644 --- a/shared/voice-sdk/reference/release-notes/ios.mdx +++ b/shared/voice-sdk/reference/release-notes/ios.mdx @@ -678,4 +678,4 @@ This release can achieve the same switching speed as `switchChannelByToken` in v This release adds `voicePitch` in `AgoraRtcAudioVolumeInfo` of `reportAudioVolumeIndicationOfSpeakers`. You can use `voicePitch` to get the local user's voice pitch and perform business functions such as rating for singing. - \ No newline at end of file + From 2d3d2fd2a13849e793796395aee716164067c761 Mon Sep 17 00:00:00 2001 From: Kishan Dhakan Date: Tue, 5 Mar 2024 15:50:12 +0530 Subject: [PATCH 2/3] minor changes --- shared/chat-sdk/reference/release-notes/unity.mdx | 2 +- shared/video-sdk/develop/cloud-proxy/reference/react-js.mdx | 3 +++ shared/video-sdk/reference/release-notes/macos.mdx | 4 ++-- shared/video-sdk/reference/release-notes/windows.mdx | 2 +- shared/voice-sdk/reference/release-notes/macos.mdx | 2 +- shared/voice-sdk/reference/release-notes/windows.mdx | 2 +- 6 files changed, 9 insertions(+), 6 deletions(-) diff --git a/shared/chat-sdk/reference/release-notes/unity.mdx b/shared/chat-sdk/reference/release-notes/unity.mdx index b0747a297..56373d791 100644 --- a/shared/chat-sdk/reference/release-notes/unity.mdx +++ b/shared/chat-sdk/reference/release-notes/unity.mdx @@ -270,4 +270,4 @@ Refer to the following documentations to enable Chat and use the Chat SDK to imp - [Chat Room](../reference/chatroom-overview) - [API Reference](link) - \ No newline at end of file + diff --git a/shared/video-sdk/develop/cloud-proxy/reference/react-js.mdx b/shared/video-sdk/develop/cloud-proxy/reference/react-js.mdx index 337e045a1..77fd3b241 100644 --- a/shared/video-sdk/develop/cloud-proxy/reference/react-js.mdx +++ b/shared/video-sdk/develop/cloud-proxy/reference/react-js.mdx @@ -1,3 +1,6 @@ +- [Reference app](https://github.com/AgoraIO/video-sdk-samples-reactjs/tree/main#samples) +- API reference + diff --git a/shared/video-sdk/reference/release-notes/macos.mdx b/shared/video-sdk/reference/release-notes/macos.mdx index cdc24eb46..185201d7b 100644 --- a/shared/video-sdk/reference/release-notes/macos.mdx +++ b/shared/video-sdk/reference/release-notes/macos.mdx @@ -655,7 +655,7 @@ The SDK supports a new version of AI noise reduction (in comparison to the basic This release adds the following features applicable to spatial audio effect scenarios, which can effectively enhance the user's sense of presence experience in virtual interactive scenarios. -- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation parameter in `setZones`. +- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation paramter in `setZones`. - Doppler sound: You can enable Doppler sound by setting the `enable_doppler` parameter in `SpatialAudioParams`, and the receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source source and receiver (such as in a racing game scenario). - Headphone equalizer: You can use a preset headphone equalization effect by calling the `setHeadphoneEQPreset` method to improve the hearing of the headphones. @@ -1000,4 +1000,4 @@ This release improves the implementation logic of `startPreview`. You can call t You can call the `setRemoteDefaultVideoStreamType` method to choose the video stream type when subscribing to streams. - \ No newline at end of file + diff --git a/shared/video-sdk/reference/release-notes/windows.mdx b/shared/video-sdk/reference/release-notes/windows.mdx index eac79c3c5..c83b36bdb 100644 --- a/shared/video-sdk/reference/release-notes/windows.mdx +++ b/shared/video-sdk/reference/release-notes/windows.mdx @@ -1146,4 +1146,4 @@ This release improves the implementation logic of `startPreview`. You can call t **5. Video types of subscription** You can call the `setRemoteDefaultVideoStreamType` method to choose the video stream type when subscribing to streams. - \ No newline at end of file + diff --git a/shared/voice-sdk/reference/release-notes/macos.mdx b/shared/voice-sdk/reference/release-notes/macos.mdx index d472a9d83..415edc476 100644 --- a/shared/voice-sdk/reference/release-notes/macos.mdx +++ b/shared/voice-sdk/reference/release-notes/macos.mdx @@ -657,4 +657,4 @@ This release can achieve the same switching speed as `switchChannelByToken` in v **2. Voice pitch of the local user** This release adds `voicePitch` in `AgoraRtcAudioVolumeInfo` of `reportAudioVolumeIndicationOfSpeakers`. You can use `voicePitch` to get the local user's voice pitch and perform business functions such as rating for singing. - \ No newline at end of file + diff --git a/shared/voice-sdk/reference/release-notes/windows.mdx b/shared/voice-sdk/reference/release-notes/windows.mdx index e61ee33ec..ddbc88846 100644 --- a/shared/voice-sdk/reference/release-notes/windows.mdx +++ b/shared/voice-sdk/reference/release-notes/windows.mdx @@ -744,4 +744,4 @@ This release can achieve the same switching speed as `SwitchChannel` in v3.7.x t **2. Voice pitch of the local user** This release adds `voicePitch` in `AudioVolumeInfo` of `onAudioVolumeIndication`. You can use `voicePitch` to get the local user's voice pitch and perform business functions such as rating for singing. - \ No newline at end of file + From 715387a517f6481c8569e15552d7ce54cdbcdeff Mon Sep 17 00:00:00 2001 From: Kishan Dhakan Date: Tue, 5 Mar 2024 15:52:17 +0530 Subject: [PATCH 3/3] fix typos --- shared/video-sdk/reference/release-notes/android.mdx | 2 +- shared/video-sdk/reference/release-notes/ios.mdx | 2 +- shared/video-sdk/reference/release-notes/macos.mdx | 2 +- shared/video-sdk/reference/release-notes/windows.mdx | 2 +- .../get-started-sdk/project-implementation/electron.mdx | 4 ++-- shared/voice-sdk/reference/release-notes/android.mdx | 2 +- shared/voice-sdk/reference/release-notes/ios.mdx | 2 +- shared/voice-sdk/reference/release-notes/macos.mdx | 2 +- shared/voice-sdk/reference/release-notes/windows.mdx | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/shared/video-sdk/reference/release-notes/android.mdx b/shared/video-sdk/reference/release-notes/android.mdx index c56a50123..d40875a0f 100644 --- a/shared/video-sdk/reference/release-notes/android.mdx +++ b/shared/video-sdk/reference/release-notes/android.mdx @@ -696,7 +696,7 @@ The SDK supports a new version of Noise Suppression (in comparison to the basic This release adds the following features applicable to spatial audio effect scenarios, which can effectively enhance the user's sense of presence experience in virtual interactive scenarios. -- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation paramter in `setZones`. +- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation parameter in `setZones`. - Doppler sound: You can enable Doppler sound by setting the `enable_doppler` parameter in `SpatialAudioParams`, and the receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source source and receiver (such as in a racing game scenario). - Headphone equalizer: You can use a preset headphone equalization effect by calling the `setHeadphoneEQPreset` method to improve the hearing of the headphones. diff --git a/shared/video-sdk/reference/release-notes/ios.mdx b/shared/video-sdk/reference/release-notes/ios.mdx index 315ea9aa6..d3b0f7467 100644 --- a/shared/video-sdk/reference/release-notes/ios.mdx +++ b/shared/video-sdk/reference/release-notes/ios.mdx @@ -1205,7 +1205,7 @@ The SDK supports a new version of AI noise reduction (in comparison to the basic This release adds the following features applicable to spatial audio effect scenarios, which can effectively enhance the user's sense of presence experience in virtual interactive scenarios. -- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation paramter in `setZones`. +- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation parameter in `setZones`. - Doppler sound: You can enable Doppler sound by setting the `enable_doppler` parameter in `SpatialAudioParams`, and the receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source source and receiver (such as in a racing game scenario). - Headphone equalizer: You can use a preset headphone equalization effect by calling the `setHeadphoneEQPreset` method to improve the hearing of the headphones. diff --git a/shared/video-sdk/reference/release-notes/macos.mdx b/shared/video-sdk/reference/release-notes/macos.mdx index 185201d7b..13b6ee101 100644 --- a/shared/video-sdk/reference/release-notes/macos.mdx +++ b/shared/video-sdk/reference/release-notes/macos.mdx @@ -655,7 +655,7 @@ The SDK supports a new version of AI noise reduction (in comparison to the basic This release adds the following features applicable to spatial audio effect scenarios, which can effectively enhance the user's sense of presence experience in virtual interactive scenarios. -- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation paramter in `setZones`. +- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation parameter in `setZones`. - Doppler sound: You can enable Doppler sound by setting the `enable_doppler` parameter in `SpatialAudioParams`, and the receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source source and receiver (such as in a racing game scenario). - Headphone equalizer: You can use a preset headphone equalization effect by calling the `setHeadphoneEQPreset` method to improve the hearing of the headphones. diff --git a/shared/video-sdk/reference/release-notes/windows.mdx b/shared/video-sdk/reference/release-notes/windows.mdx index c83b36bdb..9e8c3fb5a 100644 --- a/shared/video-sdk/reference/release-notes/windows.mdx +++ b/shared/video-sdk/reference/release-notes/windows.mdx @@ -718,7 +718,7 @@ To experience this feature, contact support@a This release adds the following features applicable to spatial audio effect scenarios, which can effectively enhance the user's sense of presence experience in virtual interactive scenarios. -- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation paramter in `setZones`. +- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation parameter in `setZones`. - Doppler sound: You can enable Doppler sound by setting the `enable_doppler` parameter in `SpatialAudioParams`, and the receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source source and receiver (such as in a racing game scenario). - Headphone equalizer: You can use a preset headphone equalization effect by calling the `setHeadphoneEQPreset` method to improve the hearing of the headphones. diff --git a/shared/voice-sdk/get-started/get-started-sdk/project-implementation/electron.mdx b/shared/voice-sdk/get-started/get-started-sdk/project-implementation/electron.mdx index 6c8df2507..2da085ad2 100644 --- a/shared/voice-sdk/get-started/get-started-sdk/project-implementation/electron.mdx +++ b/shared/voice-sdk/get-started/get-started-sdk/project-implementation/electron.mdx @@ -50,7 +50,7 @@ To implement this logic, you take the following steps: 2. Call `initialize` to initialize the created instance with your `appID`. -3. To connect to a channel, call `joinChannel` and pass the user ID, token, and channel name as paramters. +3. To connect to a channel, call `joinChannel` and pass the user ID, token, and channel name as parameters. 4. Call `leaveChannel` to leave the channel when the user presses **Leave**. @@ -114,4 +114,4 @@ const } }; ``` - \ No newline at end of file + diff --git a/shared/voice-sdk/reference/release-notes/android.mdx b/shared/voice-sdk/reference/release-notes/android.mdx index a401d50f8..419bfbab6 100644 --- a/shared/voice-sdk/reference/release-notes/android.mdx +++ b/shared/voice-sdk/reference/release-notes/android.mdx @@ -553,7 +553,7 @@ To enable this function, contact [support@agora.io](mailto:support@agora.io). This release adds the following features applicable to spatial audio effect scenarios, which can effectively enhance the user's sense of presence experience in virtual interactive scenarios. -- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation paramter in `setZones`. +- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation parameter in `setZones`. - Doppler sound: You can enable Doppler sound by setting the `enable_doppler` parameter in `SpatialAudioParams`, and the receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source source and receiver (such as in a racing game scenario). - Headphone equalizer: You can use a preset headphone equalization effect by calling the `setHeadphoneEQPreset` method to improve the hearing of the headphones. diff --git a/shared/voice-sdk/reference/release-notes/ios.mdx b/shared/voice-sdk/reference/release-notes/ios.mdx index 6c7c4334d..6c0bd952d 100644 --- a/shared/voice-sdk/reference/release-notes/ios.mdx +++ b/shared/voice-sdk/reference/release-notes/ios.mdx @@ -541,7 +541,7 @@ To enable this function, contact support@agora.io. This release adds the following features applicable to spatial audio effect scenarios, which can effectively enhance the user's sense of presence experience in virtual interactive scenarios. -- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation paramter in `setZones`. +- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation parameter in `setZones`. - Doppler sound: You can enable Doppler sound by setting the `enable_doppler` parameter in `SpatialAudioParams`, and the receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source source and receiver (such as in a racing game scenario). - Headphone equalizer: You can use a preset headphone equalization effect by calling the `setHeadphoneEQPreset` method to improve the hearing of the headphones. diff --git a/shared/voice-sdk/reference/release-notes/macos.mdx b/shared/voice-sdk/reference/release-notes/macos.mdx index 415edc476..8bd7d32c6 100644 --- a/shared/voice-sdk/reference/release-notes/macos.mdx +++ b/shared/voice-sdk/reference/release-notes/macos.mdx @@ -522,7 +522,7 @@ To enable this function, contact support@agora.io. This release adds the following features applicable to spatial audio effect scenarios, which can effectively enhance the user's sense of presence experience in virtual interactive scenarios. -- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation paramter in `setZones`. +- Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling `setZones`. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listner experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user, respectively, by calling `setPlayerAttenuation` and `setRemoteAudioAttenuation`, and specify whether to use that setting to force an override of the sound attenuation parameter in `setZones`. - Doppler sound: You can enable Doppler sound by setting the `enable_doppler` parameter in `SpatialAudioParams`, and the receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source source and receiver (such as in a racing game scenario). - Headphone equalizer: You can use a preset headphone equalization effect by calling the `setHeadphoneEQPreset` method to improve the hearing of the headphones. diff --git a/shared/voice-sdk/reference/release-notes/windows.mdx b/shared/voice-sdk/reference/release-notes/windows.mdx index ddbc88846..3b42f510a 100644 --- a/shared/voice-sdk/reference/release-notes/windows.mdx +++ b/shared/voice-sdk/reference/release-notes/windows.mdx @@ -594,7 +594,7 @@ The SDK uses the playback device as the loopback device by default. Since