Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion public/__redirects
Original file line number Diff line number Diff line change
Expand Up @@ -2357,4 +2357,9 @@
/realtime/demos /realtime/sfu/demos/ 302
/realtime/example-architecture /realtime/sfu/example-architecture/ 302
/realtime/pricing /realtime/sfu/pricing/ 302
/realtime/changelog /realtime/sfu/changelog/ 302
/realtime/changelog /realtime/sfu/changelog/ 302

/realtime/realtimekit/get-started /realtime/realtimekit/getting-started/ 302
/realtime/get-started /realtime/realtimekit/getting-started/ 302
/realtime/introduction /realtime/realtimekit/introduction 302
/realtime/concepts /realtime/realtimekit/concepts 302
25 changes: 6 additions & 19 deletions src/content/docs/realtime/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,17 @@ Cloudflare Realtime is a comprehensive suite of products designed to help you bu

### RealtimeKit

Cloudflare [RealtimeKit](/realtime/introduction) allows you to integrate programmable and easily customizable live video and voice into your web, mobile, and desktop applications. With just a few lines of code, you can enable live video communication, voice calls, and interactive live streaming.
Cloudflare [RealtimeKit](/realtime/realtimekit/) allows you to integrate programmable and easily customizable live video and voice into your web, mobile, and desktop applications. With just a few lines of code, you can enable live video communication, voice calls, and interactive live streaming.

At its core, RealtimeKit is powered by the [Realtime SFU](/realtime/sfu), which efficiently routes video and audio streams between participants. RealtimeKit provides a set of user-friendly SDKs and APIs that act as a layer on top of the SFU, so you don't have to handle the complexities of media track management, peer management, and other intricate WebRTC-related tasks.
At its core, RealtimeKit is powered by the [Realtime SFU](/realtime/sfu/), which efficiently routes video and audio streams between participants. RealtimeKit provides a set of user-friendly SDKs and APIs that act as a layer on top of the SFU, so you don't have to handle the complexities of media track management, peer management, and other intricate WebRTC-related tasks.

### Realtime SFU

