Skip to content

Commit

Permalink
Merge pull request #385 from dyte-io/flutter-ui-kit/skip-setup
Browse files Browse the repository at this point in the history 
docs: add doc for skipping setup screen in flutter ui-kit
  • Loading branch information
@saksham-gt
saksham-gt authored Aug 9, 2024
2 parents 0a0d765 + dfa4105 commit eafa789
Showing 1 changed file with 20 additions and 12 deletions.
32 changes: 20 additions & 12 deletions docs/flutter/quickstart.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,20 +110,18 @@ platform :ios, '13.0'
<true/>
```


## Step 3: Configure a Dyte meeting

To initiate Dyte Meeting for any participant you just need to pass `authToken` as an argument. You can get the `authToken` via the [Add Participant API](https://docs.dyte.io/api?v=v2#/operations/add_participant).

After getting the `authToken`, you need to create the `DyteMeetingInfoV2` object as follows:

| Name | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authToken` | After you've created the meeting, <br/> add each participant to the meeting <br/> using the [Add Participant API](/api?v=v2#/operations/add_participant)<br/> (The presetName created earlier <br/> must be passed in the body <br/> of the Add Participant API request) <br/> The API response contains the `authToken`. |
| `baseUrl` | The base URL of the Dyte server. Default value is `https://api.dyte.io/v2`. This is an optional argument. |
| `enableAudio` | A boolean value to enable or disable audio in the meeting. Default value is `true`. This is an optional argument. |
| `enableVideo` | A boolean value to enable or disable video in the meeting. Default value is `true`. This is an optional argument. |

| Name | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `authToken` | After you've created the meeting, <br/> add each participant to the meeting <br/> using the [Add Participant API](/api?v=v2#/operations/add_participant)<br/> (The presetName created earlier <br/> must be passed in the body <br/> of the Add Participant API request) <br/> The API response contains the `authToken`. |
| `baseUrl` | The base URL of the Dyte server. Default value is `https://api.dyte.io/v2`. This is an optional argument. |
| `enableAudio` | A boolean value to enable or disable audio in the meeting. Default value is `true`. This is an optional argument. |
| `enableVideo` | A boolean value to enable or disable video in the meeting. Default value is `true`. This is an optional argument. |

```dart
final meetingInfo = DyteMeetingInfoV2(
Expand All @@ -139,7 +137,6 @@ final meetingInfo = DyteMeetingInfoV2(
The `DyteUIKit` is the main class of the SDK. It is the entry point and the only
class required to initialize Dyte UI Kit SDK. To initialize it we have to pass `DyteUIKitInfo` object as an argument.


```dart
/* Passing the DyteMeetingInfoV2 object `meetingInfo` you created in the Step 3,
Expand All @@ -158,9 +155,18 @@ final uikitInfo = DyteUIKitInfo(
),
);
final uiKit = DyteUIKitBuilder.build(uiKitInfo: uikitInfo, context: context);
final uiKit = DyteUIKitBuilder.build(uiKitInfo: uikitInfo,
skipSetupScreen: true, // optional argument, to skip the setup screen, defaults to false
);
```

:::note

Note: To skip the setup screen, you need to pass the `skipSetupScreen` argument as `true` in the `DyteUIKitBuilder.build` method.

:::

You can learn more about customization of the uikit in the [Design System](/flutter/design-token) section.

## Step 5: Launch the meeting UI
Expand Down Expand Up @@ -217,8 +223,10 @@ Voila! You're all done. Here is the pictorial representation of all the configur
</div>
````
<head>
<title>Flutter Quickstart</title>
<meta name="description" content="Get started quickly with Dyte's Flutter integration. Follow our quickstart guide for seamless integration and development."/>
<meta
name="description"
content="Get started quickly with Dyte's Flutter integration. Follow our quickstart guide for seamless integration and development."
/>
</head>

0 comments on commit eafa789

Please sign in to comment.