Skip to content

Commit

Permalink
Merge pull request #20 from AgoraIO/remove-platform-query
Browse files Browse the repository at this point in the history
Remove platform query
  • Loading branch information
billy-the-fish authored Oct 23, 2022
2 parents 3031340 + 87fdce9 commit af8db60
Show file tree
Hide file tree
Showing 162 changed files with 584 additions and 584 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'Set the Voice Effect'
sidebar_position: 4
description: >
Introduces the voice effects enabled by the Agora RTC SDK.
Introduces the voice effects enabled by the Agora <Vg k="VSDK" />.
---

import VoiceChanger from '@site/versioned_docs/version-3.x/shared/interactive-live-streaming/advanced-features/voice-changer/index.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'Set the Audio Profile'
sidebar_position: 7
description: >
Describes how to use the Agora RTC SDK to set the audio profile and scenario in your app.
Describes how to use the Agora <Vg k="VSDK" /> to set the audio profile and scenario in your app.
---

import AudioProfile from '@site/versioned_docs/version-3.x/shared/interactive-live-streaming/basic-features/audio-profiles/index.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'Set the Video Profile'
sidebar_position: 8
description: >
Describes how to use the Agora RTC SDK to set the video profile and scenario in your app.
Describes how to use the Agora <Vg k="VSDK" /> to set the video profile and scenario in your app.
---

import VideoProfile from '@site/versioned_docs/version-3.x/shared/interactive-live-streaming/basic-features/video-profiles/index.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'Pricing'
sidebar_position: 3
description: >
Explains how Agora calculates your monthly bill for using RTC products.
Explains how Agora calculates your monthly bill for using <Vg k="VSDK" /> products.
---

import Pricing from '@site/versioned_docs/version-3.x/shared/interactive-live-streaming/introduction/_pricing.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'Interactive Live Streaming Overview'
sidebar_position: 1
description: >
Introduces Agora Interactive Live Streaming Premium that enables one-to-many and many-to-many audio or video live streaming with the Agora RTC SDK.
Introduces Agora Interactive Live Streaming Premium that enables one-to-many and many-to-many audio or video live streaming with the Agora <Vg k="VSDK" />.
---

import Overview from '@site/versioned_docs/version-3.x/shared/interactive-live-streaming/introduction/_product-overview.mdx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ Calling `startPreview` before joining a channel reduces the render time of the f

## Interoperability with the Web SDK

If you are using Native SDKs earlier than v3.0.0 in interactive live streaming scenario, and your scenario involves the RTC SDK for Web, ensure that you call `enableWebSdkInteroperability` before joining a channel.
If you are using Native SDKs earlier than v3.0.0 in interactive live streaming scenario, and your scenario involves the <Vg k="VSDK" /> for Web, ensure that you call `enableWebSdkInteroperability` before joining a channel.

<div class="alert info">As of v3.0.0, the interoperability between the Native SDK and the Web SDK is enabled by default.</div>
34 changes: 17 additions & 17 deletions version-3.x/shared/common/_downloads-more-video.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ This section provides links to download more versions of the SDK and describes w

