Run a Sample HLS Project - Flutter

Video SDK provides open-source sample project videosdk-hls-flutter-sdk-example on Github. This document introduces how to run this project.

note

The sample project still uses Flutter SDK v4.0.1. To build an app on v5.0.0, follow the HLS Quick Start.

Prerequisites

• If your target platform is iOS, your development environment must meet the following requirements:
  • Flutter 3.41 or later
  • Dart 3.3.0 or later
  • macOS
  • Xcode (Latest version recommended)
• If your target platform is Android, your development environment must meet the following requirements:
  • Flutter 3.41 or later
  • Dart 3.3.0 or later
  • macOS or Windows
  • Android Studio (Latest version recommended)
• If your target platform is iOS, you need an iPhone or iPad, or the iOS Simulator on a Mac with Apple silicon.
• If your target platform is Android, you need an ARM Android device, or an Android emulator with an arm64-v8a system image. x86 and x86_64 emulators are not supported.
• Valid Video SDK Account

Generate Token

To manage secured communication, every participant that connects to a meeting needs an access token. You can easily generate this token by using your apiKey and secret-key, which you can obtain from the VideoSDK Dashboard.

For development purpose, you can generate a temporary token from VideoSDK Dashboard's API section.

tip

The best practice for obtaining a token involves generating it from your backend server which will help in keeping your credentials safe.

Run the Sample Project

Step 1: Clone the sample project

1

Clone the sample project

Clone the repository to your local environment.

$ git clone https://github.com/videosdk-live/videosdk-hls-flutter-sdk-example.git

Step 2: Copy the .env.example file to .env file.

2

Copy the .env.example file to .env file

Open your favorite code editor and copy .env.example to .env file.

$ cp .env.example .env

Step 3: Modify .env file

3

Modify .env file

Paste earlier generated temporary token here.

.env

AUTH_TOKEN = "TEMPORARY-TOKEN";

Step 4: Install the dependencies

4

Install the dependencies

Install all the dependencies to run the project.

flutter pub get

Before you build for Android, pin permission_handler to version 12. The sample does not pin it, and version 13 fails the Android build (see Known Issues).

flutter pub add permission_handler:^12.0.1

Step 5: Run the Sample App

5

Run the Sample App

Bingo, it's time to push the launch button.

flutter run