From d654b9e2d67dc6a2a17682660187699ff37418bf Mon Sep 17 00:00:00 2001 From: Kishan-Dhakan Date: Tue, 11 Oct 2022 13:38:18 +0530 Subject: [PATCH 1/7] link fixes --- account-and-billing/billing_account.mdx | 8 +++---- account-and-billing/billing_basis.mdx | 2 +- general-product-inquiry/agora_class_state.mdx | 2 +- general-product-inquiry/audio_format.mdx | 2 +- general-product-inquiry/browser_support.mdx | 8 +++---- general-product-inquiry/differ_agora_cdn.mdx | 2 +- general-product-inquiry/platform_version.mdx | 6 ++--- integration-issues/call_duration.mdx | 6 ++--- integration-issues/console_error_web.mdx | 4 ++-- integration-issues/host_set_role.mdx | 6 ++--- integration-issues/image_enhancement.mdx | 24 +++++++++---------- integration-issues/judge_voice_video_call.mdx | 14 +++++------ .../live_streaming_disconnection_web.mdx | 2 +- integration-issues/log.mdx | 10 ++++---- integration-issues/profile_difference.mdx | 2 +- integration-issues/reconnection.mdx | 2 +- integration-issues/reduce_app_size_rtc.mdx | 12 +++++----- .../restful_api_call_frequency.mdx | 9 +++---- integration-issues/streaminit_error.mdx | 2 +- quality-issues/audio_freeze.mdx | 2 +- quality-issues/audio_low.mdx | 2 +- quality-issues/audio_noise.mdx | 2 +- quality-issues/audio_role.mdx | 2 +- quality-issues/echo.mdx | 2 +- quality-issues/pixelated_green_video.mdx | 22 ++++++++--------- quality-issues/track_ended.mdx | 2 +- quality-issues/unsynchronized_video.mdx | 4 ++-- quality-issues/video_blank.mdx | 8 +++---- quality-issues/video_blur.mdx | 2 +- quality-issues/video_freeze.mdx | 4 ++-- quality-issues/web_screen_share_issues.mdx | 18 +++++++------- 31 files changed, 95 insertions(+), 98 deletions(-) diff --git a/account-and-billing/billing_account.mdx b/account-and-billing/billing_account.mdx index f37a3fd..8a9d6bc 100644 --- a/account-and-billing/billing_account.mdx +++ b/account-and-billing/billing_account.mdx @@ -22,7 +22,7 @@ You have a paid account if you have registered with Agora and done any of the fo - You have recently made a payment. - Signed a contract with Agora. -Agora provides each paid account with [10,000 charge-free minutes per month](../../help/account-and-billing/billing_free). In addition, there is a 30-day grace period for any outstanding billing amount after a fee deduction. +Agora provides each paid account with [10,000 charge-free minutes per month](/help/account-and-billing/billing_free). In addition, there is a 30-day grace period for any outstanding billing amount after a fee deduction. ### Billing @@ -46,7 +46,7 @@ If you have any questions, contact [sales@agora.io](mailto:sales@agora.io). On the sixth day of each month, Agora Console automatically deducts the fee for the previous month and notifies you by email. -If your account balance is negative after the deduction, Agora sends you an email, reminding you to [top up your account](../../video-calling/reference/manage-agora-account#billing-center) at your earliest convenience to avoid account suspension. +If your account balance is negative after the deduction, Agora sends you an email, reminding you to [top up your account](/video-calling/reference/manage-agora-account#billing-center) at your earliest convenience to avoid account suspension. ### Account suspension @@ -62,7 +62,7 @@ You have a free account if you have registered with Agora and _not_ done any of - You have recently made a payment. - Signed a contract with Agora. -With a free Agora account, you have [10,000 charge-free minutes per month](../../help/account-and-billing/billing_free). +With a free Agora account, you have [10,000 charge-free minutes per month](/help/account-and-billing/billing_free). ### Billing @@ -79,7 +79,7 @@ On the sixth day of each month, Agora Console automatically deducts the fee for - The services are free of charge, and Agora does not deduct any fee when you meet both of the following requirements: - Your monthly total service minutes of Agora Video SDK do not exceed 10,000 charge-free minutes; and - You do not use any other charged Agora services or products. -- If you have any outstanding billing amount, then Agora sends you an email, reminding you to [top up your account](../../video-calling/reference/manage-agora-account#billing-center) at your earliest convenience. +- If you have any outstanding billing amount, then Agora sends you an email, reminding you to [top up your account](/video-calling/reference/manage-agora-account#billing-center) at your earliest convenience. ### Account suspension diff --git a/account-and-billing/billing_basis.mdx b/account-and-billing/billing_basis.mdx index ed3c7d5..0f4daa8 100644 --- a/account-and-billing/billing_basis.mdx +++ b/account-and-billing/billing_basis.mdx @@ -47,4 +47,4 @@ Agora calculates service minutes **by the number of users**, which is easier and ## Reference -[Billing for Real-time Communication](../../video-calling/reference/billing-policies) +[Billing for Real-time Communication](/video-calling/reference/billing-policies) diff --git a/general-product-inquiry/agora_class_state.mdx b/general-product-inquiry/agora_class_state.mdx index 629d383..39db2be 100644 --- a/general-product-inquiry/agora_class_state.mdx +++ b/general-product-inquiry/agora_class_state.mdx @@ -57,4 +57,4 @@ In the Flexible Classroom client, you can specify the starting time and duration The state of the classroom is automatically started at the specified start time and automatically ended after the specified duration elapses. -In addition, you can change the classroom state by calling the [RESTful API](../../flexible-classroom/reference/classroom-api/). +In addition, you can change the classroom state by calling the [RESTful API](/flexible-classroom/reference/classroom-api/). diff --git a/general-product-inquiry/audio_format.mdx b/general-product-inquiry/audio_format.mdx index 82de05f..b8b06a6 100644 --- a/general-product-inquiry/audio_format.mdx +++ b/general-product-inquiry/audio_format.mdx @@ -52,7 +52,7 @@ If you use the SDK v3.6.2 or later and have integrated the full-format audio dec
For the extension library name for each platform, see{' '} - Reduce App Size. + Reduce App Size.
## Considerations diff --git a/general-product-inquiry/browser_support.mdx b/general-product-inquiry/browser_support.mdx index 94237f4..ce6d524 100644 --- a/general-product-inquiry/browser_support.mdx +++ b/general-product-inquiry/browser_support.mdx @@ -9,7 +9,7 @@ export const toc = [{}];
This page only applies to the Agora Web SDK 3.x. If you use the Web SDK 4.x, see{' '} - Web SDK Compatibility. + Web SDK Compatibility.
@@ -47,15 +47,15 @@ Other browser support on desktop: The browser support on mobile devices heavily depends on the capabilities of devices and the codec implementation of browsers. - On Android 4.1 or later, the Web SDK supports Chrome 58 or later. Agora recommends using VP8 on Android Chrome, because whether Google Chrome for Android supports H.264 is hardware dependent and some Android devices do not support H.264. -- On iOS 11 or later, the Web SDK supports Safari or later. However, Agora does not recommend using the Web SDK on iOS Safari due to the large amount of known issues and limitations of [iOS Safari](#safari). For better user experience on iOS, try the [Agora Video SDK iOS SDK](/en/sdks?platform=ios). +- On iOS 11 or later, the Web SDK supports Safari or later. However, Agora does not recommend using the Web SDK on iOS Safari due to the large amount of known issues and limitations of [iOS Safari](#safari). For better user experience on iOS, try the Agora Video SDK iOS SDK. -The support for in-app browsers on mobile devices is complicated. For details, see [Supported Platforms](../../video-calling/reference/supported-platforms). +The support for in-app browsers on mobile devices is complicated. For details, see [Supported Platforms](/video-calling/reference/supported-platforms). ## Limitation Due to the various browser engine implementations, support for some features may vary by browser and platform. The following are known issues and limitations. -On Chrome 81 or later, Safari, and Firefox, device IDs are only available after the user has granted permissions to use the media device. See [Why can't I get device ID on Chrome 81?](../../help/integration-issues/empty_deviceId) +On Chrome 81 or later, Safari, and Firefox, device IDs are only available after the user has granted permissions to use the media device. See [Why can't I get device ID on Chrome 81?](/help/integration-issues/empty_deviceId) ### Chrome diff --git a/general-product-inquiry/differ_agora_cdn.mdx b/general-product-inquiry/differ_agora_cdn.mdx index 514eb3c..5633624 100644 --- a/general-product-inquiry/differ_agora_cdn.mdx +++ b/general-product-inquiry/differ_agora_cdn.mdx @@ -25,4 +25,4 @@ See the following table for details: | Transmission Algorithm | TCP | Private algorithm for fixing packet loss and adjusting the bitrate automatically according to the current bandwidth | | Picture-in-picture layout | Fixed | Can be adjusted dynamically | -Agora also enables the function of [publishing streams into the CDN](../../media-push/overview/product-overview) for social media sharing. +Agora also enables the function of publishing streams into the CDN for social media sharing. diff --git a/general-product-inquiry/platform_version.mdx b/general-product-inquiry/platform_version.mdx index 77d7a0a..ccf639f 100644 --- a/general-product-inquiry/platform_version.mdx +++ b/general-product-inquiry/platform_version.mdx @@ -11,7 +11,7 @@ This page lists the supported platforms of Agora products. ## Voice and Video -The [Agora Video SDK](../../video-calling/get-started/get-started-sdk) supports iOS, Android, Windows, macOS, Unity, and Web, and allows for cross-platform connections. The following is a list of supported platforms and their versions. +The [Agora Voice and Video SDK](/api-reference) supports iOS, Android, Windows, macOS, Unity, and Web, and allows for cross-platform connections. The following is a list of supported platforms and their versions. | Platform | Supported Version | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -20,7 +20,7 @@ The [Agora Video SDK](../../video-calling/get-started/get-started-sdk) supports | Windows |

≥ Windows 7

The Windows SDK supports the following architecture:

  • x86
  • x86-64
    • | | macOS |

    ≥ 10.10

    The macOS SDK supports the following architecture:

  • x86-64
  • arm64
    • | | Unity |

    ≥ 2017

    The Unity SDK supports the following platforms:

    | -| Web | See [Web SDK Compatibility](../../video-calling/reference/supported-platforms) | +| Web | See [Web SDK Compatibility](/video-calling/reference/supported-platforms) | | Electron | ≥ Electron 1.8.3 | | Flutter | ≥ Flutter 1.0.0 | | React Native | ≥ React Native 0.59.10 | @@ -35,4 +35,4 @@ You can use RESTful APIs to enable and manage the Agora cloud recording services ## Signaling -The Agora Signaling SDK supports Android, iOS, macOS, Linux, Windows C++, and Web. See [Peer-to-peer or Channel Messaging](../../signaling/overview/product-overview) for details. +The Agora Signaling SDK supports Android, iOS, macOS, Linux, Windows C++, and Web. See [Peer-to-peer or Channel Messaging](/signaling/overview/product-overview) for details. diff --git a/integration-issues/call_duration.mdx b/integration-issues/call_duration.mdx index 9be0cca..e1b67b9 100644 --- a/integration-issues/call_duration.mdx +++ b/integration-issues/call_duration.mdx @@ -13,17 +13,17 @@ During a call, a user may join and leave a Video SDK channel for multiple times, ### Use the Agora Video SDK -By design, the SDK triggers the `onRtcStats` callback after a user successfully joins a Video SDK channel. To get the duration between each channel-join and channel-leave, use the `totalDuration` parameter of the last `onRtcStats` callback triggered before the user leaves the channel. If a user joins and leaves a Video SDK channel for multiple times, you can calculate the user's call duration by adding up the values of `totalDuration`. +By design, the SDK triggers the `onRtcStats` callback after a user successfully joins a Video SDK channel. To get the duration between each channel-join and channel-leave, use the `totalDuration` parameter of the last `onRtcStats` callback triggered before the user leaves the channel. If a user joins and leaves a Video SDK channel for multiple times, you can calculate the user's call duration by adding up the values of `totalDuration`. The above callback is in Java. For other programming languages, use the following parameters to get the user's call duration: - C++: The `duration` parameter of the `onRtcStats` callback. -- Objective-C: The `duration` parameter of the [reportRtcStats](https://api-ref.agora.io/en/video-sdk/ios/3.x/Protocols/AgoraRtcEngineDelegate.html#//api/name/rtcEngine:reportRtcStats:) callback. +- Objective-C: The `duration` parameter of the `reportRtcStats` callback. - Javascript: The `Duration` parameter of the `Client.getSessionStats` method. If the connection is lost under poor network conditions, the calculated duration maybe inaccurate. Use [Agora Signaling SDK](/signaling/develop/manage-connection-states) or a different signaling system to implement a heartbeat mechanism, and get the disconnected time of the client. You can calculate the user's call duration by subtracting the disconnected time of the client from the call duration obtained from the Agora Video SDK. ### Use Agora Analytics -On the **Call Search** page of **Agora Analytics**, you can find a user's call duration in the **In-call Periods** column. See [Call Search](/agora-analytics/analyze/video-voice-sdk/call-search#search). +On the **Call Search** page of **Agora Analytics**, you can find a user's call duration in the **In-call Periods** column. See [Call Search](/agora-analytics/analyze/video-voice-sdk/call-search#use-call-search). ![](https://web-cdn.agora.io/docs-files/1592406406894) diff --git a/integration-issues/console_error_web.mdx b/integration-issues/console_error_web.mdx index 40f1a94..88428b3 100644 --- a/integration-issues/console_error_web.mdx +++ b/integration-issues/console_error_web.mdx @@ -29,9 +29,9 @@ Check your code logic and ensure that you call `Client.publish` after the `Clien ## Connect choose server timeout -Same reason and solution as [Failed to load resource](#resource). +Same reason and solution as [Failed to load resource](#failed-to-load-resource). -## DTLS failed +## DTLS The following table lists the possible reasons and corresponding solutions: diff --git a/integration-issues/host_set_role.mdx b/integration-issues/host_set_role.mdx index 4a6b782..61622e5 100644 --- a/integration-issues/host_set_role.mdx +++ b/integration-issues/host_set_role.mdx @@ -29,12 +29,12 @@ The basic API call sequence is as follows: Refer to the detailed steps for implementation: -1. The host calls v to send a peer-to-peer message that invites an audience to take on the role pf co-host. +1. The host calls `sendMessage` to send a peer-to-peer message that invites an audience to take on the role of co-host. 2. The audience receives the invitation message in the `onMessageReceived` callback. 3. The audience calls `setClientRole` to change the user role to `CLIENT_ROLE_BROADCASTER`. 4. After successfully changing the user role, the audience receives the `onClientRoleChanged` callback, and becomes a co-host. -5. The new co-host calls `onMessageReceived` to notify the role change to all users in the channel. -6. The host receives the `onAttributesUpdated`) callback, and starts co-hosting with the new co-host. +5. The new co-host calls `addOrUpdateChannelAttributes` to notify the role change to all users in the channel. +6. The host receives the `onAttributesUpdated` callback, and starts co-hosting with the new co-host. To change a co-host back to an audience, follow the same steps, except when calling `setClientRole`, set the user role as `CLIENT_ROLE_AUDIENCE`. diff --git a/integration-issues/image_enhancement.mdx b/integration-issues/image_enhancement.mdx index 7bdc303..ff2517c 100644 --- a/integration-issues/image_enhancement.mdx +++ b/integration-issues/image_enhancement.mdx @@ -13,7 +13,7 @@ If the basic image enhancement function provided by the Agora Video SDK does not ## Implementation -1. Ensure that you have implemented basic real-time functions in your project. See [Start Interactive Live Video Streaming](../../interactive-live-streaming/get-started/get-started-sdk) or [Start a Video Call](../../video-calling/get-started/get-started-sdk). +1. Ensure that you have implemented basic real-time functions in your project. See [Start Interactive Live Video Streaming](/interactive-live-streaming/get-started/get-started-sdk) or [Start a Video Call](/video-calling/get-started/get-started-sdk). 2. Call `setBeautyEffectOptions` to enable image enhancement and set the image enhancement options. As of v3.6.0, the Agora Video SDK for Native platforms and third-party frameworks updates the Agora image enhancement algorithm, which improves the image enhancement effects and supports sharpness adjustment. If you want to experience the optimized image enhancement effects or set the sharpness, upgrade your SDK and make sure the following dynamic libraries are integrated before you call setBeautyEffectOptions: @@ -114,23 +114,23 @@ Agora also provides an [Online Demo](https://webdemo.agora.io/agora-websdk-api-e ### Native -- Android: `setBeautyEffectOptions` -- iOS: [`setBeautyEffectOptions`](https://docs.agora.io/en/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraRtcEngineKit.html?platform=iOS#//api/name/setBeautyEffectOptions:options:) -- macOS: [`setBeautyEffectOptions`](https://docs.agora.io/en/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraRtcEngineKit.html?platform=macOS#/api/name/setBeautyEffectOptions:options:) -- Windows: `setBeautyEffectOptions` +- Android: `setBeautyEffectOptions` +- iOS: `setBeautyEffectOptions` +- macOS: `setBeautyEffectOptions` +- Windows: `setBeautyEffectOptions` ### Web -- Web 3.x: `setBeautyEffectOptions` -- Web 4.x: `BeautyEffectOptions` +- Web 3.x: `setBeautyEffectOptions` +- Web 4.x: `BeautyEffectOptions` ### Third-party frameworks developed from Native -- Electron: `setBeautyEffectOptions` -- Unity: `setBeautyEffectOptions` -- Flutter: `setBeautyEffectOptions` -- React Native: `setBeautyEffectOptions` -- Cocos Creator: `setBeautyEffectOptions` +- Electron: `setBeautyEffectOptions` +- Unity: `setBeautyEffectOptions` +- Flutter: `setBeautyEffectOptions` +- React Native: `setBeautyEffectOptions` +- Cocos Creator: `setBeautyEffectOptions` ## Considerations diff --git a/integration-issues/judge_voice_video_call.mdx b/integration-issues/judge_voice_video_call.mdx index e53ca7a..9ec127b 100644 --- a/integration-issues/judge_voice_video_call.mdx +++ b/integration-issues/judge_voice_video_call.mdx @@ -13,24 +13,24 @@ In real-time audio or video communication, you can use the Agora Signaling SDK o If you need to determine and send the call type to the receiver before a call, ensure that you have integrated the Signaling SDK and the Video SDK. Refer to the following articles to learn more about integration: -- [Signaling SDK Quickstart](../../signaling/get-started/get-started-sdk) -- [Video SDK Quickstart](../../interactive-live-streaming/get-started/get-started-sdk) +- [Signaling SDK Quickstart](/signaling/get-started/get-started-sdk) +- [Video SDK Quickstart](/interactive-live-streaming/get-started/get-started-sdk) Complete the following steps to determine the call type: -1. When the caller sends a call, use the [Call Invitation API](../../signaling/develop/call-invitation) of the Signaling SDK to send a call invitation to the callee. -2. Call `sendMessageToPeer` to send the call type to the callee via peer-to-peer message. The callee gets the call type from the received peer-to-peer message. +1. When the caller sends a call, use the [Call Invitation API](/signaling/develop/call-invitation) of the Signaling SDK to send a call invitation to the callee. +2. Call [`sendMessageToPeer`](/signaling/reference/release-notes#deprecated-methods) to send the call type to the callee via peer-to-peer message. The callee gets the call type from the received peer-to-peer message. ## After a call If you need to determine and send the call type to the receiver during a call, ensure that you have integrated the Video SDK. Refer to the following article: -- [Video SDK Quickstart](../../interactive-live-streaming/get-started/get-started-sdk) +- [Video SDK Quickstart](/interactive-live-streaming/get-started/get-started-sdk) During a call, the receiver can determine the call type according to the following guideline: -- If the receiver receives the onRemoteVideoStateChange callback, the current call is a video call. -- If the receiver does not receive the onRemoteVideoStateChange callback and receives the onRemoteVideoStateChange callback, the current call is an audio call. +- If the receiver receives the onRemoteVideoStateChange callback, the current call is a video call. +- If the receiver does not receive the onRemoteVideoStateChange callback and receives the onRemoteAudioStateChange callback, the current call is an audio call. ## Corresponding methods and callbacks diff --git a/integration-issues/live_streaming_disconnection_web.mdx b/integration-issues/live_streaming_disconnection_web.mdx index 04e9b91..fe214a6 100644 --- a/integration-issues/live_streaming_disconnection_web.mdx +++ b/integration-issues/live_streaming_disconnection_web.mdx @@ -7,7 +7,7 @@ products: []
    This article only applies to the Agora Web SDK 3.x and earlier versions.
    -[Pushing streams to the CDN](../../media-push/overview/product-overview) refers to the process where a host publishes multiple media streams to the CDN (Content Delivery Network). +Pushing streams to the CDN refers to the process where a host publishes multiple media streams to the CDN (Content Delivery Network). During pushing streams, the SDK connects to the dedicated Agora server for pushing streams. When the connection is interrupted, the SDK tries to reconnect to the server to continue pushing streams. If it fails to reconnect, the SDK triggers a callback to report a disconnection. diff --git a/integration-issues/log.mdx b/integration-issues/log.mdx index 38c8158..fa3ae7d 100644 --- a/integration-issues/log.mdx +++ b/integration-issues/log.mdx @@ -211,11 +211,11 @@ int ret = m_rtcEngine->initialize(context); **API reference** - Android - - `create`[2/2] + - `create[2/2]` - iOS/macOS - - `sharedEngineWithConfig`](https://docs.agora.io/cn/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/sharedEngineWithConfig:delegate:) + - `sharedEngineWithConfig` - Windows - - `initialize` + - `initialize` ### Get the stack information @@ -278,8 +278,8 @@ AgoraRTC.setLogLevel(1); #### Web SDK 4.x - `enableLogUpload` -- `disableLogUpload` -- `setLogLevel` +- `disableLogUpload` +- `setLogLevel` #### Web SDK 3.x diff --git a/integration-issues/profile_difference.mdx b/integration-issues/profile_difference.mdx index ffe10b2..8cfcc7a 100644 --- a/integration-issues/profile_difference.mdx +++ b/integration-issues/profile_difference.mdx @@ -32,7 +32,7 @@ The default user role in different channel profiles are different:
    In scenarios involving co-host token authentication, if a user joins a channel with the token of a subscriber, calling setClientRole alone does not take effect. For details, see{' '} - How can I use co-host token authentication. + How can I use co-host token authentication.
    ## Audio route diff --git a/integration-issues/reconnection.mdx b/integration-issues/reconnection.mdx index 8e600a6..f14a612 100644 --- a/integration-issues/reconnection.mdx +++ b/integration-issues/reconnection.mdx @@ -12,7 +12,7 @@ The Agora SDK has reconnection mechanisms when a user drops offline or a process ## User drops offline -The Agora SDK adds the `onConnectionStateChanged` or `connectionStateChangedToState` callback in v2.3.2. This callback reports the current network connection state and reasons to any state change. +The Agora SDK adds the `onConnectionStateChanged` or `connectionStateChangedToState` callback in v2.3.2. This callback reports the current network connection state and reasons to any state change. ### Before v2.3.2 diff --git a/integration-issues/reduce_app_size_rtc.mdx b/integration-issues/reduce_app_size_rtc.mdx index 3cd0161..2b38200 100644 --- a/integration-issues/reduce_app_size_rtc.mdx +++ b/integration-issues/reduce_app_size_rtc.mdx @@ -10,7 +10,7 @@ export const toc = [{}];
    This page applies to SDKs earlier than v3.6.2 only. As of v3.6.2, Agora offers additional methods for reducing app size. See{' '} - Reduce App Size{' '} + Reduce App Size{' '} for the latest details.
    @@ -22,14 +22,14 @@ The Video SDK supports both audio and video functions, so the package size is la ## Solution 2: Remove unnecessary extension libraries -The SDK provides extension libraries that can be optionally integrated into the project. The name of extension libraries is suffixed with `Extension`. For details, see [Extension libraries](#extension_libraries). +The SDK provides extension libraries that can be optionally integrated into the project. The name of extension libraries is suffixed with `Extension`. If you do not need the extension functions, you can directly remove the corresponding extension libraries to reduce the app size. ### Deep-learning noise reduction library -The SDK enables traditional noise reduction by default to reduce most of the stationary background noise. Deep-learning noise reduction adds non-stationary background noise reduction based on the traditional noise reduction. After integrating the deep-learning noise reduction library, you can call `enableDeepLearningDenoise` to enable the deep-learning noise reduction. See [v3.3.0 Release Notes](../../3.x/interactive-live-streaming/introduction/release-notes#v330). +The SDK enables traditional noise reduction by default to reduce most of the stationary background noise. Deep-learning noise reduction adds non-stationary background noise reduction based on the traditional noise reduction. After integrating the deep-learning noise reduction library, you can call `enableDeepLearningDenoise` to enable the deep-learning noise reduction. See [v3.3.0 Release Notes](/3.x/interactive-live-streaming/introduction/release-notes#v330). The following table shows the extension library name for each platform and the increase in the app size after integration. @@ -79,7 +79,7 @@ The following table shows the extension library name for each platform and the i ### Virtual background library (beta feature) -After integrating the virtual background library, you can call `enableVirtualBackground` to enable the virtual background. See [v3.5.0 Release Notes](../../3.x/interactive-live-streaming/introduction/release-notes#v350). +After integrating the virtual background library, you can call `enableVirtualBackground` to enable the virtual background. See [v3.5.0 Release Notes](/3.x/interactive-live-streaming/introduction/release-notes#v350). The following table shows the extension library name for each platform and the increase in the app size after integration. @@ -113,7 +113,7 @@ The following table shows the extension library name for each platform and the i ### Super resolution library (beta feature) -After integrating the super resolution library, you can call `enableRemoteSuperResolution` to enable super resolution. See [v3.5.1 Release Notes](../../3.x/interactive-live-streaming/introduction/release-notes#v351). +After integrating the super resolution library, you can call `enableRemoteSuperResolution` to enable super resolution. See [v3.5.1 Release Notes](/3.x/interactive-live-streaming/introduction/release-notes#v351). The following table shows the extension library name for each platform and the increase in the app size after integration. @@ -126,7 +126,7 @@ The following table shows the extension library name for each platform and the i ### Image enhancement library -As of v3.6.0, ensure that you have integrated the image enhancement library before you call `setBeautyEffectOptions` to enable the image enhancement function. See [v3.6.0 Release Notes](../../3.x/interactive-live-streaming/introduction/release-notes#v360). +As of v3.6.0, ensure that you have integrated the image enhancement library before you call `setBeautyEffectOptions` to enable the image enhancement function. See [v3.6.0 Release Notes](/3.x/interactive-live-streaming/introduction/release-notes#v360). The following table shows the extension library name for each platform and the increase in the app size after integration. diff --git a/integration-issues/restful_api_call_frequency.mdx b/integration-issues/restful_api_call_frequency.mdx index 2fee79b..4a100ff 100644 --- a/integration-issues/restful_api_call_frequency.mdx +++ b/integration-issues/restful_api_call_frequency.mdx @@ -18,20 +18,17 @@ When the request of an Agora Server RESTful API exceeds its call frequency limit If the default frequency limit still cannot meet your project needs after considering the preceding suggestions, contact [support@agora.io](mailto:support@agora.io) to apply to adjust the call frequency limit. See Apply to raise API call frequency limit. -
    +{/*
    Each Agora Server RESTful API has an upper call frequency limit and cannot guarantee high real-time performance. In the case of high concurrency, you can contact support@agora.io to - - enable Agora message notification service - - and configure your server to receive + configure your server to receive Real-Time Communication events . -
    +
    */} ## Apply to raise API call frequency limit diff --git a/integration-issues/streaminit_error.mdx b/integration-issues/streaminit_error.mdx index 99ca335..ae372cc 100644 --- a/integration-issues/streaminit_error.mdx +++ b/integration-issues/streaminit_error.mdx @@ -15,4 +15,4 @@ The following are common errors when initializing the stream: - `MEDIA_NOT_SUPPORT`: Use HTTPS for your web app. - `OverConstrainedError`: A specified constraint cannot be satisfied by any available device, mostly because the requested capture device is occupied or the specified resolution is not supported. -See [`Stream.init`](https://docs.agora.io/en/Interactive%20Broadcast/API%20Reference/web/v3.3.1/interfaces/agorartc.client.html#init) for more errors. +See `Stream.init` for more errors. diff --git a/quality-issues/audio_freeze.mdx b/quality-issues/audio_freeze.mdx index d22bbc1..a7aa174 100644 --- a/quality-issues/audio_freeze.mdx +++ b/quality-issues/audio_freeze.mdx @@ -44,4 +44,4 @@ If the issue persists, contact Agora customer support and submit the issue with ## Step 3: Monitor the Quality of Experience in Agora Analytics in Console -You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](https://dashboard.agora.io/analytics/call/tutorial?_ga=2.197716463.1125435494.1542623251-764614247.1539586349). +You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](/agora-analytics/analyze/video-voice-sdk/call-search). diff --git a/quality-issues/audio_low.mdx b/quality-issues/audio_low.mdx index 4fcb9aa..309357e 100644 --- a/quality-issues/audio_low.mdx +++ b/quality-issues/audio_low.mdx @@ -27,4 +27,4 @@ If the issue persists, contact Agora customer support and submit the issue with ## Step 3: Monitor the Quality of Experience in Agora Analytics in Console -You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](https://dashboard.agora.io/analytics/call/tutorial?_ga=2.197716463.1125435494.1542623251-764614247.1539586349). +You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](/agora-analytics/analyze/video-voice-sdk/call-search). diff --git a/quality-issues/audio_noise.mdx b/quality-issues/audio_noise.mdx index 724b0f9..9fd53e6 100644 --- a/quality-issues/audio_noise.mdx +++ b/quality-issues/audio_noise.mdx @@ -51,4 +51,4 @@ If the issue persists, contact Agora customer support and submit the issue with ## Step 3: Monitor the Quality of Experience in Agora Analytics in Console -You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](https://dashboard.agora.io/analytics/call/tutorial?_ga=2.197716463.1125435494.1542623251-764614247.1539586349). +You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](/agora-analytics/analyze/video-voice-sdk/call-search). diff --git a/quality-issues/audio_role.mdx b/quality-issues/audio_role.mdx index f3fad3a..89216f9 100644 --- a/quality-issues/audio_role.mdx +++ b/quality-issues/audio_role.mdx @@ -14,6 +14,6 @@ To ensure a better audio experience in different scenarios, by default, the SDK The media volume and call volume have separate volume control mechanisms. -To avoid volume changes when the user switches user roles, ensure that the volume type used by the SDK remains the same before and after the switch. The volume type used by the SDK varies from case to case. See [Volume type introduction](../integration-issues/system_volume/#volume-type-introduction) for details. +To avoid volume changes when the user switches user roles, ensure that the volume type used by the SDK remains the same before and after the switch. The volume type used by the SDK varies from case to case. See [Volume type introduction](/help/integration-issues/system_volume) for details. For example, if you use `AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT` on Android and `AUDIO_SCENARIO_GAME_STREAMING` on iOS, then even if the user role switches and the audio routing changes, the user's volume type does not change, and thus the volume is not affected. diff --git a/quality-issues/echo.mdx b/quality-issues/echo.mdx index 357af49..0dd381c 100644 --- a/quality-issues/echo.mdx +++ b/quality-issues/echo.mdx @@ -65,4 +65,4 @@ If the issue persists, contact Agora customer support and submit the issue with ## Step 3: Monitor the Quality of Experience in Agora Analytics in Console -You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](https://dashboard.agora.io/analytics/call/tutorial?_ga=2.197716463.1125435494.1542623251-764614247.1539586349). +You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](/agora-analytics/analyze/video-voice-sdk/call-search). diff --git a/quality-issues/pixelated_green_video.mdx b/quality-issues/pixelated_green_video.mdx index 1ebc4b4..5324869 100644 --- a/quality-issues/pixelated_green_video.mdx +++ b/quality-issues/pixelated_green_video.mdx @@ -36,16 +36,16 @@ Refer to following sections to troubleshoot. 1. Ensure that the camera works correctly. 2. Check the third-party image enhancement SDK. If you are using a third-party image enhancement SDK, disable it and try again. If the video is no longer jagged and green, then this is the likely cause. Please contact the technical support of the third-party image enhancement SDK. - 3. Check whether the resolution is [recommended by Agora](/help/integration-issues/video_profile/). If not, change the resolution. + 3. Check whether the resolution is recommended by Agora. If not, change the resolution. 2. Check the video source and the video renderer: -- If the sender uses a custom source and renderer, check the custom source first and then check the custom renderer. See the sample projects for [custom source](https://github.com/AgoraIO/Advanced-Video/blob/dev/backup/Custom-Media-Device/Agora-Custom-Media-Device-Android/README.md) and [custom renderer](https://github.com/AgoraIO/Advanced-Video/tree/master/Android/sample-custom-render). -- If the sender uses a custom source and an Agora Video SDK renderer, check the custom source. See the [custom source](https://github.com/AgoraIO/Advanced-Video/blob/dev/backup/Custom-Media-Device/Agora-Custom-Media-Device-Android) sample project. -- If the sender uses an Agora Video SDK source and a custom renderer, check the custom renderer. See the [custom renderer](https://github.com/AgoraIO/Advanced-Video/blob/dev/backup/Custom-Media-Device/Agora-Custom-Media-Device-Android) sample project. +- If the sender uses a custom source and renderer, check the custom source first and then check the custom renderer. See the sample projects for [custom source](/video-calling/develop/custom-video-and-audio) and [custom renderer](/video-calling/develop/custom-video-and-audio). +- If the sender uses a custom source and an Agora Video SDK renderer, check the custom source. See the [custom source](/video-calling/develop/custom-video-and-audio) sample project. +- If the sender uses an Agora Video SDK source and a custom renderer, check the custom renderer. See the [custom renderer](/video-calling/develop/custom-video-and-audio) sample project. - If the sender uses an Agora Video SDK source and an Agora Video SDK renderer, contact [support@agora.io](mailto:support@agora.io) for technical support. -When the sender uses YUV data with the custom renderer, check whether you have mistakenly used the `Stride` parameter and the `width` parameter in `VideoFrame`. +When the sender uses YUV data with the custom renderer, check whether you have mistakenly used the `Stride` parameter and the `width` parameter in `VideoFrame`. ### Pixelated video in the receiver @@ -55,7 +55,7 @@ If pixelated video appears in both the sender and the receiver, you need to [che 2. If the receiver uses custom renderer, check the custom renderer. When the receiver uses YUV data with the custom renderer, check whether you have mistakenly used the -`Stride` parameter and the `width` parameter in `VideoFrame`. +`Stride` parameter and the `width` parameter in `VideoFrame`. @@ -65,10 +65,10 @@ Complete the following steps to check the camera, third-party image enhancement 1. Ensure that the camera works correctly. 2. Check the third-party image enhancement SDK. If you are using a third-party image enhancement SDK, disable it and try again. If the video is no longer jagged and green, then this is the likely cause. Please contact the technical support of the third-party image enhancement SDK. -3. Check whether the resolution is [recommended by Agora](/help/integration-issues/video_profile/). If not, change the resolution. +3. Check whether the resolution is recommended by Agora. If not, change the resolution. -- If the sender uses a custom source and renderer, when you use `setVideoSource` to set a custom source, check whether the data formats in `getBufferType` and from `IVideoFrameConsumer` to the SDK are consistent. If the data formats are inconsistent, update the data formats and re-check. Then check the custom renderer. -- If the sender uses a custom source and an Agora Video SDK renderer, check the custom source. When you use `setVideoSource` to set a custom source, check whether the data formats in `getBufferType` and from `IVideoFrameConsumer` to the SDK are consistent. If the data formats are inconsistent, update the data formats and re-check. Also check whether the video data is correctly sent from the custom source to the SDK. +- If the sender uses a custom source and renderer, when you use `setVideoSource` to set a custom source, check whether the data formats in `getBufferType` and from `IVideoFrameConsumer` to the SDK are consistent. If the data formats are inconsistent, update the data formats and re-check. Then check the custom renderer. +- If the sender uses a custom source and an Agora Video SDK renderer, check the custom source. When you use `setVideoSource` to set a custom source, check whether the data formats in `getBufferType` and from `IVideoFrameConsumer` to the SDK are consistent. If the data formats are inconsistent, update the data formats and re-check. Also check whether the video data is correctly sent from the custom source to the SDK. - If the sender uses an Agora Video SDK source and a custom renderer, check the custom renderer. - If the sender uses an Agora Video SDK source and an Agora Video SDK renderer, please contact [support@agora.io](mailto:support@agora.io) for technical support. @@ -78,7 +78,7 @@ In Android, if you use a custom source in the communication profile, check wheth If jagged, green video appears for both the sender and the receiver, you need to [check jagged, green video in the sender](#green_sender) first. If jagged, green video appears for the receiver only, refer to the following steps to troubleshoot: -- Regardless of the renderer type, check the sender first. If the sender uses a custom source, you also need to check whether the video data is correctly transmitted from the custom source to the Video SDK. When you use `setVideoSource` to set a custom source, check whether the data format in `getBufferType` and from `IVideoFrameConsumer` to the SDK are consistent. If the data format is inconsistent, update the data format and re-check. +- Regardless of the renderer type, check the sender first. If the sender uses a custom source, you also need to check whether the video data is correctly transmitted from the custom source to the Video SDK. When you use `setVideoSource` to set a custom source, check whether the data format in `getBufferType` and from `IVideoFrameConsumer` to the SDK are consistent. If the data format is inconsistent, update the data format and re-check. In Android, if you use a custom source in the communication profile, check whether the video data format is Texture. The Agora Video SDK for Android does not support receiving video data in Texture format. You need to update the video data format to YUV and re-check the video. @@ -94,7 +94,7 @@ If the previous steps in this article cannot help you fix this problem, please c - Screenshot of the pixelated or jagged, green video. - The time frame of the problem. - Source and renderer type: Agora Video SDK source, custom source, Agora Video SDK renderer, or custom renderer. -- SDK log files. See [How can I set the log file?](../../help/integration-issues/log) +- SDK log files. See [How can I set the log file?](/help/integration-issues/log) ### Additional information diff --git a/quality-issues/track_ended.mdx b/quality-issues/track_ended.mdx index dd6bfb8..a00787d 100644 --- a/quality-issues/track_ended.mdx +++ b/quality-issues/track_ended.mdx @@ -38,4 +38,4 @@ The Web SDK v4.x supports hot plugging. You can fix the issues of silent audio o ## See also -- [Hot plugging of audio and video input devices (Web v4.x).](../../video-calling/develop/product-workflow) +- [Hot plugging of audio and video input devices (Web v4.x).](/video-calling/develop/audio-and-voice-effects) diff --git a/quality-issues/unsynchronized_video.mdx b/quality-issues/unsynchronized_video.mdx index ce13324..d6466d8 100644 --- a/quality-issues/unsynchronized_video.mdx +++ b/quality-issues/unsynchronized_video.mdx @@ -35,7 +35,7 @@ Check the following: - Switch to another device with better performance, and then check if the issue persists. -- If you use a custom video renderer, check the source code of the video renderer. See the [Customer renderer](https://github.com/AgoraIO/Advanced-Video/tree/master/Android/sample-custom-render) sample project provided by Agora for reference. +- If you use a custom video renderer, check the source code of the video renderer. See the [Customer renderer](/video-calling/develop/custom-video-and-audio) sample project provided by Agora for reference. ## Step 2: Contact Agora customer support @@ -55,4 +55,4 @@ If the issue persists, contact [support@agora.io](mailto:support@agora.io). Plea - Screen recording files. -- SDK log files. See [How can I set the log file?](../../help/integration-issues/log#set-the-log-file) +- SDK log files. See [How can I set the log file?](/help/integration-issues/log#set-the-log-file) diff --git a/quality-issues/video_blank.mdx b/quality-issues/video_blank.mdx index 0622773..3453907 100644 --- a/quality-issues/video_blank.mdx +++ b/quality-issues/video_blank.mdx @@ -34,7 +34,7 @@ Before proceeding, ensure that your token is properly set. This is likely caused by a video capture failure on the local side. Do the following: 1. Check the camera hardware. Start the built-in video camera to test the recording function. -2. Check if the camera access permission is enabled. Both Android and iOS have a runtime access permission function under System Settings. See Add project permissions. +2. Check if the camera access permission is enabled. Both Android and iOS have a runtime access permission function under System Settings. See Add project permissions. 3. Check if another app is using the camera. Close all apps, restart your phone, and re-check. 4. If the app enabled the External Source Mode, check the data collected from the external video sources. @@ -44,7 +44,7 @@ This is likely caused by a video capture failure on the remote side or slow down 1. Check if the user disabled the remote video. 2. Switch to another network to ensure that the problem is not caused by a poor Internet connection. -3. Check whether the remote user uses the [channel encryption](/en/video-calling/develop/media-stream-encryption) function but the local user doesn't. +3. Check whether the remote user uses the [channel encryption](/video-calling/develop/media-stream-encryption) function but the local user doesn't. 4. Check whether the remote user can preview their video on their own device. If not, then the cause of the black video probably lies on the remote side. Perform the steps in Black screen on the local side. **Black screen on both sides** @@ -69,8 +69,8 @@ If the issue persists, contact support@agora.io. Please provide the following in - The UIDs of the users sending and receiving the black video. - The time frame when the black screen appears. - Screen recording files. -- SDK log files. See [How can I set the log file](../integration-issues/log#set-the-log-file)? +- SDK log files. See [How can I set the log file?](/integration-issues/log#set-the-log-file) ### Step 3: Monitor the quality of experience in Agora Analytics in Console -You can monitor the statistics of every call in [Agora Analytics](/agora-analytics/overview/product-overview) in Console. For more information, see [Agora Analytics Tutorial](/agora-analytics/reference/manage-agora-account). +You can monitor the statistics of every call in [Agora Analytics](/agora-analytics/overview/product-overview) in Console. For more information, see [Agora Analytics Tutorial](/agora-analytics/analyze/video-voice-sdk/call-search). diff --git a/quality-issues/video_blur.mdx b/quality-issues/video_blur.mdx index fe79243..12d88fa 100644 --- a/quality-issues/video_blur.mdx +++ b/quality-issues/video_blur.mdx @@ -28,4 +28,4 @@ If the issue persists, contact Agora customer support and submit the issue with ## Step 3: Monitor the Quality of Experience in Agora Analytics in Console -You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](https://dashboard.agora.io/analytics/call/tutorial?_ga=2.197716463.1125435494.1542623251-764614247.1539586349). +You can check the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. For more information, see [Agora Analytics Tutorial](/agora-analytics/analyze/video-voice-sdk/call-search). diff --git a/quality-issues/video_freeze.mdx b/quality-issues/video_freeze.mdx index 5582853..355654d 100644 --- a/quality-issues/video_freeze.mdx +++ b/quality-issues/video_freeze.mdx @@ -24,9 +24,9 @@ If the issue persists, contact [support@agora.io](mailto:support@agora.io) and r - The channel name and the UIDs of the users sending and receiving the video. - The time frame during which the choppy video playback appears. -- SDK log files. See [How can I set the log file?](../../help/integration-issues/log#set-the-log-file) +- SDK log files. See [How can I set the log file?](/help/integration-issues/log#set-the-log-file) - Screen recording files. ## Step 3: Monitor the quality of experience in Agora Analytics in Console -You can monitor the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. See [Agora Analytics Tutorial](https://dashboard.agora.io/analytics/call/tutorial?_ga=2.197716463.1125435494.1542623251-764614247.1539586349). +You can monitor the statistics of every call in [Agora Analytics](https://dashboard.agora.io/analytics/call/search) in Console. See [Agora Analytics Tutorial](/agora-analytics/analyze/video-voice-sdk/call-search). diff --git a/quality-issues/web_screen_share_issues.mdx b/quality-issues/web_screen_share_issues.mdx index e78443f..641c681 100644 --- a/quality-issues/web_screen_share_issues.mdx +++ b/quality-issues/web_screen_share_issues.mdx @@ -24,9 +24,9 @@ Troubleshoot the problem by following the steps below: 3. Check whether the user is sharing an application window. - If so, ask the user to share the browser tab or the entire screen instead. - If not, check the encoding configurations you set in `setScreenProfile`. -4. Upgrade the SDK to 3.2.0 or later versions, and set `optimizationMode` when creating the stream for screen-sharing. Choose the appropriate transmission optimization mode according to the shared content: - - If the shared content is mainly slides, texts, or static images, set `optimizationMode` as `"details"`. - - If the shared content is mainly videos or games, set `optimizationMode` as `"motion"`. +4. Upgrade the SDK to 3.2.0 or later versions, and set `optimizationMode` when creating the stream for screen-sharing. Choose the appropriate transmission optimization mode according to the shared content: + - If the shared content is mainly slides, texts, or static images, set `optimizationMode` as `"details"`. + - If the shared content is mainly videos or games, set `optimizationMode` as `"motion"`. ### Web 4.x @@ -37,15 +37,15 @@ Troubleshoot the problem by following the steps below: 3. Check whether the user is sharing an application window. - If so, ask the user to share a browser tab or the entire screen. - If not, check the encoding configurations you set in `createScreenVideoTrack`. -4. Set `optimizationMode` when creating the video track for screen sharing, and choose the appropriate transmission optimization mode according to the shared content: +4. Set `optimizationMode` when creating the video track for screen sharing, and choose the appropriate transmission optimization mode according to the shared content: - - If the shared content is mainly slides, texts, or static images, set `optimizationMode` as "details". - - If the shared content is mainly videos or games, set `optimizationMode` as `"motion"`. + - If the shared content is mainly slides, texts, or static images, set `optimizationMode` as "details". + - If the shared content is mainly videos or games, set `optimizationMode` as `"motion"`. -As of v4.2.0, you can change the transmission optimization mode during a screen sharing session by calling 'setOptimizationMode' +As of v4.2.0, you can change the transmission optimization mode during a screen sharing session by calling `setOptimizationMode`. ## See also -- [Share Screen (Web 3.x)](../../3.x/interactive-live-streaming/introduction/product-overview) -- [Share Screen (Web 4.x)](../../interactive-live-streaming/develop/product-workflow) +- [Share Screen (Web 3.x)](/3.x/interactive-live-streaming/introduction/product-overview) +- [Share Screen (Web 4.x)](/interactive-live-streaming/develop/product-workflow) - [How can I switch between the screen-sharing stream and the camera stream?](/help/integration-issues/switch_screen_camera_web) From 5f3066aaa4b92079acf1036382a3e1d7034c7eee Mon Sep 17 00:00:00 2001 From: Kishan-Dhakan Date: Wed, 12 Oct 2022 14:59:15 +0530 Subject: [PATCH 2/7] update API head levels --- integration-issues/log.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/integration-issues/log.mdx b/integration-issues/log.mdx index fa3ae7d..b50c28a 100644 --- a/integration-issues/log.mdx +++ b/integration-issues/log.mdx @@ -272,7 +272,7 @@ AgoraRTC.enableLogUpload(); AgoraRTC.setLogLevel(1); ``` -### API reference +### API Reference #### Web SDK 4.x From 5f023556eeed983ed12202fffa7505928caccf40 Mon Sep 17 00:00:00 2001 From: Kishan-Dhakan Date: Thu, 13 Oct 2022 10:07:48 +0530 Subject: [PATCH 3/7] use sentence case for api ref --- integration-issues/log.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/integration-issues/log.mdx b/integration-issues/log.mdx index b50c28a..fa3ae7d 100644 --- a/integration-issues/log.mdx +++ b/integration-issues/log.mdx @@ -272,7 +272,7 @@ AgoraRTC.enableLogUpload(); AgoraRTC.setLogLevel(1); ``` -### API Reference +### API reference #### Web SDK 4.x From 1b58ef14365e65bce2aa7b6b145dff0da9f624ba Mon Sep 17 00:00:00 2001 From: Kishan-Dhakan Date: Thu, 13 Oct 2022 12:51:55 +0530 Subject: [PATCH 4/7] on premise recording --- general-product-inquiry/agora_product.mdx | 2 +- general-product-inquiry/onpremise_cloud.mdx | 6 +++--- general-product-inquiry/platform_version.mdx | 4 ++-- general-product-inquiry/recording_concurrence.mdx | 2 +- integration-issues/recording_mode.mdx | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/general-product-inquiry/agora_product.mdx b/general-product-inquiry/agora_product.mdx index 364ece8..92adb76 100644 --- a/general-product-inquiry/agora_product.mdx +++ b/general-product-inquiry/agora_product.mdx @@ -17,7 +17,7 @@ Agora is a Platform as a Service (PaaS) provider that enables real-time communic - [Interactive Whiteboard](/interactive-whiteboard/overview/product-overview) - [Analytics](/agora-analytics/overview/product-overview) - [Cloud Recording](/cloud-recording/overview/product-overview) -- [On-premise Recording](/on-premise-recording/overview/product-overview) +- [On-Premise Recording](/on-premise-recording/overview/product-overview) - [Server Gateway](/server-gateway/overview/product-overview) - [Flexible classroom](/flexible-classroom/overview/product-overview) - [Media Push](/media-push/overview/product-overview) diff --git a/general-product-inquiry/onpremise_cloud.mdx b/general-product-inquiry/onpremise_cloud.mdx index ba7e481..25854d3 100644 --- a/general-product-inquiry/onpremise_cloud.mdx +++ b/general-product-inquiry/onpremise_cloud.mdx @@ -7,9 +7,9 @@ products: [] export const toc = [{}]; -**Agora On-premise Recording** and **Agora Cloud Recording** are add-ons to record and save voice calls, video calls, and interactive streaming on your **Linux server** and your **cloud storage**. +**Agora On-Premise Recording** and **Agora Cloud Recording** are add-ons to record and save voice calls, video calls, and interactive streaming on your **Linux server** and your **cloud storage**. -Compared with Agora On-premise Recording, Agora Cloud Recording is more efficient and convenient as it does not require deploying powerful Linux servers, which largely reduces development and maintenance costs. You can directly start recording using RESTful APIs. +Compared with Agora On-Premise Recording, Agora Cloud Recording is more efficient and convenient as it does not require deploying powerful Linux servers, which largely reduces development and maintenance costs. You can directly start recording using RESTful APIs. See the following table for details. @@ -19,4 +19,4 @@ See the following table for details. | Usability | You have to prepare the server resources and deploy the SDK on your Linux server. | You do not need to deploy the SDK on the Linux server and can directly use RESTful APIs to start recording. | | Operation and maintenance | You need to maintain the recording service. | Agora maintains the recording service for you. | | Scalability | You need to scale to a more powerful server depending upon the concurrent usage/recording sessions. | At your request, Agora scales up the recording service in real time. | -| Reliability | The reliability of Agora On-premise Recording depends on your implementation. | Agora Cloud Recording automatically saves files on Agora's cloud server for backup and automatically resumes recording after a system failure or other issues. | +| Reliability | The reliability of Agora On-Premise Recording depends on your implementation. | Agora Cloud Recording automatically saves files on Agora's cloud server for backup and automatically resumes recording after a system failure or other issues. | diff --git a/general-product-inquiry/platform_version.mdx b/general-product-inquiry/platform_version.mdx index ccf639f..bf2ab2c 100644 --- a/general-product-inquiry/platform_version.mdx +++ b/general-product-inquiry/platform_version.mdx @@ -25,9 +25,9 @@ The [Agora Voice and Video SDK](/api-reference) supports iOS, Android, Windows, | Flutter | ≥ Flutter 1.0.0 | | React Native | ≥ React Native 0.59.10 | -## On-premise Recording +## On-Premise Recording -The Agora On-premise Recording SDK is integrated on your Linux server. See [prerequisites of integrating the SDK](../../on-premise-recording/get-started/integrate-sdk) for details. +The Agora On-Premise Recording SDK is integrated on your Linux server. See [prerequisites of integrating the SDK](../../on-premise-recording/get-started/integrate-sdk) for details. ## Cloud Recording diff --git a/general-product-inquiry/recording_concurrence.mdx b/general-product-inquiry/recording_concurrence.mdx index 0c31cf5..2f69d60 100644 --- a/general-product-inquiry/recording_concurrence.mdx +++ b/general-product-inquiry/recording_concurrence.mdx @@ -7,7 +7,7 @@ products: [] export const toc = [{}]; -For the Agora On-premise Recording SDK, we conduct tests on the recording concurrency based on the following cloud hosting configuration: +For the Agora On-Premise Recording SDK, we conduct tests on the recording concurrency based on the following cloud hosting configuration: - AWS: Intel(R) Xeon(R) Platinum 8124M CPU @ 3.00 GHz - 16 Virtual Core CPU, 32 GB RAM diff --git a/integration-issues/recording_mode.mdx b/integration-issues/recording_mode.mdx index 83d2666..3277e90 100644 --- a/integration-issues/recording_mode.mdx +++ b/integration-issues/recording_mode.mdx @@ -11,5 +11,5 @@ In other cases, choose composite recording mode. For example, if you want to rec For detailed information about how to implement each recording mode and their features, see: -- On-premise Recording: [Individual Recording](/on-premise-recording/develop/individual-mode/) and [Composite Recording](/on-premise-recording/develop/composite-mode/). +- On-Premise Recording: [Individual Recording](/on-premise-recording/develop/individual-mode/) and [Composite Recording](/on-premise-recording/develop/composite-mode/). - Cloud Recording: [Individual Recording](/cloud-recording/develop/individual-mode/) and [Composite Recording](/cloud-recording/develop/composite-mode/). From 21b503ae09872e3494d6c8d1cb6d60b57d8bd74c Mon Sep 17 00:00:00 2001 From: Kishan-Dhakan Date: Fri, 14 Oct 2022 13:56:28 +0530 Subject: [PATCH 5/7] remove platform query --- general-product-inquiry/browser_support.mdx | 4 ++-- integration-issues/image_enhancement.mdx | 16 ++++++++-------- .../restful_api_call_frequency.mdx | 2 +- integration-issues/string.mdx | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/general-product-inquiry/browser_support.mdx b/general-product-inquiry/browser_support.mdx index ce6d524..3f0df18 100644 --- a/general-product-inquiry/browser_support.mdx +++ b/general-product-inquiry/browser_support.mdx @@ -9,7 +9,7 @@ export const toc = [{}];
    This page only applies to the Agora Web SDK 3.x. If you use the Web SDK 4.x, see{' '} - Web SDK Compatibility. + Web SDK Compatibility.
    @@ -47,7 +47,7 @@ Other browser support on desktop: The browser support on mobile devices heavily depends on the capabilities of devices and the codec implementation of browsers. - On Android 4.1 or later, the Web SDK supports Chrome 58 or later. Agora recommends using VP8 on Android Chrome, because whether Google Chrome for Android supports H.264 is hardware dependent and some Android devices do not support H.264. -- On iOS 11 or later, the Web SDK supports Safari or later. However, Agora does not recommend using the Web SDK on iOS Safari due to the large amount of known issues and limitations of [iOS Safari](#safari). For better user experience on iOS, try the Agora Video SDK iOS SDK. +- On iOS 11 or later, the Web SDK supports Safari or later. However, Agora does not recommend using the Web SDK on iOS Safari due to the large amount of known issues and limitations of [iOS Safari](#safari). For better user experience on iOS, try the Agora Video SDK iOS SDK. The support for in-app browsers on mobile devices is complicated. For details, see [Supported Platforms](/video-calling/reference/supported-platforms). diff --git a/integration-issues/image_enhancement.mdx b/integration-issues/image_enhancement.mdx index ff2517c..2465e9f 100644 --- a/integration-issues/image_enhancement.mdx +++ b/integration-issues/image_enhancement.mdx @@ -115,22 +115,22 @@ Agora also provides an [Online Demo](https://webdemo.agora.io/agora-websdk-api-e ### Native - Android: `setBeautyEffectOptions` -- iOS: `setBeautyEffectOptions` -- macOS: `setBeautyEffectOptions` -- Windows: `setBeautyEffectOptions` +- iOS: `setBeautyEffectOptions` +- macOS: `setBeautyEffectOptions` +- Windows: `setBeautyEffectOptions` ### Web -- Web 3.x: `setBeautyEffectOptions` +- Web 3.x: `setBeautyEffectOptions` - Web 4.x: `BeautyEffectOptions` ### Third-party frameworks developed from Native -- Electron: `setBeautyEffectOptions` -- Unity: `setBeautyEffectOptions` +- Electron: `setBeautyEffectOptions` +- Unity: `setBeautyEffectOptions` - Flutter: `setBeautyEffectOptions` -- React Native: `setBeautyEffectOptions` -- Cocos Creator: `setBeautyEffectOptions` +- React Native: `setBeautyEffectOptions` +- Cocos Creator: `setBeautyEffectOptions` ## Considerations diff --git a/integration-issues/restful_api_call_frequency.mdx b/integration-issues/restful_api_call_frequency.mdx index 4a100ff..05b3e3e 100644 --- a/integration-issues/restful_api_call_frequency.mdx +++ b/integration-issues/restful_api_call_frequency.mdx @@ -24,7 +24,7 @@ If the default frequency limit still cannot meet your project needs after consid contact support@agora.io to configure your server to receive - + Real-Time Communication events . diff --git a/integration-issues/string.mdx b/integration-issues/string.mdx index 2fccd1a..1554ead 100644 --- a/integration-issues/string.mdx +++ b/integration-issues/string.mdx @@ -7,7 +7,7 @@ products: [] This feature is in BETA. We recommend contacting support@agora.io before implementing this function. The following products or features do not support string user accounts: - [Cloud Recording](/cloud-recording/overview/product-overview) -- RTMP Converter +- RTMP Converter - Channel Management RESTful API - Console RESTful API From b0fa73da19718c163cbd249aa891d55bee01e55c Mon Sep 17 00:00:00 2001 From: Kishan-Dhakan Date: Wed, 19 Oct 2022 12:41:35 +0530 Subject: [PATCH 6/7] fix broken links in docusarus link checker --- quality-issues/video_blank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quality-issues/video_blank.mdx b/quality-issues/video_blank.mdx index 3453907..d974ec4 100644 --- a/quality-issues/video_blank.mdx +++ b/quality-issues/video_blank.mdx @@ -69,7 +69,7 @@ If the issue persists, contact support@agora.io. Please provide the following in - The UIDs of the users sending and receiving the black video. - The time frame when the black screen appears. - Screen recording files. -- SDK log files. See [How can I set the log file?](/integration-issues/log#set-the-log-file) +- SDK log files. See [How can I set the log file?](/help/integration-issues/log#set-the-log-file) ### Step 3: Monitor the quality of experience in Agora Analytics in Console From 7cc377bfd85dab8999ce06fd32bed54f729e4ddd Mon Sep 17 00:00:00 2001 From: Kishan-Dhakan Date: Mon, 24 Oct 2022 05:16:32 +0530 Subject: [PATCH 7/7] fix --- integration-issues/web_camera_light.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/integration-issues/web_camera_light.mdx b/integration-issues/web_camera_light.mdx index b4d7711..2609259 100644 --- a/integration-issues/web_camera_light.mdx +++ b/integration-issues/web_camera_light.mdx @@ -19,4 +19,4 @@ The Web SDK does not support enabling/disabling video capture independently. Cal Calling `close` stops the video capture and turns off the camera light, but it unauthorizes both the microphone and the camera, so audio sampling stops too. In the Agora Web SDK, the published object is a media stream that contains an audio track and a video track, so any operation of the stream affects both audio and video. -To quickly stop capturing and sending the local video without affecting the local audio, Agora recommends using next-generation Agora Web SDK ([Agora Web SDK NG](https://agoraio-community.github.io/AgoraWebSDK-NG/en/)). Agora Web SDK NG publishes the audio and video track as separate objects, enabling you to disable the local video and turn off the camera light by using the [`close`](https://agoraio-community.github.io/AgoraWebSDK-NG/api/en/interfaces/ilocaltrack.html#close) method of the video track object, without affecting the audio track. +To quickly stop capturing and sending the local video without affecting the local audio, Agora recommends using next-generation Agora Web SDK ([Agora Web SDK NG](https://api-ref.agora.io/en/video-sdk/web/4.x/index.html)). Agora Web SDK NG publishes the audio and video track as separate objects, enabling you to disable the local video and turn off the camera light by using the [`close`](https://api-ref.agora.io/en/video-sdk/web/4.x/interfaces/ilocaltrack.html#close#close) method of the video track object, without affecting the audio track.