Class AudioBehavior

AudioBehavior is a behavior that allows for the playback of audio files for a game object. It uses the Web Audio API to play audio files.

Hierarchy (View Summary)

OutputBehavior
- AudioBehavior

Index

Constructors

constructor

new AudioBehavior(audioContextFactory?: () => AudioContext): AudioBehavior
Parameters
- audioContextFactory: () => AudioContext = ...
Returns AudioBehavior
Overrides OutputBehavior.constructor
- Defined in Extensions/AudioEngine/AudioBehavior.ts:20

Properties

isPlaying

isPlaying: boolean = false

playbackHistory

playbackHistory: { playbackRate: number; timestamp: number }[] = []

Accessors

`Protected`transform

get transform(): Transform
Returns Transform
Inherited from OutputBehavior.transform
- Defined in Core/OutputBehavior.ts:36

Methods

detach

detach(from: GameObject): void
Detach this behavior from the GameObject it is attached to.
Parameters
- from: GameObject
  The GameObject to detach this behavior from.
Returns void
Throws
Error if the behavior is not attached to the GameObject.
Inherited from OutputBehavior.detach
- Defined in Core/Behavior.ts:27

getLoop

getLoop(): boolean
Returns boolean
- Defined in Extensions/AudioEngine/AudioBehavior.ts:197

getTimestamp

getTimestamp(): number
Gets the current timestamp of the audio.

Returns number
The current timestamp of the audio.
- Defined in Extensions/AudioEngine/AudioBehavior.ts:73

`Protected`observe

observe<T extends LogicBehavior<U>, U>(
BehaviorClass: new (...args: any[]) => T,
observer: (data: U) => void,
): void
Protected
Observe a LogicBehavior and call the observer function when the data changes.
Type Parameters
- T extends LogicBehavior<U>
- U
Parameters
- BehaviorClass: new (...args: any[]) => T
  The specific LogicBehavior class type to observe.
- observer: (data: U) => void
  The function to call when the data changes.
Returns void
Inherited from OutputBehavior.observe
- Defined in Core/OutputBehavior.ts:20

`Protected`onDisable

onDisable(): void
Returns void
Inherited from OutputBehavior.onDisable
- Defined in Core/Behavior.ts:39

`Protected`onEnable

onEnable(): void
Returns void
Inherited from OutputBehavior.onEnable
- Defined in Core/Behavior.ts:35

pause

pause(): Promise<void>
Pauses playback of the audio.

Returns Promise<void>
Throws
If the audio is not playing.

Throws
If the audio source is not set.
- Defined in Extensions/AudioEngine/AudioBehavior.ts:156

play

play(audio?: null | string): Promise<void>
Plays the audio. If the audio is passed in, it will set the audio to play.
Parameters
- audio: null | string = null
Returns Promise<void>
Throws
If the start method has already been called.

Throws
If the audio buffer is not set.

Throws
If the audio source is not set.
- Defined in Extensions/AudioEngine/AudioBehavior.ts:99

reinitialize

reinitialize(): void
Method to reinitialize the behavior

Returns void
- Defined in Extensions/AudioEngine/AudioBehavior.ts:31

setAudio

setAudio(audio: string): Promise<void>
Sets the audio to play.
Parameters
- audio: string
  The URL of the audio file.
Returns Promise<void>
- Defined in Extensions/AudioEngine/AudioBehavior.ts:46

setLoop

setLoop(loop: boolean): void
Sets whether the audio should loop.
Parameters
- loop: boolean
  true to loop, false to not loop.
Returns void
Throws
If the audio source is not set.
- Defined in Extensions/AudioEngine/AudioBehavior.ts:189

setPitch

setPitch(pitch: number): void
Sets the playback rate of the audio.
Parameters
- pitch: number
  a float.
Returns void
Throws
If the audio source is not set.
- Defined in Extensions/AudioEngine/AudioBehavior.ts:177

setup

setup(attachedOn: GameObject): void
Like onEnable, but should only be for internal use, so some non-abstact direct behaviors could expose attachedOn to the user.
Parameters
- attachedOn: GameObject
  The GameObject this behavior is attached to.
Returns void
Throws
Error if the behavior is already attached to a GameObject.
Inherited from OutputBehavior.setup
- Defined in Core/OutputBehavior.ts:9

setVolume

setVolume(volume: number): void
Sets the volume of the audio.
Parameters
- volume: number
  a float between 0 and 1.
Returns void
- Defined in Extensions/AudioEngine/AudioBehavior.ts:168

stop

stop(): Promise<void>
Stops playback of the audio. (This method will also disconnect the audio source.)

Returns Promise<void>
Throws
If the audio source is not set.
- Defined in Extensions/AudioEngine/AudioBehavior.ts:141

`Protected`tick

tick(_deltaTime: number): void
Protected
Called every frame. Override this method to add custom behavior.
Parameters
- _deltaTime: number
  The time in seconds since the last frame.
  
  This method should not be called directly except by the GameEngineWindowComponent.
Returns void
Inherited from OutputBehavior.tick
- Defined in Core/Behavior.ts:48

Class AudioBehavior

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AudioBehavior

Properties

isPlaying

playbackHistory

Accessors

Protectedtransform

Returns Transform

Methods

detach

Parameters

Returns void

Throws

getLoop

Returns boolean

getTimestamp

Returns number

Protectedobserve

Type Parameters

Parameters

Returns void

ProtectedonDisable

Returns void

ProtectedonEnable

Returns void

pause

Returns Promise<void>

Throws

Throws

play

Parameters

Returns Promise<void>

Throws

Throws

Throws

reinitialize

Returns void

setAudio

Parameters

Returns Promise<void>

setLoop

Parameters

Returns void

Throws

setPitch

Parameters

Returns void

Throws

setup

Parameters

Returns void

Throws

setVolume

Parameters

Returns void

stop

Returns Promise<void>

Throws

Protectedtick

Parameters

Returns void

Settings

On This Page

`Protected`transform

`Protected`observe

`Protected`onDisable

`Protected`onEnable

`Protected`tick