SoundHandle
Defined in: audio/src/SoundHandle.ts:4
Wraps an IMediaInstance, tracking playing state via end/stop events.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SoundHandle(
instance):SoundHandle
Defined in: audio/src/SoundHandle.ts:8
Parameters
Section titled “Parameters”instance
Section titled “instance”IMediaInstance
Returns
Section titled “Returns”SoundHandle
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get id():
number
Defined in: audio/src/SoundHandle.ts:18
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get muted():
boolean
Defined in: audio/src/SoundHandle.ts:50
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set muted(
v):void
Defined in: audio/src/SoundHandle.ts:46
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
paused
Section titled “paused”Get Signature
Section titled “Get Signature”get paused():
boolean
Defined in: audio/src/SoundHandle.ts:58
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set paused(
v):void
Defined in: audio/src/SoundHandle.ts:54
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
playing
Section titled “playing”Get Signature
Section titled “Get Signature”get playing():
boolean
Defined in: audio/src/SoundHandle.ts:22
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get speed():
number
Defined in: audio/src/SoundHandle.ts:42
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set speed(
v):void
Defined in: audio/src/SoundHandle.ts:38
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
volume
Section titled “volume”Get Signature
Section titled “Get Signature”get volume():
number
Defined in: audio/src/SoundHandle.ts:34
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set volume(
v):void
Defined in: audio/src/SoundHandle.ts:30
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Methods
Section titled “Methods”stop()
Section titled “stop()”stop():
void
Defined in: audio/src/SoundHandle.ts:26
Returns
Section titled “Returns”void