Class ComponentAudio

Builds a minimal audio graph (by default in AudioManager.default) and synchronizes it with the containing Node

┌ AudioManager(.default) ────────────────────────┐
│ ┌ ComponentAudio ───────────────────┐          │
│ │    ┌──────┐   ┌──────┐   ┌──────┐ │ ┌──────┐ │  
│ │    │source│ → │panner│ → │ gain │ → │ gain │ │
│ │    └──────┘   └──────┘   └──────┘ │ └──────┘ │  
│ └───────────────────────────────────┘          │
└────────────────────────────────────────────────┘

Authors

Thomas Dorner, HFU, 2019 | Jirka Dell'Oro-Friedl, HFU, 2019

Hierarchy (view full)

Component
- ComponentAudio

Constructors

constructor

new ComponentAudio(_audio?, _loop?, _start?, _audioManager?): ComponentAudio
Parameters
- _audio: Audio = null
- _loop: boolean = false
- _start: boolean = false
- _audioManager: AudioManager = AudioManager.default
Returns ComponentAudio
Overrides Component.constructor
- Defined in Source/Core/Component/ComponentAudio.ts:47

Properties

mtxPivot

mtxPivot: Matrix4x4 = ...

places and directs the panner relative to the world transform of the Node

`Static` `Readonly` baseClass

baseClass: typeof Component = Component

refers back to this class from any subclass e.g. in order to find compatible other resources

`Static` `Readonly` iSubclass

iSubclass: number = ...

subclasses get a iSubclass number for identification

`Static` `Readonly` subclasses

subclasses: typeof Component[] = []

list of all the subclasses derived from this class, if they registered properly

Accessors

isActive

get isActive(): boolean
Returns boolean
Inherited from Component.isActive
- Defined in Source/Core/Component/Component.ts:36

isAttached

get isAttached(): boolean
Returns boolean
- Defined in Source/Core/Component/ComponentAudio.ts:88

isListened

get isListened(): boolean
Returns boolean
- Defined in Source/Core/Component/ComponentAudio.ts:92

isPlaying

get isPlaying(): boolean
Returns boolean
- Defined in Source/Core/Component/ComponentAudio.ts:84

isSingleton

get isSingleton(): boolean
Is true, when only one instance of the component class can be attached to a node

Returns boolean
Inherited from Component.isSingleton
- Defined in Source/Core/Component/Component.ts:43

loop

get loop(): boolean
Returns boolean
- Defined in Source/Core/Component/ComponentAudio.ts:71
set loop(_on): void
Parameters
- _on: boolean
Returns void
- Defined in Source/Core/Component/ComponentAudio.ts:67

node

get node(): Node
Retrieves the node, this component is currently attached to

Returns Node
Inherited from Component.node
- Defined in Source/Core/Component/Component.ts:50

playbackRate

get playbackRate(): number
Returns number
- Defined in Source/Core/Component/ComponentAudio.ts:79
set playbackRate(_value): void
Parameters
- _value: number
Returns void
- Defined in Source/Core/Component/ComponentAudio.ts:75

type

get type(): string
Retrieves the type of this mutable subclass as the name of the runtime class

Returns string
The type of the mutable
Inherited from Component.type
- Defined in Source/Core/Serialization/Mutable.ts:175

volume

get volume(): number
Returns number
- Defined in Source/Core/Component/ComponentAudio.ts:63
set volume(_value): void
Parameters
- _value: number
Returns void
- Defined in Source/Core/Component/ComponentAudio.ts:59

Methods

activate

activate(_on): void
Activate override. Connects or disconnects AudioNodes
Parameters
- _on: boolean
Returns void
Overrides Component.activate
- Defined in Source/Core/Component/ComponentAudio.ts:185

addEventListener

addEventListener(_type, _handler, _options?): void
See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from Component.addEventListener
- Defined in Source/Core/Event/Event.ts:91

attachToNode

attachToNode(_container): void
Tries to attach the component to the given node, removing it from the node it was attached to if applicable
Parameters
- _container: Node
Returns void
Inherited from Component.attachToNode
- Defined in Source/Core/Component/Component.ts:65

connect

connect(_on): void
Connects this components gain-node to the gain node of the AudioManager this component runs on. Only call this method if the component is not attached to a Node but needs to be heard.
Parameters
- _on: boolean
Returns void
- Defined in Source/Core/Component/ComponentAudio.ts:194

deserialize

deserialize(_serialization): Promise<Serializable>
Recreates this instance of Serializable with the information from the given Serialization.
Parameters
- _serialization: Serialization
Returns Promise<Serializable>
Overrides Component.deserialize
- Defined in Source/Core/Component/ComponentAudio.ts:220

dispatchEvent

dispatchEvent(_event): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from Component.dispatchEvent
- Defined in Source/Core/Event/Event.ts:105

drawGizmos

drawGizmos(): void
Override this to draw visual aids for this component inside the editors render view. Use Gizmos inside the override to draw stuff.

Returns void
Overrides Component.drawGizmos
- Defined in Source/Core/Component/ComponentAudio.ts:201

`Optional` drawGizmosSelected

drawGizmosSelected(_cmpCamera?): void
See drawGizmos. Only displayed while the corresponding node is selected.
Parameters
- Optional _cmpCamera: ComponentCamera
Returns void
Inherited from Component.drawGizmosSelected
- Defined in Source/Core/Component/Component.ts:88

getAudio

getAudio(): Audio
Returns the Audio currently used as audio source

Returns Audio
- Defined in Source/Core/Component/ComponentAudio.ts:106

getAudioNode

getAudioNode(_type): AudioNode
Returns the specified AudioNode of the standard graph for further manipulation
Parameters
- _type: AUDIO_NODE_TYPE
Returns AudioNode
- Defined in Source/Core/Component/ComponentAudio.ts:130

getMetaAttributeTypes

getMetaAttributeTypes(): MetaAttributeTypes
Retrieves the specified attribute types from the metadata of this instance's class.

Returns MetaAttributeTypes
Inherited from Component.getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:265

getMetadata

getMetadata(): Metadata
Retrieves the metadata of this instance's class.

Returns Metadata
Inherited from Component.getMetadata
- Defined in Source/Core/Serialization/Mutable.ts:272

getMutator

getMutator(): Mutator
Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.

Returns Mutator
Overrides Component.getMutator
- Defined in Source/Core/Component/ComponentAudio.ts:229

getMutatorAttributeTypes

getMutatorAttributeTypes(_mutator): MutatorAttributeTypes
Returns an associative array with the same attributes as the given mutator, but with the corresponding types as string-values. Does not recurse into objects! This will return the decorated meta-type instead of the runtime-type of the object, if available.
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from Component.getMutatorAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:242

getMutatorForAnimation

getMutatorForAnimation(_extendable?): MutatorForAnimation
Collect the attributes of the instance and their values applicable for animation. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForAnimation
Inherited from Component.getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:219

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?): MutatorForUserInterface
Collect the attributes of the instance and their values applicable for the user interface. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForUserInterface
Inherited from Component.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:227

getMutatorOfNode

getMutatorOfNode(_type): Mutator
Returns the mutator for the specified AudioNode of the standard graph
Parameters
- _type: AUDIO_NODE_TYPE
Returns Mutator
- Defined in Source/Core/Component/ComponentAudio.ts:121

insertAudioNodes

insertAudioNodes(_input, _output): void

Inserts AudioNodes between the panner and the local gain of this ComponentAudio _input and _output may be the same AudioNode, if there is only one to insert, or may have multiple AudioNode between them to create an effect-graph.
Note that ComponentAudio does not keep track of inserted AudioNodes!

┌ AudioManager(.default) ──────────────────────────────────────────────────────┐
│ ┌ ComponentAudio ─────────────────────────────────────────────────┐          │
│ │    ┌──────┐   ┌──────┐   ┌──────┐          ┌───────┐   ┌──────┐ │ ┌──────┐ │  
│ │    │source│ → │panner│ → │_input│ → ...  → │_output│ → │ gain │ → │ gain │ │
│ │    └──────┘   └──────┘   └──────┘          └───────┘   └──────┘ │ └──────┘ │  
│ └─────────────────────────────────────────────────────────────────┘          │
└──────────────────────────────────────────────────────────────────────────────┘

Parameters

_input: AudioNode
_output: AudioNode

Returns void

mutate

mutate(_mutator, _selection?, _dispatchMutate?): Promise<void>
Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses
Parameters
- _mutator: Mutator
- _selection: string[] = null
- _dispatchMutate: boolean = true
Returns Promise<void>
Inherited from Component.mutate
- Defined in Source/Core/Component/Component.ts:103

play

play(_on): void
Start or stop playing the audio
Parameters
- _on: boolean
Returns void
- Defined in Source/Core/Component/ComponentAudio.ts:141

removeEventListener

removeEventListener(_type, _handler, _options?): void
See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from Component.removeEventListener
- Defined in Source/Core/Event/Event.ts:98

serialize

serialize(): Serialization
Returns a Serialization of this object.

Returns Serialization
Overrides Component.serialize
- Defined in Source/Core/Component/ComponentAudio.ts:210

setAudio

setAudio(_audio): void
Sets the given Audio as the audio source
Parameters
- _audio: Audio
Returns void
- Defined in Source/Core/Component/ComponentAudio.ts:99

setPanner

setPanner(_property, _value): void
Set the property of the panner to the given value. Use to manipulate range and rolloff etc.
Parameters
- _property: AUDIO_PANNER
- _value: number
Returns void
- Defined in Source/Core/Component/ComponentAudio.ts:113

updateMutator

updateMutator(_mutator): void
Updates the values of the given mutator according to the current state of the instance
Parameters
- _mutator: Mutator
Returns void
Inherited from Component.updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:280

`Static` getMutatorFromPath

getMutatorFromPath(_mutator, _path): Mutator
Decorator allows to attach Mutable functionality to existing classes.
Parameters
- _mutator: Mutator
- _path: string[]
Returns Mutator
Inherited from Component.getMutatorFromPath
- Defined in Source/Core/Serialization/Mutable.ts:160

Class ComponentAudio

Authors

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ComponentAudio

Properties

mtxPivot

Static Readonly baseClass

Static Readonly iSubclass

Static Readonly subclasses

Accessors

isActive

Returns boolean

isAttached

Returns boolean

isListened

Returns boolean

isPlaying

Returns boolean

isSingleton

Returns boolean

loop

Returns boolean

Parameters

Returns void

node

Returns Node

playbackRate

Returns number

Parameters

Returns void

type

Returns string

volume

Returns number

Parameters

Returns void

Methods

activate

Parameters

Returns void

addEventListener

Parameters

Returns void

attachToNode

Parameters

Returns void

connect

Parameters

Returns void

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

drawGizmos

Returns void

Optional drawGizmosSelected

Parameters

Returns void

getAudio

Returns Audio

getAudioNode

Parameters

Returns AudioNode

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getMutator

Returns Mutator

getMutatorAttributeTypes

`Static` `Readonly` baseClass

`Static` `Readonly` iSubclass

`Static` `Readonly` subclasses

`Optional` drawGizmosSelected

`Static` getMutatorFromPath