Flutter Stream Save

A sample Flutter project for demonstrating how to integrate video streaming service with the help of MUX.

Project README

Flutter Video Streaming (MUX integration)

A sample Flutter project for demonstrating how to integrate video streaming service with the help of MUX.

To get step-by-step information on how to build this app, check out the article "Integrating video streaming with Flutter using Mux"

Usage

If you want to try this sample app, follow the steps mentioned below (the app uses a backend API server for sending the requests to MUX):

  • Clone this GitHub repository

    https://github.com/sbis04/flutter_stream.git
    
  • Create a .env file in the directory flutter_stream/mux-api-server with the following content:

    MUX_TOKEN_ID="<mux_token_id>"
    MUX_TOKEN_SECRET="<mux_token_secret>"
    
  • Generate MUX API Access Token from here (if you don't have a MUX account, create one by going here)

  • This will generate a Token ID and Token Secret, add them to the .env file

  • Run the API server (for testing) using the following command from the directory flutter_stream/mux-api-server:

    node main.js
    
  • Get packages by running the following from the root directory:

    flutter pub get
    

Now, you are ready to run this app on your device, just use the this command:

cd flutter_stream
fluter run

Plugins

The plugins that are used in this app are as follows:

  • dio - for making HTTP POST and GET requests
  • video_player - for previewing the video to be streamed
  • intl - to format DateTime objects

Testing

Used the plugin http_mock_adapter for writing a few API mocking tests in Dart.

License

Copyright (c) 2021 Souvik Biswas

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Open Source Agenda is not affiliated with "Flutter Stream" Project. README Source: sbis04/flutter_stream
Stars
29
Open Issues
4
Last Commit
2 years ago
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating