@orillusion/media-extention

---

Class: PositionAudio

Defined in: packages/media-extention/PositionAudio.ts:8

Dynamic audio component, with volume varying based on the relative position of the monitor

Extends

• StaticAudio

Constructors

Constructor

new PositionAudio(): PositionAudio

Defined in: packages/media-extention/PositionAudio.ts:14

Returns

PositionAudio

Overrides

StaticAudio.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

StaticAudio.object3D

---

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

StaticAudio.isDestroyed

---

panner

panner: PannerNode

Defined in: packages/media-extention/PositionAudio.ts:9

---

context

context: AudioContext = null

Defined in: packages/media-extention/StaticAudio.ts:9

Inherited from

StaticAudio.context

---

gainNode

gainNode: GainNode = null

Defined in: packages/media-extention/StaticAudio.ts:10

Inherited from

StaticAudio.gainNode

---

source

source: AudioBufferSourceNode = null

Defined in: packages/media-extention/StaticAudio.ts:11

Inherited from

StaticAudio.source

---

playing

playing: boolean = false

Defined in: packages/media-extention/StaticAudio.ts:16

Inherited from

StaticAudio.playing

Accessors

visibleLayer

Get Signature

get visibleLayer(): number

Defined in: src/components/ComponentBase.ts:46

Composition-layer membership bitmask. The pass / camera / collector filters via

