just_audio library

Classes

AndroidEqualizer
An AudioEffect for Android that can adjust the gain for different frequency bands of an AudioPlayer's audio signal.
AndroidEqualizerBand
A frequency band within an AndroidEqualizer.
AndroidEqualizerParameters
The parameter values of an AndroidEqualizer.
AndroidExtractorOptions
AndroidLivePlaybackSpeedControl
Speed control for live streams on Android.
AndroidLoadControl
Buffering and loading options for Android.
AndroidLoudnessEnhancer
An Android AudioEffect that boosts the volume of the audio signal to a target gain, which defaults to zero.
AudioEffect
Subclasses of AudioEffect can be inserted into an AudioPipeline to modify the audio signal outputted by an AudioPlayer. The same audio effect instance cannot be set on multiple players at the same time.
AudioLoadConfiguration
Configuration options to use when loading audio from a source.
AudioPipeline
AudioPlayer
An object to manage playing audio from a URL, a locale file or an asset.
AudioSource
Specifies a source of audio to be played. Audio sources are composable using the subclasses of this class. The same AudioSource instance should not be used simultaneously by more than one AudioPlayer.
ClippingAudioSource
An AudioSource that clips the audio of a UriAudioSource between a certain start and end time.
ConcatenatingAudioSource
An AudioSource representing a concatenation of multiple audio sources to be played in succession. This can be used to create playlists. Playback between items will be gapless on Android, iOS and macOS, while there will be a slight gap on Web.
DarwinAssetOptions
DarwinLoadControl
Buffering and loading options for iOS/macOS.
DashAudioSource
An AudioSource representing a DASH stream. The following URI schemes are supported:
DefaultShuffleOrder
The default implementation of ShuffleOrder which shuffles items with the currently playing item at the head of the order.
HlsAudioSource
An AudioSource representing an HLS stream. The following URI schemes are supported:
IcyHeaders
IcyInfo
IcyMetadata
IndexedAudioSource
An AudioSource that can appear in a sequence.
LockCachingAudioSource
This is an experimental audio source that caches the audio while it is being downloaded and played. It is not supported on platforms that do not provide access to the file system (e.g. web).
LoopingAudioSource
PlaybackEvent
Encapsulates the playback state and current position of the player.
PlayerState
Encapsulates the playing and processing states. These two states vary orthogonally, and so if processingState is ProcessingState.buffering, you can check playing to determine whether the buffering occurred while the player was playing or while the player was paused.
PositionDiscontinuity
Information collected when a position discontinuity occurs.
ProgressiveAudioSource
An AudioSource representing a regular media file such as an MP3 or M4A file. The following URI schemes are supported:
ProgressiveAudioSourceOptions
SequenceState
Encapsulates the sequence and currentIndex state and ensures consistency such that currentIndex is within the range of sequence.length. If sequence.length is 0, then currentIndex is also 0.
ShuffleOrder
Defines the algorithm for shuffling the order of a ConcatenatingAudioSource. See DefaultShuffleOrder for a default implementation.
SilenceAudioSource
An AudioSource for a period of silence.
StreamAudioResponse
The response for a StreamAudioSource. This API is experimental.
StreamAudioSource
An AudioSource that provides audio dynamically. Subclasses must override request to provide the encoded audio data. This API is experimental.
UriAudioSource
An abstract class representing audio sources that are loaded from a URI.

Enums

LoopMode
An enumeration of modes that can be passed to AudioPlayer.setLoopMode.
PositionDiscontinuityReason
The reasons for position discontinuities.
ProcessingState
Enumerates the different processing states of a player.

Mixins

AndroidAudioEffect
An AudioEffect that supports Android.
DarwinAudioEffect
An AudioEffect that supports iOS and macOS.

Exceptions / Errors

PlayerException
Captures the details of any error accessing, loading or playing an audio source, including an invalid or inaccessible URL, or an audio encoding that could not be understood.
PlayerInterruptedException
An error that occurs when one operation on the player has been interrupted (e.g. by another simultaneous operation).