Skip to content
Closed
Show file tree
Hide file tree
Changes from all 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
13 changes: 13 additions & 0 deletions src/content/docs/realtime/realtimekit/guides/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Guides
sidebar:
order: 1

description: >-
"Explore a variety of guides to enhance your RealtimeKit experience. From AI
capabilities to customization
---

# Guides

TBD
34 changes: 34 additions & 0 deletions src/content/docs/realtime/realtimekit/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: RealtimeKit
sidebar:
order: 1
---

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

## SDK Documentation

Build the way you want in the framework you want!

### UI Kit

- React
- Angular
- HTML
- Flutter
- React Native
- iOS
- Android

### Core SDK

- JS
- React
- Flutter
- React Native
- iOS
- Android

### REST API

[Reference](/realtime/realtimekit/restapi)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Android
sidebar:
order: 3
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Flutter
sidebar:
order: 2
---

TBD
7 changes: 7 additions & 0 deletions src/content/docs/realtime/realtimekit/mobile/core/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Core SDK
sidebar:
order: 1
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: iOS
sidebar:
order: 4
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: React Native
sidebar:
order: 1
---

TBD
7 changes: 7 additions & 0 deletions src/content/docs/realtime/realtimekit/mobile/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Mobile
sidebar:
order: 3
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Android
sidebar:
order: 3
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Flutter
sidebar:
order: 2
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: UI Kit
sidebar:
order: 2
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: iOS
sidebar:
order: 4
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: React Native
sidebar:
order: 1
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import {
ChatMultipleRegular,
LiveRegular,
MicRegular,
VideoRegular,
} from "@fluentui/react-icons";

<CardSection
id="Quickstart"
title="Quickstart"
description="Learn how to integrate live video and voice, live stream, and chat experiences into your product."
>
<Card
title="Live Video"
icon={<VideoRegular />}
to="/guides/live-video/intro-video-conf"
description="Add live video functionality to your web, mobile, and desktop applications."
/>
<Card
title="Voice Conferencing"
icon={<MicRegular />}
to="/guides/voice-conf/intro-voice-conf"
description="Integrate reliable voice calling experiences into your product."
/>
<Card
title="Interactive Livestreaming"
icon={<LiveRegular />}
to="/guides/livestream/livestream-overview"
description="Get started with interactive livestreaming and broadcast to a large audience"
/>
{/* <Card
title="Realtime Chat"
icon={<ChatMultipleRegular />}
to="/guides/realtime-chat/intro-chat"
description="Create interactive and collaborative in-app chat experiences."
/> */}
</CardSection>
7 changes: 7 additions & 0 deletions src/content/docs/realtime/realtimekit/restapi/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: REST API
sidebar:
order: 4
---

TBD
7 changes: 7 additions & 0 deletions src/content/docs/realtime/realtimekit/web/core/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Core SDK
sidebar:
order: 1
---

TBD
7 changes: 7 additions & 0 deletions src/content/docs/realtime/realtimekit/web/core/js/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: JS
sidebar:
order: 1
---

TBD
37 changes: 37 additions & 0 deletions src/content/docs/realtime/realtimekit/web/core/react/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: React Core SDK
sidebar:
order: 2
---

## Introduction

The RealtimeKit Core SDK is designed to provide developers with an easy way to incorporate real-time communication (RTC) solutions into their apps and websites. With full customization and branding options, you can build your own user interface from the ground up without dealing with complicated media layers.

The Core SDK acts as a data-only layer, offering high-level primitives and abstracting away complex media and networking optimizations. It only provides simple APIs that are user-friendly and easy to work with.

### Hooks

[React Hooks](https://beta.reactjs.org/reference/react) are functions that allow developers to manage state and other React features in functional components. Hooks were introduced in React version 16.8 as a way to simplify the code. RealtimeKit provides the following built-in hooks:

- useRealtimeKitClient()
- useRealtimeKitMeeting()
- useRealtimeKitSelector()

See [Hooks](/react-ui-kit/using-hooks) for more information.
{/* refactor */}

### Utility Modules

The Core SDK includes various modules for in-call utilities like chat, polls, and recording that enable building a UI on top of it. The following are the core SDK modules:

- **meeting.self**: This consists of properties and methods corresponding to the current (local) user, such as enabling or disabling their audio and video, getting a list of media devices or changing the device, or sharing your mobile screen.
- **meeting.participants**: Use this module to get useful information about the other participants that are present in the meeting. A host can use this module for access control. For example, the host can mute or kick a participant.
- **meeting.chat**: It provides the methods to integrate chat features such as sending/receiving, editing, and deleting text, images, and files.
- **meeting.polls**: Meetings can have polls. This module lets you perform actions related to polls, that is create and manage a poll within a meeting.
- **meeting.recording**: When a meeting needs to be recorded, this module can be used. It lets you start or stop a recording, and get the current status of an ongoing recording.
- **meeting.meta**: This object consists of all the metadata related to the current meeting, such as the title, the timestamp of when it started, and more.

<head>
<title>React Web Core Introduction</title>
</head>
7 changes: 7 additions & 0 deletions src/content/docs/realtime/realtimekit/web/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Web
sidebar:
order: 2
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Angular
sidebar:
order: 2
---

TBD
7 changes: 7 additions & 0 deletions src/content/docs/realtime/realtimekit/web/ui-kit/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: UI Kit
sidebar:
order: 2
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: React
sidebar:
order: 1
---

TBD
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Web Components
sidebar:
order: 3
---

TBD