Skip to content

Commit

Permalink
Merge branch 'main' into web-release-notes
Browse files Browse the repository at this point in the history
  • Loading branch information
raviteja83 authored Nov 10, 2023
2 parents 4442f10 + f9ca5ae commit 7b8019d
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion common/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Any application built using 100ms' SDK has 2 components.

- `Room` A room is the basic object that 100ms SDKs return on successful connection. This contains references to peers, tracks and everything you need to render a live a/v or live streaming app.
- `Peer` A peer is the object returned by 100ms SDKs that contains all information about a user - name, role, video track etc.
- `Session` A session depicts activity in a room. A session is created when one or more peers join a room to communicate with each other. A single room can have multiple sessions; a unique ID will be assigned to each session. The maximum allowed duration for a session on the 100ms platform is 24 hours, although the default duration is 12 hours.
- `Session` A session depicts activity in a room. A session is created when one or more peers join a room to communicate with each other. A single room can have multiple sessions; a unique ID will be assigned to each session. The maximum allowed duration for a session on the 100ms platform is 12 hours.
- `Track` A track is a segment of media (audio/video) captured from the peer's camera and microphone. Peers in a session publish local tracks and subscribe to remote tracks from other peers.
- `Role` A role defines who can a peer see/hear, the quality at which they publish their video, whether they have permissions to publish video/screenshare, mute someone, change someone's role.
- `Room Code` A Room Code is a unique encrypted short code generated by 100ms for a given Role and Room. A Room Code represents a unique `role` and `room_id` combination.
Expand Down
4 changes: 2 additions & 2 deletions docs/server-side/v2/api-reference/Rooms/create-via-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ curl --location --request POST 'https://api.100ms.live/v2/rooms' \
| region <br/> | `string` | Region in which you want to create a room. <br/><br/> `eu` - European Union <br/><br/> `in` - India <br/><br/> `us` - United States <br/><br/><br/> `auto` Fallback to region of the template (default value) | No |
| large_room <br/> | `boolean` | Enable this flag if the requirement is to support more than 2500 peers in the room. You are also required to update to latest SDKs to support this functionality. By default, this value is set to `false`. Learn more about it in the [large room creation guide](/server-side/v2/how-to-guides/create-large-rooms). | No | | No |
| size <br/> | `int` | This value is used to define the maximum number of peers expected to be joining the given room. Following are the acceptable ranges: <br/> <br/> With `large_room: false`, Minimum `size` = 0; Maximum `size` = 2500 <br/> <br/> With `large_room: true`, Minimum `size` = 0; Maximum `size` = 20000 | No |
| max_duration_seconds <br/> | `int` | This value is used to define the maximum duration in seconds for a room session. Following are the acceptable ranges: <br/> Minimum `max_duration_seconds` = 120 <br/> Maximum `max_duration_seconds` = 86100 <br/> <br/> | No |
| max_duration_seconds <br/> | `int` | This value is used to define the maximum duration in seconds for a room session. Following are the acceptable ranges: <br/> Minimum `max_duration_seconds` = 120 <br/> Maximum `max_duration_seconds` = 43200 <br/> <br/> | No |

> **Warning:** If you create a room with the name of an existing room, the same room will be updated with the new configuration passed in the request payload. <br/> For example, if the existing room was assigned to **'template-ABC'** earlier and in the request payload you've used **'template-DEF'**, then **'template-DEF'** will be assigned to the existing room.
Expand Down Expand Up @@ -114,4 +114,4 @@ More info on API errors here - https://www.100ms.live/docs/server-side/v2/how-to
| Error: region not supported | 400 |
| Error: template not found | 400 |
| Invalid body param: max_duration_seconds less than 120 seconds | 400 |
| Invalid body param: max_duration_seconds greater than 86100 seconds | 400 |
| Invalid body param: max_duration_seconds greater than 43200 seconds | 400 |
2 changes: 1 addition & 1 deletion docs/server-side/v2/api-reference/Rooms/update-a-room.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,5 @@ curl --location --request POST 'https://api.100ms.live/v2/rooms/<room_id>' \
| region <br/> | `string` | Region in which you want to create a room. <br/><br/> `eu` - European Union <br/><br/> `in` - India <br/><br/> `us` - United States <br/><br/><br/> `auto` Fallback to region of the template (default value) | No |
| large_room <br/> | `boolean` | Enable this flag if the requirement is to support more than 2500 peers in the room. You are also required to update to latest SDKs to support this functionality. By default, this value is set to `false`. Learn more about it in the [large room creation guide](/server-side/v2/how-to-guides/create-large-rooms). | No | | No |
| size <br/> | `int` | This value is used to define the maximum number of peers expected to be joining the given room. Following are the acceptable ranges: <br/> <br/> With `large_room: false`, Minimum `size` = 0; Maximum `size` = 2500 <br/> <br/> With `large_room: true`, Minimum `size` = 0; Maximum `size` = 20000 | No |
| max_duration_seconds <br/> | `int` | This value is used to define the maximum duration in seconds for a room session. Following are the acceptable ranges: <br/> Minimum `max_duration_seconds` = 120 <br/> Maximum `max_duration_seconds` = 86100 <br/> <br/> | No |
| max_duration_seconds <br/> | `int` | This value is used to define the maximum duration in seconds for a room session. Following are the acceptable ranges: <br/> Minimum `max_duration_seconds` = 120 <br/> Maximum `max_duration_seconds` = 43200 <br/> <br/> | No |

0 comments on commit 7b8019d

Please sign in to comment.