Document FullAudioPlaybackState
This commit is contained in:
parent
12ce6ed653
commit
60aeecf107
|
@ -373,6 +373,9 @@ class AudioPlaybackEvent {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Enumerates the different playback states of a player.
|
/// Enumerates the different playback states of a player.
|
||||||
|
///
|
||||||
|
/// If you also need access to the buffering state, use
|
||||||
|
/// [FullAudioPlaybackState].
|
||||||
enum AudioPlaybackState {
|
enum AudioPlaybackState {
|
||||||
none,
|
none,
|
||||||
stopped,
|
stopped,
|
||||||
|
@ -382,6 +385,11 @@ enum AudioPlaybackState {
|
||||||
completed,
|
completed,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Encapsulates the playback state and the buffering state.
|
||||||
|
///
|
||||||
|
/// These two states vary orthogonally, and so if [buffering] is true, you can
|
||||||
|
/// check [state] to determine whether this buffering is occurring during the
|
||||||
|
/// playing state or the paused state.
|
||||||
class FullAudioPlaybackState {
|
class FullAudioPlaybackState {
|
||||||
final AudioPlaybackState state;
|
final AudioPlaybackState state;
|
||||||
final bool buffering;
|
final bool buffering;
|
||||||
|
|
Loading…
Reference in New Issue