Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove platform query #645

Merged
merged 12 commits into from
Oct 23, 2022
8 changes: 4 additions & 4 deletions cloud-recording/reference/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ This release adds support for Amazon S3 in the following regions:

#### New features

This release adds `maxVideoDuration` to the [`start`](../reference/rest-api/rest" >}}?platform=RESTful#a-namestartastart-cloud-recording) method to set the maximum duration of the MP4 slice file generated by the web page recording.
This release adds `maxVideoDuration` to the [`start`](../reference/rest-api/rest" >}}#a-namestartastart-cloud-recording) method to set the maximum duration of the MP4 slice file generated by the web page recording.

#### Improvements

Expand All @@ -153,7 +153,7 @@ This version was released on June 10, 2021.

**Network Geofencing**

This release adds the `region` parameter to the [`acquire`](../reference/rest-api/rest" >}}?platform=RESTful#a-nameacquireaget-a-resource-id) method so you can geofence your cloud recording service. If you specify a region, the cloud recording server connects only to the Agora servers within that region. The following regions are supported:
This release adds the `region` parameter to the [`acquire`](../reference/rest-api/rest" >}}#a-nameacquireaget-a-resource-id) method so you can geofence your cloud recording service. If you specify a region, the cloud recording server connects only to the Agora servers within that region. The following regions are supported:

- Mainland China
- Asia, excluding Mainland China
Expand All @@ -174,7 +174,7 @@ Fixed security issues caused by vulnerabilities in Chrome V8.

#### API changes

- Adds the `region` parameter in the [`acquire`](../reference/rest-api/rest" >}}?platform=RESTful#a-nameacquireaget-a-resource-id) method.
- Adds the `region` parameter in the [`acquire`](../reference/rest-api/rest" >}}#a-nameacquireaget-a-resource-id) method.
- Adds `recorderStartTime` in the [`web_recorder_started`](../reference/rest-api/rest-api-overview#70-web_recorder_started-web_recorder_started) callback.
- Adds the [`web_recorder_reload`](../reference/rest-api/rest-api-overview#73-web_recorder_reload) callback.

Expand Down Expand Up @@ -305,7 +305,7 @@ This release improved the availability of the cloud recording service. When a se

In the [`acquire`](../reference/rest-api/acquire) method, adds the `resourceExpiredHour` parameter for setting the time limit for all cloud recording method calls.

Adds the [`session_exit`](../reference/rest-api/rest-api-overview" >}}?platform=All%20Platforms#a-name11a11-session_exit) event, which reports the exit status of the cloud recording service.
Adds the [`session_exit`](../reference/rest-api/rest-api-overview" >}}#a-name11a11-session_exit) event, which reports the exit status of the cloud recording service.


## 2019.11.15
Expand Down
2 changes: 1 addition & 1 deletion cloud-recording/reference/rest-api/rest-api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ After you enable the callback service, when a specified event occurs, the Agora

The following is an example that shows the fields in the request body.
![](https://web-cdn.agora.io/docs-files/1567593635825)
- The fields in the red rectangle are the common fields of all the callback events. For details, see [Notification callback format](https://docs-preview.agoralab.co/en/Agora%20Platform/ncs?platform=All%20Platforms#notification-callback-format).
- The fields in the red rectangle are the common fields of all the callback events. For details, see [Notification callback format](https://docs-preview.agoralab.co/en/Agora%20Platform/ncs#notification-callback-format).
- The fields in the blue rectangle are the common fields in `payload` of all the cloud recording events. For details, see [Fields in payload](#payload).
- The values of `eventType`, `serviceType`, and `details` depend on the event. For details, see [Callback events](#event).

Expand Down
2 changes: 1 addition & 1 deletion extensions-marketplace/overview/product-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: >
img="/images/product-overview/video-calling.png"
quickStartLink="/extensions-marketplace/get-started/quickstart-implement"
apiReferenceLink="/api-reference"
samplesLink="https://github.com/AgoraIO/API-Examples/tree/dev/4.0.0-GA/Android/APIExample/agora-simple-filter"
samplesLink="https://github.com/AgoraIO/API-Examples/tree/main/Android/APIExample/agora-simple-filter"
productFeatures={[
{
title: "Discovery",
Expand Down
2 changes: 1 addition & 1 deletion flexible-classroom/reference/classroom-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Flexible Classroom Cloud Service uses tokens for authentication. You need to put
- The <Vg k="SIG"/> token generated at your server.
- The uid you use to generate the <Vg k="SIG"/> token.

For details, see [Generate an RTM Token](/en/Real-time-Messaging/token_server_rtm).
For details, see [Generate an RTM Token](/signaling/develop/authentication-workflow).

## Create a classroom

Expand Down
6 changes: 3 additions & 3 deletions flexible-classroom/reference/supported-platforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The platforms supported by Flexible Classroom and their compatibility requiremen

| Platform | Compatibility requirements | Recommended hardware settings |
| :------ |:--------| :--------- |
| Web | The browsers supported by the web client of Flexible Classroom are as follows:<ul><li>Windows: <ul><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul><li>macOS:<ul><li>Safari 13 or later</li><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul></li><li>Android:<ul><li>The latest version of Chrome</li><li>The latest version of the WeChat browser</li></ul></li></li><li>iOS:<ul><li>The latest version of Safari, Chrome, and the WeChat browser</li><li>Safari and Chrome on Apple iPad 10.0 or later</li></ul></li></ul> | <li>Using the web client of Flexible Classroom on mobile browsers has several known issues. For details, see the <a href="/en/Video/web_sdk_known_issues?platform=Web#mobile" target="_blank">known issues</a>.</li><li>To ensure a better end-user experience, Agora highly recommends using Flexible Classroom on the latest version of Desktop Chrome.</li> |
| Web | The browsers supported by the web client of Flexible Classroom are as follows:<ul><li>Windows: <ul><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul><li>macOS:<ul><li>Safari 13 or later</li><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul></li><li>Android:<ul><li>The latest version of Chrome</li><li>The latest version of the WeChat browser</li></ul></li></li><li>iOS:<ul><li>The latest version of Safari, Chrome, and the WeChat browser</li><li>Safari and Chrome on Apple iPad 10.0 or later</li></ul></li></ul> | <li>Using the web client of Flexible Classroom on mobile browsers has several known issues. For details, see the <a href="/en/Video/web_sdk_known_issues#mobile" target="_blank">known issues</a>.</li><li>To ensure a better end-user experience, Agora highly recommends using Flexible Classroom on the latest version of Desktop Chrome.</li> |

</PlatformWrapper>

Expand All @@ -40,7 +40,7 @@ The platforms supported by Flexible Classroom and their compatibility requiremen

| Platform | Compatibility requirements | Recommended hardware settings |
| :------ |:--------| :--------- |
| Electron | The browsers supported by the web client of Flexible Classroom are as follows:<ul><li>Windows: <ul><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul><li>macOS:<ul><li>Safari 13 or later</li><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul></li><li>Android:<ul><li>The latest version of Chrome</li><li>The latest version of the WeChat browser</li></ul></li></li><li>iOS:<ul><li>The latest version of Safari, Chrome, and the WeChat browser</li><li>Safari and Chrome on Apple iPad 10.0 or later</li></ul></li></ul> | <li>Using the web client of Flexible Classroom on mobile browsers has several known issues. For details, see the <a href="/en/Video/web_sdk_known_issues?platform=Web#mobile" target="_blank">known issues</a>.</li><li>To ensure a better end-user experience, Agora highly recommends using Flexible Classroom on the latest version of Desktop Chrome.</li> |
| Electron | The browsers supported by the web client of Flexible Classroom are as follows:<ul><li>Windows: <ul><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul><li>macOS:<ul><li>Safari 13 or later</li><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul></li><li>Android:<ul><li>The latest version of Chrome</li><li>The latest version of the WeChat browser</li></ul></li></li><li>iOS:<ul><li>The latest version of Safari, Chrome, and the WeChat browser</li><li>Safari and Chrome on Apple iPad 10.0 or later</li></ul></li></ul> | <li>Using the web client of Flexible Classroom on mobile browsers has several known issues. For details, see the <a href="/en/Video/web_sdk_known_issues#mobile" target="_blank">known issues</a>.</li><li>To ensure a better end-user experience, Agora highly recommends using Flexible Classroom on the latest version of Desktop Chrome.</li> |


</PlatformWrapper>
Expand Down Expand Up @@ -73,7 +73,7 @@ The platforms supported by Flexible Classroom and their compatibility requiremen
| iOS | Supports iPhone or iPad with iOS 10.x or later | <li>iPad mini 4th generation or later</li><li>iPhone 7 or later</li> |
| Windows | Supports Windows 7 or later | <li>Agora recommends using the i5 processor 8th generation or later.</li><li>The RAM should be 8GB and more.</li> |
| macOS | Supports macOS 10.13 or later | <li>For Intel chips: The RAM should be 4GB or more.</li><li>For M1 chips: The RAM should be 8GB or more.</li> |
| Web | The browsers supported by the web client of Flexible Classroom are as follows:<ul><li>Windows: <ul><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul><li>macOS:<ul><li>Safari 13 or later</li><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul></li><li>Android:<ul><li>The latest version of Chrome</li><li>The latest version of the WeChat browser</li></ul></li></li><li>iOS:<ul><li>The latest version of Safari, Chrome, and the WeChat browser</li><li>Safari and Chrome on Apple iPad 10.0 or later</li></ul></li></ul> | <li>Using the web client of Flexible Classroom on mobile browsers has several known issues. For details, see the <a href="/en/Video/web_sdk_known_issues?platform=Web#mobile" target="_blank">known issues</a>.</li><li>To ensure a better end-user experience, Agora highly recommends using Flexible Classroom on the latest version of Desktop Chrome.</li> |
| Web | The browsers supported by the web client of Flexible Classroom are as follows:<ul><li>Windows: <ul><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul><li>macOS:<ul><li>Safari 13 or later</li><li>Chrome 89 or later</li><li>The latest version of Firefox</li></ul></li><li>Android:<ul><li>The latest version of Chrome</li><li>The latest version of the WeChat browser</li></ul></li></li><li>iOS:<ul><li>The latest version of Safari, Chrome, and the WeChat browser</li><li>Safari and Chrome on Apple iPad 10.0 or later</li></ul></li></ul> | <li>Using the web client of Flexible Classroom on mobile browsers has several known issues. For details, see the <a href="/en/Video/web_sdk_known_issues#mobile" target="_blank">known issues</a>.</li><li>To ensure a better end-user experience, Agora highly recommends using Flexible Classroom on the latest version of Desktop Chrome.</li> |

<div class="alert info">The Windows and macOS apps of Flexible Classroom are built with Electron.</div>

Expand Down
8 changes: 4 additions & 4 deletions on-premise-recording/reference/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ Once you enable the built-in encryption, all users in the same channel must use
**MP3 format in composite recording mode**


v3.0.6 adds `Audio_Only_Record` and `Secondary_Recorder` in `cfgFilePath` to get a MP3 file after a composite recording. See [Record a Call](https://docs.agora.io/en/Recording/recording_cmd_cpp?platform=Linux#composite-recording-mode) and [cfgFilePath](https://docs.agora.io/en/Recording/APIReference/recording_cpp/structagora_1_1recording_1_1_recording_config.html?platform=Linux#afd78b4f136e4deeaf310061606e7bc62) for details.
v3.0.6 adds `Audio_Only_Record` and `Secondary_Recorder` in `cfgFilePath` to get a MP3 file after a composite recording. See [Record a Call](https://docs.agora.io/en/Recording/recording_cmd_cpp#composite-recording-mode) and [cfgFilePath](https://docs.agora.io/en/Recording/APIReference/recording_cpp/structagora_1_1recording_1_1_recording_config.html#afd78b4f136e4deeaf310061606e7bc62) for details.

#### Improvements

- You can set the sample rate of the raw audio data in PCM format (`getAudioFrame` is 2 or 3) through the `cfgFilePath` parameter. See [Record a Call](https://docs.agora.io/en/Recording/recording_cmd_cpp?platform=Linux#设置录制格式) for details.
- You can set the sample rate of the raw audio data in PCM format (`getAudioFrame` is 2 or 3) through the `cfgFilePath` parameter. See [Record a Call](https://docs.agora.io/en/Recording/recording_cmd_cpp#设置录制格式) for details.



Expand Down Expand Up @@ -214,7 +214,7 @@ Supports the cloud proxy service. See [Use Cloud Proxy](../develop/cloud-proxy)
- A black frame appears at the beginning of a video in composite recording mode.

## v2.3.4
<div class="alert note">As of December 8, 2021, Agora begins implementing the retirement process for the On-Premise Recording SDK earlier than v3.0.0. See <a href="https://docs.agora.io/en/Recording/recording_sunset?platform=Linux">Service Sunset Plans for On-Premise Recording</a>.</div>
<div class="alert note">As of December 8, 2021, Agora begins implementing the retirement process for the On-Premise Recording SDK earlier than v3.0.0. See <a href="https://docs.agora.io/en/Recording/recording_sunset">Service Sunset Plans for On-Premise Recording</a>.</div>

v2.3.4 was released on August 5, 2019.

Expand Down Expand Up @@ -489,7 +489,7 @@ v1.3 was released on October 20, 2017.
**New features**:

- Adds mixing the audio and video recording functions by adding the <code>mixedVideoAudio</code> and <code>cfgFilePath</code> parameters in the <code>joinChannel</code> method.
- Adds the function of merging the audio and video file of the same uid as one, see [Play the Recording Files](https://docs.agora.io/en/1.14/addons/Recording/tutorial/recording?platform=All%20Platforms).
- Adds the function of merging the audio and video file of the same uid as one, see [Play the Recording Files](https://docs.agora.io/en/1.14/addons/Recording/tutorial/recording).
- Adds the <code>getProperties</code> method to get the recording path immediately after recording is started before joining any channel.
- Modifies the <code>onError</code> and <code>onLeaveChannel</code> callbacks.

Expand Down
2 changes: 1 addition & 1 deletion on-premise-recording/reference/sunset.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you are using the On-Premise Recording SDK earlier than v3.0.0, upgrade as so

The latest versions of the On-Premise Recording SDK have made significant improvements to user experience, service reliability, and security. To avoid service disruptions, upgrade the On-Premise Recording SDK that you are using as soon as possible by referring to the following information:

- [SDK download links](https://docs.agora.io/en/Recording/downloads?platform=Linux)
- [SDK download links](https://docs.agora.io/en/Recording/downloads)
- [Release notes](../reference/release-notes)

If you encounter any problems, contact Agora for support.
2 changes: 1 addition & 1 deletion server-gateway/overview/product-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: >
img="/images/server-gateway/server-gateway-overview.png"
quickStartLink="/server-gateway/get-started/integrate-sdk"
apiReferenceLink="/api-reference"
samplesLink="#"
samplesLink="https://download.agora.io/sdk/release/Agora-RTC-x86_64-linux-gnu-v3.8.202.20-20220627_152601-214165.tgz"
productFeatures={[
{
title: "Support for call centers, education, and testing ",
Expand Down
2 changes: 1 addition & 1 deletion shared/broadcast-streaming/get-started/_custom-domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Agora supports RTMP, HTTP-FLV, and HLS. For details, see [Construct the URL for

### Step 4: Play the live stream

Use the [Agora MediaPlayer Kit](https://docs-preprod.agora.io/en/Interactive%20Broadcast/mediaplayer_special_quickstart_android?platform=Android) or your own player to play the live stream.
Use the [Agora MediaPlayer Kit](https://docs-preprod.agora.io/en/Interactive%20Broadcast/mediaplayer_special_quickstart_android) or your own player to play the live stream.

## Next steps

Expand Down
2 changes: 1 addition & 1 deletion shared/chat-sdk/client-api/_contacts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This page shows how to use the Chat SDK to implement contact management.

Before proceeding, ensure that you meet the following requirements:

- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk?platform={{platform.PATH}}">Get Started with Chat</Link>.
- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk">Get Started with Chat</Link>.
- You understand the API call frequency limits as described in [Limitations](../reference/limitations).

## Implementation
Expand Down
2 changes: 1 addition & 1 deletion shared/chat-sdk/client-api/_user-attributes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This page shows how to use the Chat SDK to implement managing user attributes.

Before proceeding, ensure that you meet the following requirements:

- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk?platform={{platform.PATH}}">Get Started with Chat</Link>.
- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk">Get Started with Chat</Link>.
- Have a thorough understanding of the API call frequency limit, the maximum size of all the attributes of a specified user, and the maximum size of all user attributes in an app. For details, see [Known limitations](../reference/limitations).

## Implementation
Expand Down
2 changes: 1 addition & 1 deletion shared/chat-sdk/client-api/messages/_manage-messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This page introduces how to use the Chat SDK to implement these functionalities.

Before proceeding, ensure that you meet the following requirements:

- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk?platform={{platform.PATH}}">Get Started with Chat</Link>.
- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk">Get Started with Chat</Link>.
- You understand the API call frequency limits as described in [Limitations](/agora-chat/reference/limitations).

## Implementation
Expand Down
2 changes: 1 addition & 1 deletion shared/chat-sdk/client-api/messages/_message-receipts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This page introduces how to use the Chat SDK to implement message receipt functi

Before proceeding, ensure that you meet the following requirements:

- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk?platform={{platform.PATH}}">Get Started with Chat</Link>.
- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk">Get Started with Chat</Link>.
- You understand the API call frequency limits as described in [Limitations](/agora-chat/reference/limitations).
- Message read receipts for chat groups are not enabled by default. To use this feature, contact [email protected].

Expand Down
2 changes: 1 addition & 1 deletion shared/chat-sdk/client-api/messages/_retrieve-messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This page introduces how to use the Chat SDK to retrieve messages from the serve

Before proceeding, ensure that you meet the following requirements:

- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk?platform={{platform.PATH}}">Get Started with Chat</Link>.
- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see <Link to="/agora-chat/get-started/get-started-sdk">Get Started with Chat</Link>.
- You understand the API call frequency limits as described in [Limitations](/agora-chat/reference/limitations).

## Implementation
Expand Down
Loading