Skip to content

Commit

Permalink
Review changes are updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mntrspace
mntrspace committed Oct 11, 2023
1 parent f6d93a6 commit 8de3968
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 21 deletions.
7 changes: 1 addition & 6 deletions docs/server-side/v2/api-reference/Rooms/create-via-api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ curl --location --request POST 'https://api.100ms.live/v2/rooms' \
--data-raw '{
"name": "new-room-1662723668",
"description": "This is a sample description for the room",
"template_id": "<template_id of the template you wish to associate with the room>",
"large_room": true,
"size":20000
"template_id": "<template_id of the template you wish to associate with the room>"
}'
```

Expand All @@ -31,16 +29,13 @@ curl --location --request POST 'https://api.100ms.live/v2/rooms' \
"enabled": true,
"description": "This is a sample description for the room",
"customer_id": "627cdddff2e4e30487862ad1",
"customer":"627cdddff2e4e30487862ad1",
"app_id":"62510797903d857ab8ec3ba5",
"recording_info": {
"enabled": false
},
"template_id": "63188115d11d6db790c73c60",
"template": "sample-template-name",
"region": "us",
"size": 20000,
"large_room": true,
"created_at": "2022-09-09T11:41:08.082Z",
"updated_at": "2022-09-09T11:41:08.074Z"
}
Expand Down
4 changes: 2 additions & 2 deletions docs/server-side/v2/api-reference/Rooms/list-rooms.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ curl --location --request GET 'https://api.100ms.live/v2/rooms' \
"name": "test-room",
"enabled": true,
"description": "This is a test room",
"customer": "627cda********a39291b",
"customer_id": "627cda********a39291b",
"recording_source_template": true,
"template_id": "627cd********784227d3",
"template": "default_createown_e319635a-****-****-****-ae9e95891e31",
Expand All @@ -53,7 +53,7 @@ curl --location --request GET 'https://api.100ms.live/v2/rooms' \
"name": "4b2705aa-****-****-****-f470c06d0c03",
"enabled": true,
"description": "This is a test room",
"customer": "627cd********037a39291b",
"customer_id": "627cd********037a39291b",
"recording_source_template": false,
"recording": {
"enabled": false
Expand Down
7 changes: 4 additions & 3 deletions docs/server-side/v2/api-reference/Rooms/object.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,14 @@ nav: 2.2
| name | Alias for the room |
| enabled | Indicates whether the room is enabled or disabled. <br/><br/> **Note:** If you disable a room, that room can be used for only the current session and users will not be able to join the room later. You can use the [Disable/Enable a room API](/server-side/v2/Rooms/disable-or-enable) with the `enabled` param set to `true` to enable the room again. |
| description | Description for the room |
| customer | Unique identifier for your account |
| customer_id | Unique identifier for your account |
| customer (deprecated) | Unique identifier for your account same as `customer_id` |
| recording_info | Indicates whether the recording is enabled or disabled. <br/><br/> **Note:** `enabled` [argument](/server-side/v2/Rooms/create-via-api#recording-info-arguments) in this object is only applicable to enable/disable [SFU recording](/server-side/v2/Destinations/recording). Refer to [RTMP Streaming & Browser Recording](/server-side/v2/Destinations/rtmp-streaming-and-browser-recording) guide for other options. |
| template_id | Identifier for the template used for this room |
| template (deprecated) | Name for the template (This field is deprecated. To find template name, fetch template using template_id) |
| region | The region in which the room has to be created |
| large_room | Indicates whether the room is capable of supporting large number of peers (>2500) on their conferencing / live streaming setup or not. The client side SDKs are required to be updated to a certain version to support this update |
| size | Indicates the maximum number of peers who can join the given room | |
| large_room | Indicates whether the room is capable of supporting large number of peers (>2500) on the conferencing / live streaming setup or not. The client side SDKs are required to be updated to a certain version to support this update. Learn more about enabling large rooms [here](/server-side/v2/how-to-guides/create-large-rooms) |
| size | Indicates the maximum number of peers who can join the given room |

## Postman collection

Expand Down
2 changes: 1 addition & 1 deletion docs/server-side/v2/api-reference/Rooms/retrieve-room.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ curl --location --request GET 'https://api.100ms.live/v2/rooms/<room_id>' \
"name": "sampleroom",
"enabled": true,
"description": "This is sample description for room",
"customer": "627cdddff2e4e30487862ad1",
"customer_id": "627cdddff2e4e30487862ad1",
"recording_source_template": false,
"recording_info": {
"enabled": true,
Expand Down
4 changes: 4 additions & 0 deletions docs/server-side/v2/changelog/release-notes.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ nav: 5.1

This Changelog highlights notable changes to the 100ms server-side API, such as API additions, improvements, and deprecations. Also, we've included developer experience improvements to this page to keep you on track with items that will enhance your integration journey.

### 2023-10-11

- Added support for large room creation through the [Room API](/server-side/v2/api-reference/Rooms/overview). Learn more about it in [this guide](/server-side/v2/how-to-guides/create-large-rooms).

### 2023-08-01
- Added Optimisations to reduce RTMP streaming and recording start delay

Expand Down
19 changes: 10 additions & 9 deletions docs/server-side/v2/how-to-guides/create-large-rooms.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Utilisation of first class APIs in the SDKs to handle hand-raise and peer list f

## Create a large room

Large rooms work similarly to your normal 100ms rooms in their function. The scale optimisations kick in when a large number of peers join the room. Use 100ms' server-side [Create Room API](/server-side/v2/api-reference/Rooms/create-via-api) to create a room with the `large_room` flag enabled. Use the `size` field to define the maximum number of expected peers in that room.
Standard 100ms rooms handle up to 2500 peers. Large rooms need to be created with special scale optimizations to handle a large number of peers while functioning similarly to standard 100ms rooms. Use 100ms' server-side [Create Room API](/server-side/v2/api-reference/Rooms/create-via-api) to create a room with the `large_room` flag enabled. Use the `size` field to define the maximum number of expected peers in that room.
The following cURL example illustrates how to create a large room.

<PostRequest title="https://api.100ms.live/v2/rooms" />
Expand Down Expand Up @@ -67,23 +67,23 @@ curl --location --request POST 'https://api.100ms.live/v2/rooms' \
</ResponseBox>

When using the above API, following points need to be noted:
1. The range of values for `size` is 0 to 2500 when the `large_room` flag is disabled. Expect the following error if a value larger than 2500 is used.
```json
{
1. The range of values for `size` can go up to 20,000 when the `large_room` flag is enabled. Expect the following error if a value larger than 20,000 is used.
```json
{
"code": 400,
"message": "Invalid body param",
"details": [
"Invalid body param: room size greater than 2500, set large_room flag as true"
"Invalid body param: room size greater than 20000"
]
}
```
2. The range of values for `size` can go up to 20,000 when the `large_room` flag is enabled. Expect the following error if a value larger than 20,000 is used.
```json
{
2. All rooms which require the `size` to be greater than 2500 need to have the `large_room` flag enabled. Expect the following error if a value larger than 2500 is used without enabling the flag.
```json
{
"code": 400,
"message": "Invalid body param",
"details": [
"Invalid body param: room size greater than 20000"
"Invalid body param: room size greater than 2500, set large_room flag as true"
]
}
```
Expand Down Expand Up @@ -131,3 +131,4 @@ If the room is very large, it is difficult to fetch each and every peer. To get




0 comments on commit 8de3968

Please sign in to comment.