Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: plugin, mobile and the rest! #233

Merged
merged 41 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
5900485
docs: add breakout rooms integration guide
Nov 17, 2023
3ee2973
docs: release notes added for android-core
rohitkhirid Dec 7, 2023
030d6ba
docs: added release notes for mobile-sdk's
rohitkhirid Dec 8, 2023
de8dbb3
docs: removed web related docs from mobile release notes
rohitkhirid Dec 8, 2023
dd8c60a
Updated Twilio feature comparison
akigugale Dec 8, 2023
7dc23a8
docs: release notes for 1.26.1
rohitkhirid Dec 11, 2023
8b8c9e9
chore: updated ios core version
shaunak-jagtap Dec 11, 2023
19368e8
docs: add polls to capabilities
manyaagarwal Dec 11, 2023
68461db
docs(recordings): pause and resume recordings
madhugb Dec 12, 2023
4b67342
chore: updated release-notes and added docs for pause and resume reco…
rohitkhirid Dec 12, 2023
c6f48ee
docs: added new ui kit version
rohitkhirid Dec 12, 2023
be3a9ad
Merge pull request #397 from dyte-in/update-twilo-feature-comp
palashgo Dec 12, 2023
ea6c666
docs: add poll REST API to poll capabilities
manyaagarwal Dec 16, 2023
57cb147
fix: mdx syntax error in capabilities/polls
manyaagarwal Dec 16, 2023
a91004f
docs: fix broken links
manyaagarwal Dec 16, 2023
37f8681
docs: replace typescript interfaces with a table
manyaagarwal Dec 16, 2023
a84e96a
wip
manyaagarwal Dec 16, 2023
e1023a3
docs: add a capabilities page for screen sharing
manyaagarwal Dec 17, 2023
b98a3ca
docs: port new concepts page to voice conferencing
manyaagarwal Dec 17, 2023
045209f
fix: broken link on livestreaming/concepts
manyaagarwal Dec 17, 2023
13de4ea
fix: minor change in concepts content for coreSDK
manyaagarwal Dec 17, 2023
05ed298
feat: add plugin docs
palashgo Dec 19, 2023
fa821dc
Merge pull request #404 from dyte-in/feat/plugins
madhugb Dec 20, 2023
141588a
docs: release notes for last few releases
madhugb Dec 20, 2023
3ed30eb
Merge pull request #401 from dyte-in/docs/capabilities/poll
madhugb Dec 20, 2023
176bd01
Merge pull request #398 from dyte-in/ios-core-version-update
madhugb Dec 20, 2023
7151cf8
Merge pull request #382 from dyte-in/fix/breakout-rooms
madhugb Dec 20, 2023
ed121b8
Merge pull request #402 from dyte-in/docs/capabilities/screensharing
madhugb Dec 20, 2023
480b42d
Merge pull request #403 from dyte-in/docs/concepts
madhugb Dec 20, 2023
6a9119e
feat: fetch latest mobile SDK versions
palashgo Dec 20, 2023
ddca2be
Merge pull request #407 from dyte-in/feat/latest-mobile-versions
palashgo Dec 21, 2023
22e2f68
Merge branch 'main' into release-notes
palashgo Dec 21, 2023
3f675c2
Merge pull request #394 from dyte-in/release-notes
palashgo Dec 21, 2023
c3c3510
ifix: update the doc of initialising meeting on the basis of asynchro…
kumarSudhir7891 Dec 22, 2023
466d6d2
docs: add an overview page for plugins capabilities
manyaagarwal Dec 26, 2023
aafdf50
fix: add import statements for react codeblocks
manyaagarwal Dec 26, 2023
0ea7043
fix: remove create plugin section
manyaagarwal Jan 2, 2024
4445738
Merge pull request #410 from dyte-in/docs/capabilities/plugin
madhugb Jan 2, 2024
e80d881
Merge pull request #408 from dyte-in/MOB-1078
vaibhavshn Jan 3, 2024
b0f14e4
Merge pull request #406 from dyte-in/docs/release-notes-11-12-23
palashgo Jan 3, 2024
229fe61
Merge pull request #415 from dyte-in/feature/screensharing
vaibhavshn Jan 3, 2024
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
4 changes: 2 additions & 2 deletions docs/android-core/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ You must complete the following steps:

## Step 1: Install the SDK

1. Install the SDK using maven dependency.
1. Install the SDK using maven central

<MavenLatestInstallation />
<MavenLatestInstallation pkg="core-android" />

2. Add the following permissions to the AndroidManifest.xml file.

Expand Down
16 changes: 16 additions & 0 deletions docs/android-core/recording.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,22 @@ Call `meeting.recording.stop()` to stop the active recording.
meeting.recording.stop();
```

## Pause a recording

Call `meeting.recording.pause()` to pause the active recording.

```kotlin
meeting.recording.pause();
```

## Resume a paused recording

Call `meeting.recording.resume()` to resume the paused recording.

```kotlin
meeting.recording.resume();
```

## Get active recording state

The `meeting.recording.recordingState` property describes the current state of
Expand Down
10 changes: 10 additions & 0 deletions docs/android-core/release-notes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Release Notes
sidebar_position: 101
sidebar_class_name: releaseSidebarHeading
tags: [mobile-core, releasenotes]
---

import ReleaseNotesGenerator from '@site/src/components/ReleaseNotesGenerator';

<ReleaseNotesGenerator noteKey="android-core" />
9 changes: 3 additions & 6 deletions docs/android/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ sidebar_position: 1
slug: /
---

import { MavenLatestInstallation } from '@site/src/components/LatestInstallation';

# Quickstart

This quickstart shows how to use Dyte's Android UI Kit SDK to add live video and
Expand Down Expand Up @@ -42,10 +44,7 @@ You must complete the following steps:

1. Install the SDK using maven dependency.

```python
// other dependencies here
implementation 'io.dyte:uikit:1.14.2'
```
<MavenLatestInstallation pkg="uikit" />

2. Add the following permissions to the AndroidManifest.xml file.

Expand Down Expand Up @@ -94,8 +93,6 @@ val dyteUIKitInfo = DyteUIKitInfo(
val dyteUIKit = DyteUIKitBuilder.build(dyteUIKitInfo)
```



