Skip to content

Commit a51dea6

Browse files
authored
feat(*): add a zoom API
1 parent a313c7b commit a51dea6

File tree

1 file changed

+31
-14
lines changed

1 file changed

+31
-14
lines changed

sdks/livestream/apivideo-flutter-livestream.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
---
22
## THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT. IF YOU NEED TO CHANGE THIS FILE, CREATE A PR IN THE SOURCE REPOSITORY.
33
title: Flutter RTMP live stream client
4-
meta:
5-
description: The official Flutter RTMP live stream client for api.video. [api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
4+
meta:
5+
description: The official Flutter RTMP live stream client for
6+
api.video. api.video is the video infrastructure for product builders.
7+
Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live
8+
streaming features in your app.
69
---
710

811
# Flutter RTMP Live stream Client
912

10-
[api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
13+
[api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast
14+
video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in
15+
your app.
16+
1117

1218
## Project description
1319

@@ -17,11 +23,10 @@ This module is made for broadcasting RTMP live stream from smartphone camera.
1723

1824
### Installation
1925

20-
In your pubspec.yaml file, add the following:
26+
Run the following command at the root of your project:
2127

22-
```yaml
23-
dependencies:
24-
apivideo_live_stream: ^1.1.3
28+
```shell
29+
flutter pub add apivideo_live_stream
2530
```
2631

2732
In your dart file, import the package:
@@ -34,7 +39,7 @@ import 'package:apivideo_live_stream/apivideo_live_stream.dart';
3439

3540
To be able to broadcast, you must:
3641

37-
1) On Android: ask for internet, camera and microphone permissions:
42+
1. On Android: ask for internet, camera and microphone permissions:
3843

3944
```xml
4045

@@ -46,8 +51,9 @@ To be able to broadcast, you must:
4651
```
4752

4853
The library will require android.permission.CAMERA and android.permission.RECORD_AUDIO at runtime.
54+
You don't need to request them.
4955

50-
2) On iOS: update the Info.plist with a usage description for camera and microphone
56+
2. On iOS: update the Info.plist with a usage description for camera and microphone
5157

5258
```xml
5359

@@ -75,12 +81,23 @@ await _controller.initialize();
7581

7682
3. Adds a CameraPreview widget as a child of your view
7783

78-
Ensure that _controller.create() has been finished before creating the CameraPreview widget.
79-
8084
```dart
81-
child: ApiVideoCameraPreview(controller: _controller),
85+
@override
86+
Widget build(BuildContext context) {
87+
return SizedBox(
88+
width: 300.0,
89+
height: 300.0,
90+
child: ApiVideoCameraPreview(controller: _controller));
91+
}
8292
```
8393

94+
`ApiVideoCameraPreview` parameters:
95+
96+
- `controller`: the live stream controller
97+
- `fit`: the fit of the preview (default is BoxFit.contain,
98+
see [BoxFit](https://api.flutter.dev/flutter/painting/BoxFit.html) for more information)
99+
- `child`: a child widget to overlay on top of the preview (optional)
100+
84101
4. Starts a live stream
85102

86103
```dart
@@ -147,7 +164,7 @@ identifier.
147164

148165
## Plugins
149166

150-
api.video Flutter live stream library is using external native library:
167+
api.video Flutter live stream library is using external native libraries:
151168

152169
| Plugin | README |
153170
|------------|--------------|
@@ -156,7 +173,7 @@ api.video Flutter live stream library is using external native library:
156173

157174
## FAQ
158175

159-
If you have any questions, ask us in the [community](https://community.api.video). Or
176+
If you have any questions, ask us in the [community](https://community.api.video) or
160177
use [issues](https://github.com/apivideo/api.video-flutter-live-stream/issues).
161178

162179
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)

0 commit comments

Comments
 (0)