docs: Updates and rewrite for Flutter Video documentation #683
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nash0x7E2
requested changes
May 31, 2024
| @@ -4,52 +4,31 @@ title: Introduction | |||
| description: Introduction to Stream's Video SDK | |||
| --- | |||
|
|
|||
| Welcome to the Stream [Flutter SDK](https://getstream.io/video/sdk/flutter/) - a comprehensive toolkit designed to help developers quickly implement real-time video calling, audio rooms, and live streaming directly into their Flutter app, all in Dart. | |||
| Welcome to the Stream Video Flutter SDK - a comprehensive toolkit designed to help you swiftly implement features such as video calling, audio calling, audio rooms, and livestreaming within your app. | |||
There was a problem hiding this comment.
Link to the main tutorial page please.
| Push notifications are implemented and handled by `stream_video_push_notification`. This package configures the integration between Flutter and the underlying platform (iOS and Android), allowing for seamless integration and handling of push and call notifications to the device. Our push service is backed by Firebase Cloud Messaging. | ||
|
|
||
| Please refer to our push notifications section for a more detailed guide. | ||
| If you feel like anything is missing or could be improved, please don't hesitate to contact us. We're happy to help. |
There was a problem hiding this comment.
Maybe a link to our twitter and product@getstream.io email?
| @@ -51,20 +57,6 @@ In the code above, we are performing a few key steps: | |||
| 3. Creating an object for our call, giving it the call type and unique ID. | |||
| 4. Connecting to the call we defined. | |||
|
|
|||
|
|
|||
| Although it is not shown in the example above, users can choose to customize many different aspects of the SDK during initialization. Here are a few of the parameters which can be overridden during initialization: | |||
There was a problem hiding this comment.
It's important to keep this table in, a common piece of feedback we get from customers is there is no single place for them to look at what parameters or options can be configured at the top level.
| To create a call, we first call the `makeCall` function on the `StreamVideo` class and pass it the call type and ID. The most common call type is `default`, which enables full audio and video transmission. However, as we will learn later, there are multiple call types (and even custom types) from which you can choose based on your use case. | ||
| To create a call, we first call the `makeCall` function on the `StreamVideo` class and pass it the call type and ID. | ||
| The most common call type is `default`, which enables full audio and video transmission. | ||
| However, as seen later, there are multiple call types (and even custom types) from which you can choose based on your use case. |
There was a problem hiding this comment.
Should we mention the three other call types in a table as well?
Call type | Name | Short overview
| @@ -23,9 +33,37 @@ StreamBuilder<CallState>( | |||
| ), | |||
| ``` | |||
|
|
|||
| The following fields are available on the call: | |||
|
|
|||
| | Attribute | Description| | |||
| Combining `CallState` and `CallParticipantState` makes building custom UIs and integrations a breeze. If there is a property or API that is not exposed for your specific use case, feel free to reach out to us. We are constantly iterating and exposing APIs based on your feedback. | ||
| The following fields are available on the participant: | ||
|
|
||
| | Attribute | Description| |
| @@ -5,13 +5,6 @@ title: Camera and Microphone | |||
|
|
|||
| Working with hardware devices can always have some level of complexity to it but the SDK does a lot to abstract the complexities and expose an intuitive interface for querying the connected devices and changing them throughout the call. | |||
|
|
|||
| For turning the user’s camera on and off, the following methods can be invoked directly on the `Call` class: | |||
There was a problem hiding this comment.
Why are we removing this snippet?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the Flutter Video SDK documentation to match with other SDKs.