|Platform | SDK download link | Version baseline |
|------- |-------|--------|
|Android | [v3.7.0.2](https://download.agora.io/sdk/release/Agora_Native_SDK_for_Android_v3_7_0_2_FULL.zip) | <Link target="_blank" to="../introduction/release-notes?platform=android">v3.7.0.1</Link> |
|iOS | [v3.7.0.2](https://download.agora.io/sdk/release/Agora_Native_SDK_for_iOS_v3_7_0_2_FULL.zip) | <Link target="_blank" to="../introduction/release-notes?platform=ios">v3.7.0</Link> |
|macOS| [v3.7.0.2](https://download.agora.io/sdk/release/Agora_Native_SDK_for_Mac_v3_7_0_2_FULL.zip) | <Link target="_blank" to="../introduction/release-notes?platform=macos">v3.7.0</Link> |
|Windows | [v3.7.0.2](https://download.agora.io/sdk/release/Agora_Native_SDK_for_Windows_v3_7_0_2_FULL.zip) | <Link target="_blank" to="../introduction/release-notes?platform=windows-cpp">v3.7.0</Link> |
|Android | [v3.7.0.2](https://download.agora.io/sdk/release/Agora_Native_SDK_for_Android_v3_7_0_2_FULL.zip) | <Link target="_blank" to="../introduction/release-notes">v3.7.0.1</Link> |
|iOS | [v3.7.0.2](https://download.agora.io/sdk/release/Agora_Native_SDK_for_iOS_v3_7_0_2_FULL.zip) | <Link target="_blank" to="../introduction/release-notes">v3.7.0</Link> |
|macOS| [v3.7.0.2](https://download.agora.io/sdk/release/Agora_Native_SDK_for_Mac_v3_7_0_2_FULL.zip) | <Link target="_blank" to="../introduction/release-notes">v3.7.0</Link> |
|Windows | [v3.7.0.2](https://download.agora.io/sdk/release/Agora_Native_SDK_for_Windows_v3_7_0_2_FULL.zip) | <Link target="_blank" to="../introduction/release-notes">v3.7.0</Link> |


## Release notes
Expand All @@ -20,10 +20,10 @@ This section provides release notes for more versions of the SDK.

v3.7.0.2 was developed from v3.7.0 and released on June 6, 2022, for Android, iOS, macOS, and Windows.

- <Link target="_blank" to="../introduction/release-notes?platform=android">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=ios">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=macos">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=windows-cpp">Windows Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Windows Release Notes</Link>


### v3.6.3
Expand Down Expand Up @@ -116,10 +116,10 @@ This release fixed a crash of the SDK on systems earlier than macOS 10.11. This

v3.6.2 was developed from v3.6.1.1 and released on February 22, 2022 for Android, iOS, macOS, and Windows.

- <Link target="_blank" to="../introduction/release-notes?platform=android">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=ios">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=macos">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=windows-cpp">Windows Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Windows Release Notes</Link>


### v3.5.3
Expand Down Expand Up @@ -221,10 +221,10 @@ This release fixed the following issues:

v3.5.2 was developed from v3.5.1 and released on November 25, 2021 for Android, iOS, macOS, and Windows.

- <Link target="_blank" to="../introduction/release-notes?platform=android">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=ios">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=macos">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=windows-cpp">Windows Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Windows Release Notes</Link>

### v3.4.11

Expand Down Expand Up @@ -342,4 +342,4 @@ This release fixed the following issues:
- Occasional crashes occurred in audio scenarios. (Android, iOS)
- When `pauseAudioMixing` was called before playing an audio file, and then `startAudioMixing` was called to play the audio file, playback failed. (iOS)
- Remote users heard slightly unsynchronized voice and music when a user called `startAudioMixing` on some Android devices.
- A naming conflict existed in the `AgoraReachability` class between the Agora RTC SDK and Agora RTM SDK. (iOS, macOS)
- A naming conflict existed in the `AgoraReachability` class between the Agora <Vg k="VSDK" /> and Agora <Vg k="MESS_SDK" />. (iOS, macOS)
26 changes: 13 additions & 13 deletions version-3.x/shared/common/_downloads-more-voice.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ This section provides release notes for more versions of the SDK.

v3.7.0.2 was developed from v3.7.0 and released on June 6, 2022, for Android, iOS, macOS, and Windows.

- <Link target="_blank" to="../introduction/release-notes?platform=android">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=ios">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=macos">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=windows-cpp">Windows Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Windows Release Notes</Link>

### v3.6.3

Expand Down Expand Up @@ -65,10 +65,10 @@ This release fixed a crash of the SDK on systems earlier than macOS 10.11. This

v3.6.2 was developed from v3.6.1.1 and released on February 22, 2022 for Android, iOS, macOS, and Windows.

- <Link target="_blank" to="../introduction/release-notes?platform=android">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=ios">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=macos">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=windows-cpp">Windows Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Windows Release Notes</Link>


### v3.5.3
Expand Down Expand Up @@ -127,10 +127,10 @@ This release fixed the following issues:

v3.5.2 was developed from v3.5.1 and released on November 25, 2021 for Android, iOS, macOS, and Windows.

- <Link target="_blank" to="../introduction/release-notes?platform=android">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=ios">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=macos">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes?platform=windows-cpp">Windows Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Android Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">iOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">macOS Release Notes</Link>
- <Link target="_blank" to="../introduction/release-notes">Windows Release Notes</Link>


### v3.4.11
Expand Down Expand Up @@ -228,4 +228,4 @@ This release fixed the following issues:
- Occasional crashes occurred in audio scenarios. (Android, iOS)
- When `pauseAudioMixing` was called before playing an audio file, and then `startAudioMixing` was called to play the audio file, playback failed. (iOS)
- Remote users heard slightly unsynchronized voice and music when a user called `startAudioMixing` on some Android devices.
- A naming conflict existed in the `AgoraReachability` class between the Agora RTC SDK and Agora RTM SDK. (iOS, macOS)
- A naming conflict existed in the `AgoraReachability` class between the Agora <Vg k="VSDK" /> and Agora <Vg k="MESS_SDK" />. (iOS, macOS)
4 changes: 2 additions & 2 deletions version-3.x/shared/common/_echo-cancellation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ In real-time engagements, the audio signal often produces echoes due to the foll

![1626951614156](https://web-cdn.agora.io/docs-files/1626951614156)

The Agora RTC SDK enables its own echo cancellation algorithm by default. In indoor scenarios such as conferences or hybrid-learning classrooms, however, factors such as unfavorable environmental factors and the use of multiple external audio devices can reduce the effectiveness of the echo cancellation. This page describes how to avoid echoes in indoor scenarios.
The Agora <Vg k="VSDK" /> enables its own echo cancellation algorithm by default. In indoor scenarios such as conferences or hybrid-learning classrooms, however, factors such as unfavorable environmental factors and the use of multiple external audio devices can reduce the effectiveness of the echo cancellation. This page describes how to avoid echoes in indoor scenarios.

## Choose an environment without reflective materials

Expand Down Expand Up @@ -77,7 +77,7 @@ If a user plays media resources such as the background music, audio effects, and
<th width="35%">Usage</th>
</thead>
<tr>
<td rowspan="3">Agora RTC SDK</td>
<td rowspan="3">Agora <Vg k="VSDK" /></td>
<td rowspan="2"><li>Android</li><li>iOS</li><li>macOS</li><li>Windows</li><li>Electron</li><li>Unity</li><li>Flutter</li><li>React Native</li></td>
<td><code>startAudioMixing</code></td>
<td><li>Needs the path of an audio resource.</li><li>Supports playing only one audio resource.</li><li>Supports playing an audio resource on the local client and publishing the audio resource to all remote clients.</li></td>
Expand Down
6 changes: 3 additions & 3 deletions version-3.x/shared/common/_error-codes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This article provides descriptions and troubleshooting tips for common Agora SDK

## Native platforms and third-party frameworks

This section applies to the Agora RTC SDKs designed for:
This section applies to the Agora <Vg k="VSDK" /> SDKs designed for:

- Native platforms, such as Android, iOS, macOS, and Windows.
- Third-party frameworks (third-party platforms where native app code is wrapped), such as Electron, Unity, React Native, and Flutter.
Expand Down Expand Up @@ -202,5 +202,5 @@ The error and warning codes may be returned in the following ways:

## Web

- If you use the Agora RTC Web SDK 3.x or earlier versions, see [error codes](https://api-ref.agora.io/en/video-sdk/web/3.x/index.html#error-codes) and [warning codes](https://api-ref.agora.io/en/video-sdk/web/3.x/index.html#warning-codes).
- If you use the Agora RTC Web SDK 4.x, see [error codes](https://api-ref.agora.io/en/video-sdk/web/4.x/index.html#error-code).
- If you use the Agora <Vg k="VSDK" /> Web SDK 3.x or earlier versions, see [error codes](https://api-ref.agora.io/en/video-sdk/web/3.x/index.html#error-codes) and [warning codes](https://api-ref.agora.io/en/video-sdk/web/3.x/index.html#warning-codes).
- If you use the Agora <Vg k="VSDK" /> Web SDK 4.x, see [error codes](https://api-ref.agora.io/en/video-sdk/web/4.x/index.html#error-code).
24 changes: 12 additions & 12 deletions version-3.x/shared/common/_firewall.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ The following table lists the support of Agora products for the two solutions:

|Agora Products| Firewall Whitelist|Agora Cloud Proxy|
|---------|-------------------|------------------|
|RTC SDK (Native, third-party frameworks) |||
|RTC SDK (Web) |||
|RTM SDK (Native, Web)|||
|On-premise Recording SDK|||
|<Vg k="VSDK" /> (Native, third-party frameworks) |||
|<Vg k="VSDK" /> (Web) |||
|<Vg k="MESS_SDK" /> (Native, Web)|||
|On-Premise Recording SDK|||
|Interactive Gaming SDK |||

- When using the firewall whitelist, refer to **this page** to add the domains and ports to the firewall whitelist, and do not set restrictions on IP addresses.
- When using Agora cloud proxy, refer to the following pages:
- <Link to="../basic-features/use-cloud-proxy?platform=android">Cloud Proxy for RTC SDK (Native, third-party frameworks)</Link>
- <Link to="../basic-features/use-cloud-proxy?platform=web">Cloud Proxy for RTC SDK (Web)</Link>
- <Link to="/on-premise-recording/develop/cloud-proxy?platform=linux-cpp">Cloud proxy for On-premise Recording SDK</Link>
- <Link to="../basic-features/use-cloud-proxy">Cloud Proxy for <Vg k="VSDK" /> (Native, third-party frameworks)</Link>
- <Link to="../basic-features/use-cloud-proxy">Cloud Proxy for <Vg k="VSDK" /> (Web)</Link>
- <Link to="/on-premise-recording/develop/cloud-proxy">Cloud proxy for On-Premise Recording SDK</Link>

<div class="alert note"><li>If you want to use Agora products across a VPN, ensure that you have contacted the VPN operator to add the corresponding ports to the whitelist; otherwise, you may encounter undefined behaviors such as call failure. </li><li>Unless otherwise specified, the source address is the client that integrates the Agora SDK. </li></div>

## RTC SDK
## <Vg k="VSDK" />

### RTC SDK (Web)
### <Vg k="VSDK" /> (Web)

Add the following destination domains and the corresponding ports to your firewall whitelist, depending on the version of the Web SDK you are using.

Expand Down Expand Up @@ -75,9 +75,9 @@ Add the following destination domains and the corresponding ports to your firewa
| 80; 443; 3433; 4700 - 5000; 5668; 5669; 6080; 6443; 8667; 9667; 30011 - 30013 (for Media Push)| TCP | Allow |
| 3478; 4700 - 5000 (2.9.0 or later); 10000 - 65535 (before 2.9.0) | UDP | Allow |

## RTM SDK
## <Vg k="MESS_SDK" />

### RTM SDK (Native)
### <Vg k="MESS_SDK" /> (Native)

Add the following destination domains and the corresponding ports to the firewall whitelist:

Expand All @@ -90,7 +90,7 @@ Add the following destination domains and the corresponding ports to the firewal
| 8443; 9130; 9131; 9136; 9137; 9140, 9141 | TCP | Allow |
| 1080; 8000; 8130; 8443; 9120; 9121; 9700; 25000 | UDP | Allow |

### RTM SDK (Web)
### <Vg k="MESS_SDK" /> (Web)

Add the following destination domains and the corresponding ports to the firewall whitelist:

Expand Down
Loading

0 comments on commit af8db60

Please sign in to comment.