stream-chat-android-client/io.getstream.chat.android.client.audio/AudioPlayer

AudioPlayer

interface AudioPlayer

Audio player used to play audio messages.

Properties

currentPlayingId

abstract val currentPlayingId: Int

The identifier of the current audio track. If there is no current audio track, it returns -1.

abstract val currentState: AudioState

Current state of the current audio.

Functions

abstract fun changeSpeed()

Changes the speed of reproduction. Options are 1x, 1.5x and 2x

abstract fun clearTracks()

abstract fun currentSpeed(): Float

Current speed of reproduction. Options are 1x, 1.5x and 2x

abstract fun dispose()

Disposes the MediaPlayer and remove all audios.

getCurrentPositionInMs

abstract fun getCurrentPositionInMs(audioHash: Int): Int

Returns the current position of the audio track in milliseconds.

abstract fun pause()

Pauses the current song.

abstract fun play(sourceUrl: String, audioHash: Int)

Plays an audio track with sourceUrl.

abstract fun prepare(sourceUrl: String, audioHash: Int)

registerOnAudioStateChange

abstract fun registerOnAudioStateChange(audioHash: Int, onAudioStateChange: (AudioState) -> Unit)

Subscribing for audio state changes for the audio of the hash

registerOnProgressStateChange

abstract fun registerOnProgressStateChange(audioHash: Int, onProgressDataChange: (ProgressData) -> Unit)

Subscribing for progress changes for the audio of the hash. The progress is updated every 50ms

registerOnSpeedChange

abstract fun registerOnSpeedChange(audioHash: Int, onSpeedChange: (Float) -> Unit)

Subscribing for speed changes for the audio of the hash.

abstract fun registerTrack(sourceUrl: String, audioHash: Int, position: Int)

abstract fun removeAudio(audioHash: Int)

Removes the current audio form the reproduction queue and removes the listeners

abstract fun removeAudios(audioHashList: List<Int>)

Removes the current audios form the reproduction queue and removes the listeners

abstract fun reset()

Resets the player to the initial state and removes all audios.

abstract fun resetAudio(audioHash: Int)

abstract fun resume(audioHash: Int)

abstract fun seekTo(positionInMs: Int, audioHash: Int)

Seeks the audio track of the audio hash to the millisecond position. If the hash is the same of the current playing audio track, the current audio track pauses.

abstract fun startSeek(audioHash: Int)

Informs the player that seek has started. This can be used to pause the current audio track when seek starts.