## Step 4: Launch the meeting UI

To launch the meeting UI all you need to do is call `startMeeting()` which will take
Expand Down
10 changes: 10 additions & 0 deletions docs/android/release-notes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Release Notes
sidebar_position: 101
sidebar_class_name: releaseSidebarHeading
tags: [releasenotes]
---

import ReleaseNotesGenerator from '@site/src/components/ReleaseNotesGenerator';

<ReleaseNotesGenerator noteKey="android-ui-kit" />
10 changes: 10 additions & 0 deletions docs/flutter-core/release-notes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Release Notes
sidebar_position: 101
sidebar_class_name: releaseSidebarHeading
tags: [mobile-core, releasenotes]
---

import ReleaseNotesGenerator from '@site/src/components/ReleaseNotesGenerator';

<ReleaseNotesGenerator noteKey="flutter-core" />
10 changes: 10 additions & 0 deletions docs/flutter/release-notes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Release Notes
sidebar_position: 101
sidebar_class_name: releaseSidebarHeading
tags: [releasenotes]
---

import ReleaseNotesGenerator from '@site/src/components/ReleaseNotesGenerator';

<ReleaseNotesGenerator noteKey="flutter-ui-kit" />
115 changes: 115 additions & 0 deletions docs/guides/capabilities/breakoutroom/integrating-breakout-rooms.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
---
title: 'Integrating Breakout Rooms'
sidebar_position: 3
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { WebCoreCDNInstallation } from '@site/src/components/LatestInstallation';

## Step 1: Install the SDK

You can install the package using CDN, npm or Yarn.

<Tabs
groupId="node-pm"
defaultValue="npm"
values={[
{ label: "npm", value: "npm" },
{ label: "yarn", value: "yarn" },
{ label: "CDN", value: "CDN" },
]}
>
<TabItem value="npm">
Install the SDK using npm.

```shell
npm install @dytesdk/web-core
```

[![npm version](https://badge.fury.io/js/@dytesdk%2Fweb-core.svg)](https://badge.fury.io/js/@dytesdk%2Fweb-core)

</TabItem>
<TabItem value="yarn">
Install the SDK using yarn.

```shell
yarn add @dytesdk/web-core
```

[![npm version](https://badge.fury.io/js/@dytesdk%2Fweb-core.svg)](https://badge.fury.io/js/@dytesdk%2Fweb-core)

</TabItem>
<TabItem value="CDN">
Add the following script tag in the head of your HTML file.

<WebCoreCDNInstallation />
</TabItem>
</Tabs>

## Step 2: Initialize the SDK

| | |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authToken` | After you've created the meeting, add each participant to the meeting using the [Add Participant API](/api#/operations/add_participant). The API response contains the authToken. |

```js
let meeting = await DyteClient.init({
authToken,
});

// add additional event handler for breakout rooms
meeting.connectedMeetings.on('meetingChanged', (newMeeting) => {
meeting = newMeeting;
});
```

## Step 3: Pass the meeting object to pre-built ui component

<Tabs>
<TabItem value="HTML">

```html
<body>
<dyte-meeting id="my-meeting"></dyte-meeting>
<script>
document.getElementById('my-meeting').meeting = meeting;
</script>
</body>
```

For detailed guide, check out - https://docs.dyte.io/ui-kit/quickstart

</TabItem>
<TabItem value="ReactJS">

```jsx
<DyteMeeting meeting={meeting} />
```

For detailed guide, check out - https://docs.dyte.io/react-ui-kit/quickstart

</TabItem>
<TabItem value="Angular">

```js
class AppComponent {
title = 'MyProject';
@ViewChild('myid') meetingComponent: DyteMeeting;
dyteMeeting: DyteClient;

async ngAfterViewInit() {
const meeting = await DyteClient.init({
authToken: '<auth-token>',
});
meeting.joinRoom();
this.dyteMeeting = meeting;
if (this.meetingComponent) this.meetingComponent.meeting = meeting;
}
}
```

For detailed guide, check out - https://docs.dyte.io/angular-ui-kit/quickstart

</TabItem>
</Tabs>
5 changes: 5 additions & 0 deletions docs/guides/capabilities/plugins/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"position": 4,
"label": "Plugins",
"collapsible": true
}
37 changes: 37 additions & 0 deletions docs/guides/capabilities/plugins/docshare.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Document Sharing

DocShare allows you to share, view documents and annotate the documents collaboratively.
The plugin exposes a few APIs to control the document viewer

## Loading a document

You can specify the following parameters:

- `followId`: It syncs the zoom and scroll values of the userId specified to other users (including the recording)
- `document` : You can also specify the document that you wish to open beforehand.

```ts
const id = '317b4f59-40f0-46af-90d6-1ed6035bb477';
const docsharePlugin = meeting.plugins.all.get(id);
docsharePlugin.on('ready', () => {
// Ensure the isHost check is only there for one participant
// since the recording can't follow multiple people
const isHost = meeting.self.presetName === '<presetnameofhost>';
if (!isHost) return;
docsharePlugin.sendData({
eventName: 'config',
data: {
eventName: 'config',
document: '<document-url>',
followId: meeting.self.userId,
},
});
});
```

Now whenever the plugin is loaded it will use the specified parameters.
To open the plugin you can call

```ts
docsharePlugin.activate();
```
Loading