API reference
API reference
Select your platform
No SDKs available
No versions available

Audio

Audio

class Audio(file: String, volume: Float = 1.0f) : ComponentBase
Audio component that can be attached to an entity. This component will play audio spatially from the entity.
Parameters
JVM
NameSummary
file
The Uri String of the audio file to be used
volume
The volume of the audio to be played, default is 1.0f

Constructors

NameSummary
Audio
constructor(file: String, volume: Float = 1.0f)

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
audio
var audio: String
The Uri String of the audio file to be used
cachable
val cachable: Boolean = false
creationTime
var creationTime: Long
isDirty
var isDirty: Boolean
recycled
var recycled: Boolean
volume
var volume: Float
The volume of the audio to be played, default is 1.0f

Functions

NameSummary
getComponentDataAttributeType
fun getComponentDataAttributeType(key: Int): AttributeType?
fun getComponentDataAttributeType(keyString: String): AttributeType?
getComponentDataKey
fun getComponentDataKey(key: String): Int?
getComponentDataValue
fun getComponentDataValue(key: Int): Any?
fun getComponentDataValue(keyString: String): Any?
getEnumClass
fun getEnumClass(key: String): Class<out Enum<*>>?
hasComponentData
fun hasComponentData(key: Int): Boolean
fun hasComponentData(keyString: String): Boolean
read
fun read(e: Entity, cachable: Boolean)
recycle
fun recycle()
reset
open fun reset()
setComponentDataValue
fun setComponentDataValue(key: Int, value: Any?): Boolean
fun setComponentDataValue(keyString: String, value: Any?): Boolean
setPool
fun setPool(pool: ComponentPool<*>)
toString
open override fun toString(): String
typeID
open override fun typeID(): Int
write
fun write(e: Entity)

Companion

object Companion : ComponentCompanion

Properties

NameSummary
createDefaultInstance
open override val createDefaultInstance: () -> Audio
id
open override val id: <Error class: unknown class>

Functions

NameSummary
dependents
open fun dependents(): IntArray
Did you find this page helpful?
Thumbs up icon
Thumbs down icon