core/com.pico.spatial.core.ecs.audio/AudioPlayerController

AudioPlayerController

A handle that is used to control audio playback，including playing, pausing, resuming, stopping an audio, and checking the playback status of an audio.

Properties

entity

val entity: Entity?

The entity that the audio is playing on.

valid

@get:JvmName(name = "isValid")

val valid: Boolean

The controller is valid.

Functions

open override fun close()

fade

fun fade(targetVolume: Float = 1.0f, duration: Long, fadeMode: AudioInterpolatorType = AudioInterpolatorType.CUBIC): Boolean

Fade the audio to the specified volume over a specified duration.

getCurrentPosition

fun getCurrentPosition(): Long

Gets the current playback position of the audio file in milliseconds.

getDuration

fun getDuration(): Long

Gets the total duration of the audio file in milliseconds.

getPlaybackSpeed

fun getPlaybackSpeed(): Float

Gets the current playback speed for the audio.

getVolume

fun getVolume(): Float

Gets the playback volume.

isCompleted

fun isCompleted(): Boolean

Checks if an audio is finished playing or not.

isPlaying

fun isPlaying(): Boolean

Checks if an audio is playing or not.

pause

fun pause(): Boolean

Pauses an audio that is playing.

play

fun play(): Boolean

Plays an audio.

resume

fun resume(): Boolean

Resumes an paused audio.

seekTo

fun seekTo(position: Long): Boolean

Seeks to the specified playback position in the current audio.

setLoop

fun setLoop(loop: Boolean): Boolean

Enables or disables looping for audio playback.

setPlaybackSpeed

fun setPlaybackSpeed(rate: Float): Boolean

Sets the playback speed for the audio.

setVolume

fun setVolume(@FloatRange(from = 0.0, to = 1.0) volume: Float = 1.0f): Boolean

Set the playback volume.

stop

fun stop(): Boolean

Stops an audio.