Skip to content

Commit

Permalink
First batch
Browse files Browse the repository at this point in the history
  • Loading branch information
atovpeko committed Oct 19, 2023
1 parent 9c2f6fb commit 1a9a3df
Show file tree
Hide file tree
Showing 8 changed files with 204 additions and 12 deletions.
36 changes: 35 additions & 1 deletion cloud-recording/develop/integration-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,41 @@ You use Cloud Recording RESTful APIs to get the status of the recording service.

Best practice is that core apps do not rely on <Vg k="NCS_LONG" /> (<Vg k="NCS" />). If your apps already rely heavily on the <Vg k="NCS" />, contact <a href="mailto:[email protected]">[email protected]</a> and enable the redundant message notification function. This doubles the received notifications and reduces the probability of message loss. After enabling the message notification function, you need to deduplicate messages based on `sid`. Message notification still cannot guarantee a 100% arrival rate.

The initial QPS limit is 10 per App ID when you register. You can estimate the QPS quota your project needs according to your Peak Concurrent Worker (PCW) quota and query frequency. The initial PCW limit is 50 per AppID when you register. If the RESTful API returns QPS limitation error code `429`, or PCW quota limitation error code `406`, then retry, or contact [email protected] to increase your QPS or PCW quota.
### Check the PCW and QPS limits

Check that the Peak Concurrent Worker (PCW) and Queries per Second (QPS) values under your App ID do not exceed the Agora limits.

#### PSW

PCW limitations depend on your video stream resolution and region:

| Service type | Mainland China | Europe | America | Asia (excluding mainland China) |
|:---------------------|:----------------------|:---------------------|:----------------------|:--------------------------------|
| Individual recording | 1000 | 200 | 400 | 300 |
| Composite recording | SD 100, HD 50, FHD 30 | SD 50, HD 30, FHD 10 | SD 100, HD 50, FHD 30 | SD 100, HD 50, FHD 30 |

Resolution description:

- SD: Standard definition video, resolution ≤ 640 × 360
- HD: High definition video, resolution ≤ 1280 × 720 and > 640 × 360
- FHD: Full HD video, resolution ≤ 1920 × 1080 and > 1280 × 720

If you need to extend the limit for PSW, please contact [email protected].

#### QPS

The initial QPS limit is 10 per App ID when you register. You can estimate the QPS that your project needs according to your Peak Concurrent Worker (PCW) value and query frequency. If you need to extend the limit for QPS, please contact [email protected].

### Check the stream limit

The upper limit of video attributes supported by Agora is as follows: resolution 1920 × 1080, frame rate 30 FPS.
The maximum number of supported streams is detailed in the table below:

| Service type | Mainland China | Europe | America | Asia (excluding mainland China) |
|:----------------|:----------------------|:---------------------|:----------------------|:--------------------------------|
| Cloud recording | SD 100, HD 50, FHD 30 | SD 50, HD 30, FHD 10 | SD 100, HD 50, FHD 30 | SD 100, HD 50, FHD 30 |

<Admonition type="caution" title="Important">If you need to record multiple streams of different resolutions at the same time, make sure you meet the following requirements:<ul><li>The number of streams in each resolution cannot exceed the corresponding limit for that resolution.</li><li>The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need to use cloud recording service in mainland China to record both SD and HD, the total number of streams cannot exceed 100. If you record both HD and FHD, the total number cannot exceed 50.</li></ul></Admonition>

### Ensure the recording service starts successfully

Expand Down
35 changes: 35 additions & 0 deletions cloud-recording/develop/webpage-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,41 @@ External factors can cause problems with web page recording, including the follo

To ensure reliability and consistency in the face of network issues, Agora recommends the following best practices.

### Check the PCW and QPS limits

Check that the Peak Concurrent Worker (PCW) and Queries per Second (QPS) values under your App ID do not exceed the Agora limits.

#### PSW

PCW limitations depend on your video stream resolution and region:

| Service type | Mainland China | Europe | America | Asia (excluding mainland China) |
|:---------------------|:----------------------|:---------------------|:----------------------|:--------------------------------|
| Web page recording | SD 100, HD 50, FHD 30 | SD 50, HD 30, FHD 10 | SD 100, HD 50, FHD 30 | SD 100, HD 50, FHD 30 |

Resolution description:

- SD: Standard definition video, resolution ≤ 640 × 360
- HD: High definition video, resolution ≤ 1280 × 720 and > 640 × 360
- FHD: Full HD video, resolution ≤ 1920 × 1080 and > 1280 × 720

If you need to extend the limit for PSW, please contact [email protected].

#### QPS

The initial QPS limit is 10 per App ID when you register. You can estimate the QPS that your project needs according to your Peak Concurrent Worker (PCW) value and query frequency. If you need to extend the limit for QPS, please contact [email protected].

### Check the stream limit

The upper limit of video attributes supported by Agora is as follows: resolution 1920 × 1080, frame rate 30 FPS.
The maximum number of supported streams is detailed in the table below:

| Service type | Mainland China | Europe | America | Asia (excluding mainland China) |
|:----------------|:----------------------|:---------------------|:----------------------|:--------------------------------|
| Page recording | SD 100, HD 50, FHD 30 | SD 50, HD 30, FHD 10 | SD 100, HD 50, FHD 30 | SD 100, HD 100, FHD 30 |

<Admonition type="caution" title="Important">If you need to record multiple streams of different resolutions at the same time, make sure you meet the following requirements:<ul><li>The number of streams in each resolution cannot exceed the corresponding limit for that resolution.</li><li>The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need to use the web page recording service in mainland China to record both SD and HD, the total number of streams cannot exceed 100. If you record both HD and FHD, the total number cannot exceed 50.</li></ul></Admonition>

### Ensure the recording service starts successfully

Take the following steps to ensure that the recording service starts successfully:
Expand Down
8 changes: 6 additions & 2 deletions flexible-classroom/get-started/enable-flexible-classroom.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -217,10 +217,10 @@ To enable and configure Chat:

## Considerations

To ensure that Agora can access files in your third-party cloud storage space, you should enable public access or higher permissions for third-party storage spaces.

#### AWS S3 account configuration

To ensure that Agora can access files in your third-party cloud storage space, you should enable public access or higher permissions for third-party storage spaces.

Configure your AWS S3 account as follows:

* Bucket policy
Expand Down Expand Up @@ -265,6 +265,10 @@ Configure your AWS S3 account as follows:
```
![](/images/flexible-classroom/configure-aws-ss2.png)

#### Service limit

Flexible Classroom supports a maximum of 10,000 people online at the same time. If you need to extend your limit, contact technical support.

## Next steps

After enabling the <Vg k="FC"/> service, see how to [quickly launch a classroom](../get-started).
28 changes: 25 additions & 3 deletions media-pull/develop/integration-best-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,32 @@ The following table shows the limits the number of queries per second (QPS) to t

When the QPS is exceeded, the status code `429` (Too Many Requests) is returned. If you need a higher QPS limit, contact technical support.

### Maximum number of concurrent tasks
### PSW

The default maximum number of concurrent tasks is 50, which indicates that a maximum of 50 <Vg k="MPULL" /> tasks can be run simultaneously in one project.
If a higher quota is required, contact technical support.
PCW limitations depend on your video stream resolution and region:

| Service type | Mainland China | Europe | America | Asia (excluding mainland China) |
|:-------------|:----------------------|:----------------------|:----------------------|:--------------------------------|
| Media Pull | SD 20, HD 20, FHD 10 | SD 20, HD 10, FHD 5 |SD 20, HD 10, FHD 5 | SD 20, HD 20, FHD 5 |

Resolution description:

- SD: Standard definition video, resolution ≤ 640 × 360
- HD: High definition video, resolution ≤ 1280 × 720 and > 640 × 360
- FHD: Full HD video, resolution ≤ 1920 × 1080 and > 1280 × 720

If you need to extend the limit for PSW, please contact [email protected].

### Number of streams

The upper limit of video attributes supported by Agora is as follows: resolution 1920 × 1080, frame rate 30 FPS.
The maximum number of supported streams is detailed in the table below:

| Service type | Mainland China | Europe | America | Asia (excluding mainland China) |
|:---------------|:----------------------|:---------------------|:----------------------|:--------------------------------|
| Media Pull | SD 20, HD 20, FHD 10 | SD 20, HD 10, FHD 5 | SD 20, HD 10, FHD 5 | SD 20, HD 20, FHD 5 |

<Admonition type="caution" title="Important">If you need to pull multiple streams of different resolutions at the same time, make sure you meet the following requirements:<ul><li>The number of streams in each resolution cannot exceed the corresponding limit for that resolution.</li><li>The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need both SD and HD streams in mainland China, the total number of streams cannot exceed 100. For HD and FHD, the total number cannot exceed 50.</li></ul></Admonition>

## Ensure the high availability of REST services

Expand Down
30 changes: 25 additions & 5 deletions media-push/develop/integration-best-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,39 @@ The Agora server limits the number of queries per second (QPS) to the Media Push
When the QPS is exceeded, the status code `429` (Too Many Requests)
is returned. If you need a higher QPS limit, contact technical support.


|API |QPS limit |
|:---------|:-----------------------------------------------------------------------|
|Create |Creating a converter is limited to 50 queries per second.|
|Delete |Deleting a converter is limited to 50 queries per second.|
|Update |Updating a specified converter is limited to 50 queries per second.|
|Get |Getting the request rate of a specified converter is limited to 50 queries per second.|

### Maximum number of concurrent tasks
### PSW

PCW limitations depend on your video stream resolution and region:

| Service type | Mainland China | Europe | America | Asia (excluding mainland China) |
|:-------------|:----------------------|:----------------------|:----------------------|:--------------------------------|
| Media Push | SD 300, HD 50, FHD 20 | SD 20, HD 5, FHD 0 |SD 20, HD 5, FHD 0 | SD 20, HD 5, FHD 0 |

Resolution description:

- SD: Standard definition video, resolution ≤ 640 × 360
- HD: High definition video, resolution ≤ 1280 × 720 and > 640 × 360
- FHD: Full HD video, resolution ≤ 1920 × 1080 and > 1280 × 720

If you need to extend the limit for PSW, please contact [email protected].

### Number of streams

The upper limit of video attributes supported by Agora is as follows: resolution 1920 × 1080, frame rate 30 FPS.
The maximum number of supported streams is detailed in the table below:

| Service type | Mainland China | Europe | America | Asia (excluding mainland China) |
|:---------------|:----------------------|:---------------------|:----------------------|:--------------------------------|
| Media Push | SD 300, HD 50, FHD 20 | SD 20, HD 5, FHD 0 | SD 20, HD 5, FHD 0 | SD 20, HD 5, FHD 0 |

The default maximum number of concurrent tasks is 20, which indicates
that a maximum of 20 Media Push tasks can be run simultaneously in one
project. If a higher quota is required, contact technical support.
<Admonition type="caution" title="Important">If you need to push multiple streams of different resolutions at the same time, make sure you meet the following requirements:<ul><li>The number of streams in each resolution cannot exceed the corresponding limit for that resolution.</li><li>The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need both SD and HD streams in mainland China, the total number of streams cannot exceed 100. For HD and FHD, the total number cannot exceed 50.</li></ul></Admonition>

## Ensure the high availability of REST services

Expand Down
50 changes: 50 additions & 0 deletions shared/video-sdk/reference/_service_limits.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Agora imposes the following limits on PCU (Peak Concurrent Users), PCW (Per-Channel Workrate), and bandwidth:

<table>
<thead>
<tr>
<th>Serve</th>
<th>PCU/PCW/Bandwidth</th>
<th>Domestic</th>
<th>Europe</th>
<th>America</th>
<th>Asia</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="2">Real-time communication</td>
<td>PCU</td>
<td>10K</td>
<td>10K</td>
<td>10K</td>
<td>10K</td>
</tr>
<tr>
<td>Bandwidth</td>
<td>10G</td>
<td>10G</td>
<td>10G</td>
<td>10G</td>
</tr>
<tr>
<td>Media push</td>
<td>PCW</td>
<td>SD:200 HD:50 FHD: 20</td>
<td>SD:50 HD:20 FHD: 5</td>
<td>SD:50 HD:20 FHD: 5</td>
<td>SD:50 HD:20 FHD: 5</td>
</tr>
</tbody>
</table>

PCU refers to the maximum number of people online at the same time, while PCW refers to the maximum number of concurrent tasks. The bandwidth calculation formula is as follows:

PCU × host’s sending bit rate × number of concurrent hosts (single channel).

For basic real-time interaction scenarios, the limit is reached when PCU or bandwidth reaches its corresponding limit.
For Media Push, the limit depends on the video resolution and is reached When PCW of any resolution reaches its respective limit.

To ensure that your project runs smoothly, check the PCU, PCW, and bandwidth in your project regularly to ensure that all indicators are within the limit. If you need to extend the limit as your business grows, contact technical support.


17 changes: 16 additions & 1 deletion signaling/reference/limitations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A brief overview of the limitations of the Agora <Vg k="MESS_SDK" />, including

## Channel message limit

The Agora <Vg k="MESS_SDK" /> does not have a limit on the number of concurrent online users. However, Agora has the following recommendations on the maximum number of channel messages per second for a single channel:
Agora has the following recommendations on the maximum number of channel messages per second for a single channel:

| Concurrent online users in a single channel | Number of channel messages per second |
| ------------------------------------------- | ----------------------------- |
Expand All @@ -33,6 +33,21 @@ Agora provides customized service to increase the number of messages per second

<Limitations PRODUCT="Signaling" CLIENT="app" PATH="signaling" />

## Service quota limits

The following table lists the service quota limits for <Vg k="MESS_SDK" />. When any of the following indicators exceed the limit,
contact technical support to extend it.


|Item |Limit |
|:--------------------------------------------|:------------------|
|RESTful API requests per second per App ID |500 |
|Increment in the number of concurrent users |50,000 |
|Increment in the number of daily active users|500,000 |
|Number of users on a single channel |50,000 |
|The number of users of a single channel is greater than 10,000 and the total number of messages sent by the channel per second is greater than 100 |/ |


## Miscellaneous

- Notifications of a member joining or leaving the channel are automatically disabled when the number of channel members exceeds 512.
Expand Down
12 changes: 12 additions & 0 deletions video-calling/reference/service-limits.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Service limits
sidebar_position: 1
description: >
Provides you with information on service limits
---

import ServiceLimits from '@docs/shared/video-sdk/reference/_service_limits.mdx';

export const toc = [{}]

<ServiceLimits PRODUCT="Video Calling" CLIENT="app" PATH="video-calling" />

0 comments on commit 1a9a3df

Please sign in to comment.