-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOCS-92 Replace concepts with get started, concepts reorg (#1478)
* replace concepts with get started * update with reorg * update condition for Get started tag * update landing page * update links * Fix: Final reorg before merge * update redirects * fix docs, update redirects * DOCS-94 Replace get started in platforms with quickstart, fix how--to (#1479) replace how--to with how-to, replace get started in platforms with quickstart * update files * push * remove api reference from get-started * update meta title * resolve duplicacy * fix img path * resolve conflicts * add deleted files --------- Co-authored-by: chrisb-100ms <[email protected]>
- Loading branch information
1 parent
800710c
commit a7035e2
Showing
277 changed files
with
274 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
title: Basics | ||
nav: 1.1 | ||
--- | ||
|
||
## Architecture | ||
|
||
100ms is a cloud platform that allows developers to add video and audio conferencing to Web, Android and iOS applications. | ||
|
||
The platform provides REST APIs, SDKs, and a dashboard that makes it simple to capture, distribute, record, and render live interactive audio, video. | ||
|
||
Any application built using 100ms' SDK has 2 components. | ||
|
||
- **Client:** Use 100ms android, iOS, Web SDKs to manage connections, room states, render audio/video. | ||
|
||
- **Server:** Use 100ms' APIs or dashboard to create rooms, setup room templates, trigger recording or RTMP streaming, access events. | ||
|
||
![Architecture](/docs/v2/arch.png) | ||
|
||
## Basic Concepts | ||
|
||
- `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 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. | ||
- `Room Link` A Room Link is a link that a `peer` can use to Join a Room. It is always associated to a specific Room and Role, allowing unique Room Links for each Role in a Room. | ||
- `Template` A template is a collection of roles, room settings, recording and RTMP settings (if used), that are used by the SDK to decide which geography to connect to, which tracks to return to the client, whether to turn on recording when a room is created, etc. Each room is associated with a template. | ||
- `Destinations` Destinations is used to save audio/video calls for offline viewing. 100ms supports 2 kinds of recording - [SFU recording](/javascript/v2/foundation/recordings#sfu-recording-advanced) and [Browser recording](/javascript/v2/foundation/recordings#browser-recording-recommended). Also, `HLS enabled` configuration will allow you to live stream your room over HLS. | ||
- `RTMP` RTMP streaming is used to live stream your video conferencing apps to platforms like YouTube, Twitch, Facebook, MUX, etc. | ||
- `Webhooks` Webhook is an HTTP(S) endpoint used for pushing the notifications to your application. It will be invoked by 100ms servers to notify events of your room. | ||
- `Workspace` A workspace is an isolated environment which contains account data like templates, rooms, room and session history, etc. You can use workspaces to represent environments like “Production” and “Development” and invite team members to a workspace. | ||
|
||
## What are the steps to build a live app with 100ms? | ||
1. Sign up on 100ms using the **Try For Free** button in the top navbar. | ||
|
||
![Signup for 100ms account](/docs/v2/signup.png) | ||
|
||
2. Once you're logged in to the dashboard, click on `Create Room` | ||
|
||
![Create Room](/docs/v2/Step-1_CreateRoom.png) | ||
|
||
3. **Hover and select** on one of the Template Presets.(We will use the **Video Conference Template** for this example) | ||
|
||
![Select Template](/docs/v2/Step2_SelectTemplate.png) | ||
|
||
4. You can either choose to configure your template by changing the auto suggested template name and subdomain URL or click on continue to move forward. | ||
|
||
![Configure Template](/docs/v2/Step3_ConfigureTemplate.png) | ||
|
||
5. Now you can **join your room** configured with the video conferencing template. You can join the room either via a 100ms demo link or by using the auth token in SDK or Sandbox. | ||
|
||
![Join Room](/docs/v2/Step4_JoinRoom.png) | ||
|
||
|
||
## Where should I start? | ||
|
||
|
||
### Quickstart | ||
|
||
If you want to see 100ms' SDKs in action in under 5 minutes, run one of our quickstart [apps](/android/v2/guides/quickstart) |
2 changes: 1 addition & 1 deletion
2
...concepts/templates-and-roles/overview.mdx → ...-started/concepts/templates-and-roles.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Overview | ||
title: Templates and Roles | ||
nav: 1.2 | ||
--- | ||
|
||
|
2 changes: 1 addition & 1 deletion
2
...ts/templates-and-roles/breakout-rooms.mdx → ...teraction-and-controls/breakout-rooms.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: Breakout Rooms | ||
nav: 1.23 | ||
nav: 3.3 | ||
--- | ||
|
||
import BreakoutRooms from '@/common/breakout-rooms.mdx'; | ||
|
2 changes: 1 addition & 1 deletion
2
...epts/templates-and-roles/waiting-room.mdx → ...interaction-and-controls/waiting-room.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: Waiting Room | ||
nav: 1.22 | ||
nav: 3.4 | ||
--- | ||
|
||
import WaitingRoom from '@/common/waiting-room.mdx'; | ||
|
4 changes: 2 additions & 2 deletions
4
docs/concepts/v2/concepts/live-streaming.mdx → ...2/get-started/features/live-streaming.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...concepts/v2/concepts/adaptive-bitrate.mdx → ...ted/features/quality/adaptive-bitrate.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: Adaptive Bitrate | ||
nav: 1.8 | ||
nav: 3.5 | ||
--- | ||
import AdaptiveBitrate from '@/common/adaptive-bitrate.md' | ||
|
||
|
2 changes: 1 addition & 1 deletion
2
...cepts/handling-audio-video-edge-cases.mdx → ...ality/handling-audio-video-edge-cases.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: Handling audio-video edge cases | ||
nav: 1.4 | ||
nav: 3.6 | ||
--- | ||
|
||
import Network from '@/common/network.md'; | ||
|
4 changes: 2 additions & 2 deletions
4
docs/concepts/v2/concepts/recordings.mdx → ...ed/v2/get-started/features/recordings.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: Recordings | ||
nav: 1.7 | ||
title: Recording | ||
nav: 3.1 | ||
--- | ||
|
||
import Recordings from '@/common/recordings.md'; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
title: Overview | ||
nav: 1.0 | ||
--- | ||
|
||
100ms provides infrastructure and client-side SDKs for you to build real-time, audio-video interactive experiences in your app. 100ms combines the capabilities of video conferencing (built over WebRTC), live streaming (built over [HLS](https://en.wikipedia.org/wiki/HTTP_Live_Streaming)) and real-time databases. These capabilities can be used to build engaging live experiences—like virtual classrooms, live streams, tele-health consultations and multiplayer social gaming—in your web or mobile apps. | ||
|
||
## Understanding 100ms | ||
|
||
### Rooms and roles | ||
|
||
Everything in 100ms happens inside **rooms**. Your users can join a room, publish audio/video and interact with each other while they are in the room, and then leave the room. | ||
|
||
The room contains references to **peers** (users in the room) and **tracks** (audio, video, screen share) in the room. When the first peer joins a room, a new **session** is created. When the last peer leaves, the session ends. A room can have multiple sessions. | ||
|
||
Peers inside a room belong to a **role**, which defines what a peer can do in the room. For example, can they publish video, can they mute other peers, and so on. A peer can change roles while they are in the room. | ||
|
||
Learn about other [100ms primitives](/get-started/v2/get-started/concepts/basics). | ||
|
||
### Interactivity in the room | ||
|
||
The room can be used to enable different levels of interactivity. | ||
|
||
![Circles of interactivity](/docs/v2/concepts/circles-of-interactivity.png) | ||
|
||
#### Level 1: Full duplex audio/video in real-time | ||
|
||
Level 1 participants publish their audio/video, and interact with others in sub-second latency. This is real-time video conferencing, similar to Zoom or Google Meet. | ||
|
||
#### Level 2: Webinar-style audience in real-time | ||
|
||
Level 2 participants consume audio/video from level 1 participants with sub-second latency, without publishing their own audio/video. Level 2 participants can engage with level 1 through messaging (chat, emojis, custom events). This is similar to a Zoom webinar. | ||
|
||
Levels 1 and 2 are enabled using WebRTC. | ||
|
||
#### Level 3: Live stream audience consuming in near real-time | ||
|
||
Level 3 participants consume a composite live stream in near real-time (\<10 secs of latency) without publishing their audio/video. They can interact with other participants via messaging. This is similar to viewers on Twitch or YouTube Live. | ||
|
||
#### Read more | ||
|
||
- [Basic architecture](/get-started/v2/get-started/concepts/basics) | ||
- [Primitives](/get-started/v2/get-started/concepts/basics) | ||
- [Authentication](/get-started/v2/get-started/security-and-tokens) | ||
|
||
## Integration paths | ||
|
||
100ms can be used to make embedded, custom live video integrations that blend with the rest of your application. For some use-cases, it is faster to start with a "pre-built" web app. Pick an option that suits your use-case. | ||
|
||
<FlexContainer> | ||
|
||
<Callout icon="link" title="Pre-built"> | ||
Generate room links or embed the 100ms web app as an iframe in your app | ||
|
||
[Integrate pre-built](/get-started/v2/get-started/prebuilt/prebuilt) | ||
|
||
</Callout> | ||
|
||
<Callout icon="shield" title="Custom UI"> | ||
Build a custom UI with our headless client SDKs for web, Android, iOS, React Native and Flutter | ||
|
||
[Choose a client SDK to get started](/) | ||
|
||
</Callout> | ||
|
||
</FlexContainer> | ||
|
||
## Feature guides | ||
|
||
- [Recordings](/get-started/v2/get-started/features/recordings) | ||
- [Live streaming](/get-started/v2/get-started/features/live-streaming) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
.../concepts/rooms/room-codes/room-codes.mdx → ...-started/prebuilt/room-codes/overview.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...cepts/rooms/room-codes/room-code-auth.mdx → ...ed/prebuilt/room-codes/room-code-auth.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...concepts/v2/concepts/rooms/room-links.mdx → ...tarted/prebuilt/room-codes/room-links.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
a7035e2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
100ms-docs – ./
100ms-docs-git-main-100mslive.vercel.app
100ms-docs-100mslive.vercel.app
100ms-docs.vercel.app
docs.100ms.live