twilio_programmable_video_platform_interface 0.2.0

  • Readme
  • Changelog
  • Installing
  • 89

programmable_video_platform_interface #

A common platform interface for the programmable_video plugin.

This interface allows platform-specific implementations of the programmable_video plugin, as well as the plugin itself, to ensure they are supporting the same interface.

Usage #

To implement a new platform-specific implementation of programmable_video, extend ProgrammableVideoPlatform with an implementation that performs the platform-specific behavior, and when you register your plugin, set the default ProgrammableVideoPlatform by calling ProgrammableVideoPlatform.instance = MyPlatformProgrammableVideo().

Note on breaking changes #

Strongly prefer non-breaking changes (such as adding a method to the interface) over breaking changes for this package.

See https://flutter.dev/go/platform-interface-breaking-changes for a discussion on why a less-clean interface is preferable to a breaking change.

0.2.0 #

  • BREAKING CHANGE: SwitchCamera() can now throw a FormatException if it failed to parse to a CameraSource
  • BREAKING CHANGE: DataTrackModel has been replaced by LocalDataTrackModel
  • BREAKING CHANGE: RemoteDataTrackModel no longer extends DataTrackModel as DataTrackModel has been removed.
  • BREAKING CHANGE: TrackModel is now an abstract class and is no longer meant to be used directly. Various implementations of TrackModel should now be used depending on the use case.
  • BREAKING CHANGE: LocalAudioTrackModel has been added so the TrackModel should not be used anymore to represent LocalAudioTrack's.
  • The models now assert that all needed data is available when using the FromEventChannelMap factory. To see what data is needed for a model see the asserts on the model's constructor.
  • LocalDataTrackModel now has a toMap function.

0.1.0+3 #

  • Removed wrong assertion of localParticipant in Room model

0.1.0+2 #

  • Removed wrong assertion of mediaRegion in Room model

0.1.0+1 #

  • All the files are now correctly exported from the twilio_programmable_video_platform_interface.dart file

0.1.0 #

  • Get rid of pre-release version

0.0.1 #

  • Initial release.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  twilio_programmable_video_platform_interface: ^0.2.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:twilio_programmable_video_platform_interface/twilio_programmable_video_platform_interface.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
83
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
89
Learn more about scoring.

We analyzed this package on Jul 2, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.13
  • Flutter: 1.17.5

Analysis suggestions

Package not compatible with SDK dart

because of import path [twilio_programmable_video_platform_interface] that is in a package requiring null.

Health suggestions

Format lib/src/method_channel_programmable_video.dart.

Run flutter format to format lib/src/method_channel_programmable_video.dart.

Format lib/src/models/connect_options_model.dart.

Run flutter format to format lib/src/models/connect_options_model.dart.

Format lib/src/models/local_participant/local_participant_event.dart.

Run flutter format to format lib/src/models/local_participant/local_participant_event.dart.

Fix additional 13 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/src/models/local_participant/local_participant_model.dart (Run flutter format to format lib/src/models/local_participant/local_participant_model.dart.)
  • lib/src/models/local_participant/local_track_publication_models/local_audio_track_publication_model.dart (Run flutter format to format lib/src/models/local_participant/local_track_publication_models/local_audio_track_publication_model.dart.)
  • lib/src/models/local_participant/local_track_publication_models/local_data_track_publication_model.dart (Run flutter format to format lib/src/models/local_participant/local_track_publication_models/local_data_track_publication_model.dart.)
  • lib/src/models/local_participant/local_track_publication_models/local_video_track_publication_model.dart (Run flutter format to format lib/src/models/local_participant/local_track_publication_models/local_video_track_publication_model.dart.)
  • lib/src/models/remote_data_track_event.dart (Run flutter format to format lib/src/models/remote_data_track_event.dart.)
  • lib/src/models/remote_participant/remote_participant_event.dart (Run flutter format to format lib/src/models/remote_participant/remote_participant_event.dart.)
  • lib/src/models/remote_participant/remote_participant_model.dart (Run flutter format to format lib/src/models/remote_participant/remote_participant_model.dart.)
  • lib/src/models/remote_participant/remote_track_publication_models/remote_audio_track_publication_model.dart (Run flutter format to format lib/src/models/remote_participant/remote_track_publication_models/remote_audio_track_publication_model.dart.)
  • lib/src/models/remote_participant/remote_track_publication_models/remote_data_track_publication_model.dart (Run flutter format to format lib/src/models/remote_participant/remote_track_publication_models/remote_data_track_publication_model.dart.)
  • lib/src/models/remote_participant/remote_track_publication_models/remote_video_track_publication_model.dart (Run flutter format to format lib/src/models/remote_participant/remote_track_publication_models/remote_video_track_publication_model.dart.)
  • lib/src/models/room/room_event.dart (Run flutter format to format lib/src/models/room/room_event.dart.)
  • lib/src/models/tracks/local_video_track_model.dart (Run flutter format to format lib/src/models/tracks/local_video_track_model.dart.)
  • lib/src/programmable_video_platform_interface.dart (Run flutter format to format lib/src/programmable_video_platform_interface.dart.)

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and twilio_programmable_video_platform_interface.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.5.0 <3.0.0
collection ^1.14.12 1.14.12 1.14.13
enum_to_string ^1.0.8 1.0.9
equatable ^1.2.0 1.2.0
flutter 0.0.0
meta ^1.0.5 1.1.8
plugin_platform_interface ^1.0.1 1.0.2
Transitive dependencies
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8
Dev dependencies
flutter_test
mockito ^4.1.1
pedantic ^1.8.0+1