AudioPlayerPlatform class abstract
A nested platform interface for communicating with a particular player instance.
Platform implementations should extend this class rather than implement it
as just_audio
does not consider newly added methods to be breaking
changes. Extending this class (using extends
) ensures that the subclass
will get the default implementation, while platform implementations that
implements
this interface will be broken by newly added
AudioPlayerPlatform methods.
- Implementers
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
final
-
playbackEventMessageStream
→ Stream<
PlaybackEventMessage> -
A broadcast stream of playback events.
no setter
-
playerDataMessageStream
→ Stream<
PlayerDataMessage> -
A broadcast stream of data updates.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
androidEqualizerBandSetGain(
AndroidEqualizerBandSetGainRequest request) → Future< AndroidEqualizerBandSetGainResponse> - Sets the gain for an Android equalizer band.
-
androidEqualizerGetParameters(
AndroidEqualizerGetParametersRequest request) → Future< AndroidEqualizerGetParametersResponse> - Gets the Android equalizer parameters.
-
androidLoudnessEnhancerSetTargetGain(
AndroidLoudnessEnhancerSetTargetGainRequest request) → Future< AndroidLoudnessEnhancerSetTargetGainResponse> - Sets the target gain on the Android loudness enhancer.
-
audioEffectSetEnabled(
AudioEffectSetEnabledRequest request) → Future< AudioEffectSetEnabledResponse> - Changes the enabled status of an audio effect.
-
concatenatingInsertAll(
ConcatenatingInsertAllRequest request) → Future< ConcatenatingInsertAllResponse> - Inserts audio sources into the given concatenating audio source.
-
concatenatingMove(
ConcatenatingMoveRequest request) → Future< ConcatenatingMoveResponse> - Moves an audio source within a concatenating audio source.
-
concatenatingRemoveRange(
ConcatenatingRemoveRangeRequest request) → Future< ConcatenatingRemoveRangeResponse> - Removes audio sources from the given concatenating audio source.
-
dispose(
DisposeRequest request) → Future< DisposeResponse> - This method has been superseded by JustAudioPlatform.disposePlayer. For backward compatibility, this method will still be called as a fallback if JustAudioPlatform.disposePlayer is not implemented.
-
load(
LoadRequest request) → Future< LoadResponse> - Loads an audio source.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
PauseRequest request) → Future< PauseResponse> - Pauses playback.
-
play(
PlayRequest request) → Future< PlayResponse> - Plays the current audio source at the current index and position.
-
seek(
SeekRequest request) → Future< SeekResponse> - Seeks to the given index and position.
-
setAllowsExternalPlayback(
SetAllowsExternalPlaybackRequest request) → Future< SetAllowsExternalPlaybackResponse> - On iOS and macOS, sets the allowsExternalPlayback option, and does nothing on other platforms.
-
setAndroidAudioAttributes(
SetAndroidAudioAttributesRequest request) → Future< SetAndroidAudioAttributesResponse> - On Android, sets the audio attributes, and does nothing on other platforms.
-
setAutomaticallyWaitsToMinimizeStalling(
SetAutomaticallyWaitsToMinimizeStallingRequest request) → Future< SetAutomaticallyWaitsToMinimizeStallingResponse> - On iOS and macOS, sets the automaticallyWaitsToMinimizeStalling option, and does nothing on other platforms.
-
setCanUseNetworkResourcesForLiveStreamingWhilePaused(
SetCanUseNetworkResourcesForLiveStreamingWhilePausedRequest request) → Future< SetCanUseNetworkResourcesForLiveStreamingWhilePausedResponse> - On iOS and macOS, sets the canUseNetworkResourcesForLiveStreamingWhilePaused option, and does nothing on other platforms.
-
setLoopMode(
SetLoopModeRequest request) → Future< SetLoopModeResponse> - Sets the loop mode.
-
setPitch(
SetPitchRequest request) → Future< SetPitchResponse> - Changes the pitch.
-
setPreferredPeakBitRate(
SetPreferredPeakBitRateRequest request) → Future< SetPreferredPeakBitRateResponse> - On iOS and macOS, sets the preferredPeakBitRate option, and does nothing on other platforms.
-
setShuffleMode(
SetShuffleModeRequest request) → Future< SetShuffleModeResponse> - Sets the shuffle mode.
-
setShuffleOrder(
SetShuffleOrderRequest request) → Future< SetShuffleOrderResponse> - Sets the shuffle order.
-
setSkipSilence(
SetSkipSilenceRequest request) → Future< SetSkipSilenceResponse> - Sets skipSilence to true/false.
-
setSpeed(
SetSpeedRequest request) → Future< SetSpeedResponse> - Changes the playback speed.
-
setVolume(
SetVolumeRequest request) → Future< SetVolumeResponse> - Changes the volume.
-
setWebCrossOrigin(
SetWebCrossOriginRequest request) → Future< SetWebCrossOriginResponse> - Sets the 'crossOrigin' attribute on the web audio element.
-
setWebSinkId(
SetWebSinkIdRequest request) → Future< SetWebSinkIdResponse> - Sets a specific device output id on the web audio element.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited