https://github.com/baseflow/screenrecorder
Flutter package which can be used to record flutter widgets
https://github.com/baseflow/screenrecorder
flutter flutter-widgets gifs hacktoberfest screen-capture screen-recorder screenrecorder
Last synced: about 2 months ago
JSON representation
Flutter package which can be used to record flutter widgets
- Host: GitHub
- URL: https://github.com/baseflow/screenrecorder
- Owner: Baseflow
- License: mit
- Created: 2021-04-05T17:05:48.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-28T01:28:31.000Z (10 months ago)
- Last Synced: 2025-06-26T11:06:31.182Z (9 months ago)
- Topics: flutter, flutter-widgets, gifs, hacktoberfest, screen-capture, screen-recorder, screenrecorder
- Language: Dart
- Homepage: https://pub.dev/packages/screen_recorder
- Size: 196 KB
- Stars: 72
- Watchers: 3
- Forks: 31
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
----
> 🚧 This is highly experimental! 🚧
>
> 🚧 API is subject to change! 🚧
This is a package to create recordings of Flutter widgets.
The recordings can be exported as GIFs.
This is pure Flutter/Dart implementation without any dependencies on native
or platform code. Thus it runs on all supported platforms.
Please note, that the encoding of the GIF takes a lot of time. On web it is basically useless because it takes so much time.
## 🚀 Getting Started
### Setup
First, you will need to add `screen_recorder` to your `pubspec.yaml`:
```yaml
dependencies:
flutter:
sdk: flutter
screen_recorder: x.y.z # use the latest version found on pub.dev
```
Then, run `flutter packages get` in your terminal.
## Example
Wrap your widget which should be recorded in a `ScreenRecorder`:
```dart
ScreenRecorder(
height: 200,
width: 200,
background: Colors.white,
controller: ScreenRecorderController(
pixelRatio: 0.5,
skipFramesBetweenCaptures: 2,
),
child: // child which should be recorded
);
```
Then use `ScreenRecorderController.start()` to start recording and
`ScreenRecorderController.stop()` to stop the recording.
`final gif = await ScreenRecorderController.export()` gives you the result which can be written to disk.
A complete example can be found [here](https://pub.dev/packages/screen_recorder/example).
## ⚠️ Known issues and limitations
- Platform views are invisible in screenshots (like [webview](https://pub.dev/packages/webview_flutter) or [Google Maps](https://pub.dev/packages/google_maps_flutter)). For further details, see this [Flutter issue](https://github.com/flutter/flutter/issues/25306) and [this issue](https://github.com/flutter/flutter/issues/102866). Please give a 👍 to those issues in order to raise awareness and the prio of those issues.
- Web only works with Flutter's CanvasKit Renderer, for more information see [Flutter Web Renderer docs](https://flutter.dev/docs/development/tools/web-renderers).
- This package does not and will not support audio until it is possible in a pure Dart/Flutter environment.
- This package does not and will not support exporting as a video until it is possible in a pure Dart/Flutter environment.
## Convert gif to video
In order to convert the gif to a video, you can try one of the following libraries. Please note, that compatibility was not tested.
| Library | Stats |
|---------|-------|
| [ffmpeg_kit_flutter](https://pub.dev/packages/ffmpeg_kit_flutter) | 
|
| [flutter_video_compress](https://pub.dev/packages/flutter_video_compress) | 
|
| [video_editor](https://pub.dev/packages/video_editor) | 
|
| [video_trimmer](https://pub.dev/packages/video_trimmer) | 
|
| [video_compress](https://pub.dev/packages/video_compress) | 
|
## 📣 About the author
[](https://github.com/ueman)
[](https://twitter.com/ue_man)
## Contributors
