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.

Sign up for GitHub

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

Jump to bottom

docs: add kotlin version setup for flutter_core and guides #368

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add kotlin version setup for flutter_core and guides #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a5d48e
docs: added kotlin version step for flutter_core
saksham-gt May 17, 2024
968eba4
docs: added kotlin version step in flutter guide
saksham-gt May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/flutter-core/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,27 @@ You'll learn how to:

After importing the package, perform the following steps for Android and iOS.

### For Android

Set `compileSdkVersion 33` and `minSdkVersion 21` inside `build.gradle` file at the `<project root>/android/app/build.gradle` file.

```kotlin
defaultConfig {
...

compileSdkVersion 33
minSdkVersion 21

...
}
```
Comment on lines +74 to +85
Copy link
Contributor

@swapnilmadavi swapnilmadavi Jul 4, 2024 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(suggestion): Setting compileSdkVersion and especially minSdkVersion should be client's call.
We can inform clients that our SDK supports/requires

  • minSdkVersion 21 or higher &
  • compileSdkVersion 33 or higher


And change the kotlin version to `1.9.0`

```kotlin
ext.kotlin_version = '1.9.0'
```

### For iOS

1. Set your platform to iOS 13.0 or above in your Podfile.
Expand Down
23 changes: 11 additions & 12 deletions docs/flutter/quickstart.mdx
View file
Open in desktop
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 @@ -161,6 +158,7 @@ final uikitInfo = DyteUIKitInfo(
final uiKit = DyteUIKitBuilder.build(uiKitInfo: uikitInfo, context: context);

```

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 @@ -215,10 +213,11 @@ 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>
6 changes: 6 additions & 0 deletions docs/partials/_flutter-quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ flutter pub add dyte_uikit
}
```

And change the kotlin version to `1.9.0`

```kotlin
ext.kotlin_version = '1.9.0'
```

- ### **iOS**

1. Set minimum deployment target for your Flutter app to 13.0 or higher.
Expand Down