Tivy

style: very good analysis Powered by Mason License: MIT

Utility package for getting video information of YouTube and Vimeo video urls.

Installation ๐Ÿ’ป

โ— In order to start using Tivy you must have the Flutter SDK installed on your machine.

Add tivy to your pubspec.yaml:

dependencies:
  tivy:

Install it:

flutter packages get

Usage

  • Import package

    import 'package:tivy/tivy.dart';
    
  • Use with vimeo video url

    final videoQualityUrls = await tivy.getVideoQualityUrls(
      'https://vimeo.com/663563090',
    );
    
  • Use with vimeo video id

    final videoQualityUrls = await tivy.getVideoQualityUrls(
      '663563090',
    );
    
  • For vimeo private video

    final videoQualityUrls = await tivy.getPrivateVimeoVideoQualityUrls(
      '663563090',
      {
        'key': 'value',
      },
    );
    
  • For YouTube video url.

    final videoQualityUrls = await tivy.getYouTubeVideoQualityUrls(
      'https://www.youtube.com/watch?v=CRLPsOl4AAA',
    );
    
  • For YouTube live streaming video url.

    final videoQualityUrls = await tivy.getYouTubeVideoQualityUrls(
      'https://www.youtube.com/watch?v=CRLPsOl4AAA',
      live: true,
    );
    

Continuous Integration ๐Ÿค–

Tivy comes with a built-in GitHub Actions workflow powered by Very Good Workflows but you can also add your preferred CI/CD solution.

Out of the box, on each pull request and push, the CI formats, lints, and tests the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses Very Good Analysis for a strict set of analysis options used by our team. Code coverage is enforced using the Very Good Workflows.


Running Tests ๐Ÿงช

For first time users, install the very_good_cli:

dart pub global activate very_good_cli

To run all unit tests:

very_good test --coverage

To view the generated coverage report you can use lcov.

# Generate Coverage Report
genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
open coverage/index.html

Libraries

tivy
Utility package for getting video quality urls for vimeo and youtube.