Class Sound

No Self In File

Hierarchy

Handle<sound>
- Sound

Index

Constructors

Properties

Accessors

duration id loading playing

Constructors

constructor

new Sound(fileName: string, looping: boolean, is3D: boolean, stopWhenOutOfRange: boolean, fadeInRate: number, fadeOutRate: number, eaxSetting: string): Sound
Parameters
- fileName: string
- looping: boolean
- is3D: boolean
- stopWhenOutOfRange: boolean
- fadeInRate: number
- fadeOutRate: number
- eaxSetting: string
Returns Sound
Overrides Handle.constructor
- Defined in w3ts/handles/sound.ts:7

Properties

`Readonly` handle

handle: sound

Accessors

duration

get duration(): number
Returns number
- Defined in w3ts/handles/sound.ts:31
set duration(duration: number): void
Parameters
- duration: number
Returns void
- Defined in w3ts/handles/sound.ts:35

id

get id(): number
Returns number
Inherited from Handle.id
- Defined in w3ts/handles/handle.ts:15

loading

get loading(): boolean
Returns boolean
- Defined in w3ts/handles/sound.ts:39

playing

get playing(): boolean
Returns boolean
- Defined in w3ts/handles/sound.ts:43

Methods

killWhenDone

killWhenDone(): void
Returns void
- Defined in w3ts/handles/sound.ts:47

registerStacked

registerStacked(byPosition: boolean, rectWidth: number, rectHeight: number): void
Parameters
- byPosition: boolean
- rectWidth: number
- rectHeight: number
Returns void
- Defined in w3ts/handles/sound.ts:51

setChannel

setChannel(channel: number): void
Parameters
- channel: number
Returns void
- Defined in w3ts/handles/sound.ts:55

setConeAngles

setConeAngles(inside: number, outside: number, outsideVolume: number): void
Parameters
- inside: number
- outside: number
- outsideVolume: number
Returns void
- Defined in w3ts/handles/sound.ts:59

setConeOrientation

setConeOrientation(x: number, y: number, z: number): void
Parameters
- x: number
- y: number
- z: number
Returns void
- Defined in w3ts/handles/sound.ts:63

setDistanceCutoff

setDistanceCutoff(cutoff: number): void
Parameters
- cutoff: number
Returns void
- Defined in w3ts/handles/sound.ts:67

setDistances

setDistances(minDist: number, maxDist: number): void
Parameters
- minDist: number
- maxDist: number
Returns void
- Defined in w3ts/handles/sound.ts:71

setParamsFromLabel

setParamsFromLabel(soundLabel: string): void
Parameters
- soundLabel: string
Returns void
- Defined in w3ts/handles/sound.ts:87

setPitch

setPitch(pitch: number): void
Parameters
- pitch: number
Returns void
- Defined in w3ts/handles/sound.ts:91

setPlayPosition

setPlayPosition(millisecs: number): void
Must be called immediately after starting the sound
Parameters
- millisecs: number
Returns void
- Defined in w3ts/handles/sound.ts:99

setPosition

setPosition(x: number, y: number, z: number): void
Parameters
- x: number
- y: number
- z: number
Returns void
- Defined in w3ts/handles/sound.ts:103

setVelocity

setVelocity(x: number, y: number, z: number): void
Parameters
- x: number
- y: number
- z: number
Returns void
- Defined in w3ts/handles/sound.ts:107

setVolume

setVolume(volume: number): void
Parameters
- volume: number
Returns void
- Defined in w3ts/handles/sound.ts:111

start

start(): void
Returns void
- Defined in w3ts/handles/sound.ts:115

stop

stop(killWhenDone: boolean, fadeOut: boolean): void
Parameters
- killWhenDone: boolean
- fadeOut: boolean
Returns void
- Defined in w3ts/handles/sound.ts:119

unregisterStacked

unregisterStacked(byPosition: boolean, rectWidth: number, rectHeight: number): void
Parameters
- byPosition: boolean
- rectWidth: number
- rectHeight: number
Returns void
- Defined in w3ts/handles/sound.ts:123

`Static` fromHandle

fromHandle(handle: sound): Sound
Parameters
- handle: sound
Returns Sound
- Defined in w3ts/handles/sound.ts:127

`Static` getFileDuration

getFileDuration(fileName: string): number
Parameters
- fileName: string
Returns number
- Defined in w3ts/handles/sound.ts:131

`Static` `Protected` getObject

getObject(handle: handle): any
Parameters
- handle: handle
Returns any
Inherited from Handle.getObject
- Defined in w3ts/handles/handle.ts:23

`Static` initFromHandle

initFromHandle(): boolean
Returns boolean
Inherited from Handle.initFromHandle
- Defined in w3ts/handles/handle.ts:19