exttex/just_audio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update comments and provide default implementations of platform interface.

Browse source
This commit is contained in:
Ryan Heise 2020-09-27 14:00:37 +10:00
parent 1be1c212f6
commit aa57e7fad8
3 changed files with 86 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

21
just_audio_platform_interface/README.md
View file

@ -1,26 +1,15 @@
# just_audio_platform_interface
A common platform interface for the [`just_audio`][../just_audio] plugin.
A common platform interface for the [`just_audio`](../just_audio) plugin.
This interface allows platform-specific implementations of the `just_audio`
plugin, as well as the plugin itself, to ensure they are supporting the
same interface.
This interface allows platform-specific implementations of the `just_audio` plugin, as well as the plugin itself, to ensure they are supporting the same interface.
# Usage
To implement a new platform-specific implementation of `just_audio`, extend
[`JustAudioPlatform`][2] with an implementation that performs the
platform-specific behavior, and when you register your plugin, set the default
`JustAudioPlatform` by calling
`JustAudioPlatform.instance = MyPlatformJustAudio()`.
To implement a new platform-specific implementation of `just_audio`, extend [`JustAudioPlatform`](lib/just_audio_platform_interface.dart) with an implementation that performs the platform-specific behavior, and when you register your plugin, set the default `JustAudioPlatform` by calling `JustAudioPlatform.instance = MyPlatformJustAudio()`.
# Note on breaking changes
Strongly prefer non-breaking changes (such as adding a method to the interface)
over breaking changes for this package.
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.
[1]: ../just_audio
[2]: lib/just_audio_platform_interface.dart
See https://flutter.dev/go/platform-interface-breaking-changes for a discussion on why a less-clean interface is preferable to a breaking change.