(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0

Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.

Returns

number

Set Signature

set visibleLayer(value): void

Defined in: src/components/ComponentBase.ts:50

Parameters

value

number

Returns

void

Inherited from

StaticAudio.visibleLayer

---

eventDispatcher

Get Signature

get eventDispatcher(): CEventDispatcher

Defined in: src/components/ComponentBase.ts:63

Returns

CEventDispatcher

Set Signature

set eventDispatcher(value): void

Defined in: src/components/ComponentBase.ts:68

Parameters

value

CEventDispatcher

Returns

void

Inherited from

StaticAudio.eventDispatcher

---

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

StaticAudio.isStart

---

transform

Get Signature

get transform(): Transform

Defined in: src/components/ComponentBase.ts:89

Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..

Returns

Transform

Inherited from

StaticAudio.transform

---

enable

Get Signature

get enable(): boolean

Defined in: src/components/ComponentBase.ts:113

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Set Signature

set enable(value): void

Defined in: src/components/ComponentBase.ts:96

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

value

boolean

Returns

void

Inherited from

StaticAudio.enable

---

refDistance

Get Signature

get refDistance(): number

Defined in: packages/media-extention/PositionAudio.ts:99

Returns

number

Set Signature

set refDistance(value): void

Defined in: packages/media-extention/PositionAudio.ts:102

Parameters

value

number

Returns

void

---

rolloffFactor

Get Signature

get rolloffFactor(): number

Defined in: packages/media-extention/PositionAudio.ts:108

Returns

number

Set Signature

set rolloffFactor(value): void

Defined in: packages/media-extention/PositionAudio.ts:111

Parameters

value

number

Returns

void

---

distanceModel

Get Signature

get distanceModel(): DistanceModelType

Defined in: packages/media-extention/PositionAudio.ts:114

Returns

DistanceModelType

Set Signature

set distanceModel(value): void

Defined in: packages/media-extention/PositionAudio.ts:117

Parameters

value

DistanceModelType

Returns

void

---

maxDistance

Get Signature

get maxDistance(): number

Defined in: packages/media-extention/PositionAudio.ts:120

Returns

number

Set Signature

set maxDistance(value): void

Defined in: packages/media-extention/PositionAudio.ts:123

Parameters

value

number

Returns

void

Methods

init()

init(param?): void

Defined in: src/components/ComponentBase.ts:161

Parameters

param?

any

Returns

void

Inherited from

StaticAudio.init

---

onEnable()?

optional onEnable(view?): any

Defined in: src/components/ComponentBase.ts:164

Parameters

view?

View3D

Returns

any

Inherited from

StaticAudio.onEnable

---

onDisable()?

optional onDisable(view?): any

Defined in: src/components/ComponentBase.ts:165

Parameters

view?

View3D

Returns

any

Inherited from

StaticAudio.onDisable

---

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

StaticAudio.onLateUpdate

---

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

StaticAudio.onBeforeUpdate

---

onCompute()?

optional onCompute(view?, command?): any

Defined in: src/components/ComponentBase.ts:169

Parameters

view?

View3D

command?

GPUCommandEncoder

Returns

any

Inherited from

StaticAudio.onCompute

---

onGraphic()?

optional onGraphic(view?): any

Defined in: src/components/ComponentBase.ts:170

Parameters

view?

View3D

Returns

any

Inherited from

StaticAudio.onGraphic

---

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

StaticAudio.onParentChange

---

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

StaticAudio.onAddChild

---

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

StaticAudio.onRemoveChild

---

cloneTo()

cloneTo(obj): void

Defined in: src/components/ComponentBase.ts:180

clone component data to target object3D

Parameters

obj

Object3D

target object3D

Returns

void

Inherited from

StaticAudio.cloneTo

---

copyComponent()

copyComponent(from): this

Defined in: src/components/ComponentBase.ts:182

Parameters

from

this

Returns

this

Inherited from

StaticAudio.copyComponent

---

beforeDestroy()

beforeDestroy(force?): void

Defined in: src/components/ComponentBase.ts:249

before release this component, object refrences are not be set null now.

Parameters

force?

boolean

Returns

void

Inherited from

StaticAudio.beforeDestroy

---

setLisenter()

setLisenter(listener): this

Defined in: packages/media-extention/PositionAudio.ts:17

Parameters

listener

AudioListener

Returns

this

Overrides

StaticAudio.setLisenter

---

showHelper()

showHelper(thickness?, step?): void

Defined in: packages/media-extention/PositionAudio.ts:24

Parameters

thickness?

number

step?

number

Returns

void

---

hideHelper()

hideHelper(): void

Defined in: packages/media-extention/PositionAudio.ts:78

Returns

void

---

toggleHelper()

toggleHelper(): void

Defined in: packages/media-extention/PositionAudio.ts:87

Returns

void

---

updateHeler()

updateHeler(): void

Defined in: packages/media-extention/PositionAudio.ts:95

Returns

void

---

setDirectionalCone()

setDirectionalCone(coneInnerAngle, coneOuterAngle, coneOuterGain): PositionAudio

Defined in: packages/media-extention/PositionAudio.ts:130

Parameters

coneInnerAngle

number

coneOuterAngle

number

coneOuterGain

number

Returns

PositionAudio

---

start()

start(): void

Defined in: packages/media-extention/PositionAudio.ts:142

Returns

void

Overrides

StaticAudio.start

---

stop()

stop(): this

Defined in: packages/media-extention/PositionAudio.ts:144

Returns

this

Overrides

StaticAudio.stop

---

onUpdate()

onUpdate(): void

Defined in: packages/media-extention/PositionAudio.ts:147

Returns

void

Overrides

StaticAudio.onUpdate

---

destroy()

destroy(force?): void

Defined in: packages/media-extention/PositionAudio.ts:170

release this component

Parameters

force?

boolean

Returns

void

Overrides

StaticAudio.destroy

---

load()

load(url, options?): Promise<void>

Defined in: packages/media-extention/StaticAudio.ts:40

Parameters

url

string

options?

Returns

Promise<void>

Inherited from

StaticAudio.load

---

loadBuffer()

loadBuffer(buffer, options?): Promise<void>

Defined in: packages/media-extention/StaticAudio.ts:46

Parameters

buffer

ArrayBuffer

options?

Returns

Promise<void>

Inherited from

StaticAudio.loadBuffer

---

play()

play(): this

Defined in: packages/media-extention/StaticAudio.ts:55

Returns

this

Inherited from

StaticAudio.play

---

pause()

pause(): this

Defined in: packages/media-extention/StaticAudio.ts:78

Returns

this

Inherited from

StaticAudio.pause

---

setVolume()

setVolume(value): this

Defined in: packages/media-extention/StaticAudio.ts:94

Parameters

value

number

Returns

this

Inherited from

StaticAudio.setVolume