The [Realtime SFU (Selective Forwarding Unit)](/realtime/sfu) is a powerful media server that efficiently routes video and audio streams between participants, and underpins the RealtimeKit. The Realtime SFU runs on [Cloudflare's global cloud network](https://www.cloudflare.com/network/) in hundreds of cities worldwide. For developers with WebRTC expertise, the SFU can be used independently to build highly custom applications that require full control over media streams. This is recommended only for those who want to leverage Cloudflare's network with their own WebRTC logic.
The [Realtime SFU (Selective Forwarding Unit)](/realtime/sfu/) is a powerful media server that efficiently routes video and audio streams between participants, and underpins the RealtimeKit. The Realtime SFU runs on [Cloudflare's global cloud network](https://www.cloudflare.com/network/) in hundreds of cities worldwide. For developers with WebRTC expertise, the SFU can be used independently to build highly custom applications that require full control over media streams. This is recommended only for those who want to leverage Cloudflare's network with their own WebRTC logic.

### TURN Service

The [TURN service](/realtime/turn) is a managed service that acts as a relay for WebRTC traffic. It ensures connectivity for users behind restrictive firewalls or NATs by providing a public relay point for media streams.

<LinkButton variant="primary" href="/realtime/getting-started/">
Get started
</LinkButton>
<LinkButton
variant="secondary"
href="https://dash.cloudflare.com/?to=/:account/realtime"
>
Realtime dashboard
</LinkButton>
<LinkButton variant="secondary" href="https://demo.realtime.cloudflare.com">
RealtimeKit demo app
</LinkButton>
The [TURN service](/realtime/turn/) is a managed service that acts as a relay for WebRTC traffic. It ensures connectivity for users behind restrictive firewalls or NATs by providing a public relay point for media streams.

## Related products

Expand Down Expand Up @@ -80,7 +67,7 @@ Cloudflare Stream lets you or your end users upload, store, encode, and deliver

<LinkTitleCard
title="Use cases"
href="/realtime/introduction#use-cases"
href="/realtime/realtimekit/introduction#use-cases"
icon="document"
>
Learn how you can build and deploy ambitious Realtime applications to
Expand All @@ -93,7 +80,7 @@ Cloudflare Stream lets you or your end users upload, store, encode, and deliver
icon="x.com"
>
Follow @CloudflareDev on Twitter to learn about product announcements, and
what is new in Cloudflare Workers.
what is new in Cloudflare Realtime.
</LinkTitleCard>

</CardGrid>
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This page explains the core concepts and terminology used in RealtimeKit.

### Meeting

A **Meeting** is the fundamental communication channel in RealtimeKit. You can think of it like an event on your calendar - it's a persistent, long-lived container or "room" that serves as a blueprint for its [sessions](/realtime/concepts#session). Every session created for this meeting inherits the same base configuration, such as the title of the meeting and whether to automatically record the session when it starts. You add participants to the meeting, which grants them access to join a session of that meeting.
A **Meeting** is the fundamental communication channel in RealtimeKit. You can think of it like an event on your calendar - it's a persistent, long-lived container or "room" that serves as a blueprint for its [sessions](/realtime/realtimekit/concepts/#session). Every session created for this meeting inherits the same base configuration, such as the title of the meeting and whether to automatically record the session when it starts. You add participants to the meeting, which grants them access to join a session of that meeting.

### Session

Expand All @@ -33,7 +33,7 @@ A **Participant** is the server-side representation of a user within a session.

### Peer

A **Peer** is the client-side representation of a [participant](/realtime/concepts#participant) in a session. While the terms are sometimes used interchangeably, a peer represents a specific instance of a participant joining the meeting. For example, if a single user joins the same meeting from two different browser tabs, they will have the same participant ID (also referred to as a user ID) but two unique peer IDs.
A **Peer** is the client-side representation of a [participant](/realtime/realtimekit/concepts/#participant) in a session. While the terms are sometimes used interchangeably, a peer represents a specific instance of a participant joining the meeting. For example, if a single user joins the same meeting from two different browser tabs, they will have the same participant ID (also referred to as a user ID) but two unique peer IDs.

### Stage

Expand Down
41 changes: 41 additions & 0 deletions src/content/docs/realtime/realtimekit/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: RealtimeKit
pcx_content_type: overview
sidebar:
order: 1
head:
- tag: title
content: Overview
---

import { Description, LinkButton } from "~/components";

<Description>

Integrate programmable, and easily customizable live video and voice into your web, mobile, and desktop applications with just a few lines of code.

</Description>

The RealtimeKit is a set of user-friendly SDKs and APIs that provides the fastest and simplest way to integrate a complete video and voice call interface into any application, allowing you to get started with just a few lines of code while still offering flexibility for customization.

Powerful yet simple to use, RealtimeKit is built on top of WebRTC and provides a set of user-friendly SDKs and APIs that act as a layer on top of the [Realtime SFU](/realtime/sfu/), so you don't have to handle the complexities of media track management, peer management, and other intricate WebRTC-related tasks.

Learn more about the [concepts](/realtime/realtimekit/concepts/) behind RealtimeKit, [how it works](/realtime/realtimekit/introduction/#how-realtimekit-works), and [use cases](/realtime/realtimekit/introduction/#use-cases).

<LinkButton variant="primary" href="/realtime/realtimekit/getting-started/">
Get started
</LinkButton>
<LinkButton
variant="secondary"
href="https://dash.cloudflare.com/?to=/:account/realtime/kit"
target="_blank"
>
RealtimeKit dashboard
</LinkButton>
<LinkButton
variant="secondary"
href="https://demo.realtime.cloudflare.com"
target="_blank"
>
RealtimeKit demo app
</LinkButton>
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Build collaborative experiences for team meetings, online classrooms, or social

### Webinars

Webinars are one-to-many events designed for a presenter to share information with a large, interactive audience. Unlike group calls where all participants collaborate freely, webinars have distinct roles for presenters and viewers, managed through [presets](/realtime/concepts#presets). This structure, powered by WebRTC, is ideal for product demos, company all-hands, and live workshops, with features like chat, Q&A, and polls to engage the audience.
Webinars are one-to-many events designed for a presenter to share information with a large, interactive audience. Unlike group calls where all participants collaborate freely, webinars have distinct roles for presenters and viewers, managed through [presets](/realtime/realtimekit/concepts/#presets). This structure, powered by WebRTC, is ideal for product demos, company all-hands, and live workshops, with features like chat, Q&A, and polls to engage the audience.

- **Product Demos:** Showcase your product to a large audience with live video and Q&A sessions.
- **Company All-Hands:** Broadcast company-wide meetings to all your employees, no matter where they are.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/realtime/sfu/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Realtime SFU
pcx_content_type: overview
sidebar:
order: 9
order: 2
head:
- tag: title
content: Overview
Expand Down Expand Up @@ -31,4 +31,4 @@ Cloudflare Realtime SFU runs on [Cloudflare's global cloud network](https://www.
</LinkButton>
<LinkButton variant="secondary" href="https://github.com/cloudflare/orange">
Orange Meets demo app
</LinkButton>
</LinkButton>
4 changes: 2 additions & 2 deletions src/content/docs/realtime/turn/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: TURN Service
pcx_content_type: navigation
sidebar:
order: 10
order: 3
---

Separately from the SFU, Realtime offers a managed TURN service. TURN acts as a relay point for traffic between WebRTC clients like the browser and SFUs, particularly in scenarios where direct communication is obstructed by NATs or firewalls. TURN maintains an allocation of public IP addresses and ports for each session, ensuring connectivity even in restrictive network environments.
Expand Down Expand Up @@ -64,4 +64,4 @@ Each limit is for a single TURN allocation (single TURN user) and not account wi

:::

These limits are suitable for high-demand applications and also have burst rates higher than those documented above. Hitting these limits will result in packet drops.
These limits are suitable for high-demand applications and also have burst rates higher than those documented above. Hitting these limits will result in packet drops.
Loading