core/com.pico.spatial.core.ecs/ChannelAudioComponent

ChannelAudioComponent

@MainThread

A Component that can be added to an entity to enable channel audio effects.

This component do not take audio source's position and orientation into account, left channel is heard from the left, and the right channel is heard from the right.

Notes:

Do not add ObjectAudioComponent, AmbientAudioComponent, and ChannelAudioComponent to the same entity simultaneously.
Always add ObjectAudioComponent, AmbientAudioComponent, or ChannelAudioComponent to the entity before calling Entity.prepareAudio or Entity.playAudio.

Constructors

ChannelAudioComponent

constructor()

Creates a ChannelAudioComponent instance with empty settings.

constructor(@FloatRange(from = 0.0, to = 1.0) volume: Float = 1.0f)

Creates a ChannelAudioComponent instance with the specified volume. If the volume is invalid, not in range [0.0, 1.0], use default 1.0f instead.

Properties

volume

var volume: Float

The volume of the audio. The valid value range is [0.0, 1.0]. The default value is 1.0f.

Functions

clone

open override fun clone(): Component

Creates and returns a copy of this Component instance.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String