Class SoundObject

Represents a sound object, which is a stream containing sample values that define a sound to be played through the computer's speakers.

Hierarchy (View Summary)

ObjectBase
- SoundObject

Index

Constructors

constructor

new SoundObject(om: ObjectManager): SoundObject
Creates empty instance of a SoundObject object.
Parameters
- om: ObjectManager
  ObjectManager that controls the lifetime of the SoundObject.
Returns SoundObject
Overrides ObjectBase.constructor
new SoundObject(): SoundObject
Creates empty instance of a SoundObject object.

Returns SoundObject
Overrides ObjectBase.constructor
new SoundObject(
om: ObjectManager,
properties: SoundObjectProperties,
): SoundObject
Creates a SoundObject object on the base of properties specified by the SoundObjectProperties.
Parameters
- om: ObjectManager
  ObjectManager that controls the lifetime of the SoundObject.
- properties: SoundObjectProperties
  The properties of created object.
Returns SoundObject
Overrides ObjectBase.constructor
new SoundObject(properties: SoundObjectProperties): SoundObject
Creates a SoundObject object on the base of properties specified by the SoundObjectProperties.
Parameters
- properties: SoundObjectProperties
  The properties of created object.
Returns SoundObject
Overrides ObjectBase.constructor
new SoundObject(
    om: ObjectManager,
    audioData: Uint8Array,
    format?: AudioFormat,
): SoundObject
Creates a SoundObject from audio data of WAF or AIFF format.
Parameters
- om: ObjectManager
  ObjectManager that controls the lifetime of the SoundObject.
- audioData: Uint8Array
  The audio data.
- Optionalformat: AudioFormat
  The audio data format, not specified means 'Auto'.
Returns SoundObject
Overrides ObjectBase.constructor
new SoundObject(audioData: Uint8Array, format?: AudioFormat): SoundObject
Creates a SoundObject from audio data of WAF or AIFF format.
Parameters
- audioData: Uint8Array
  The audio data.
- Optionalformat: AudioFormat
  The audio data format, not specified means 'Auto'.
Returns SoundObject
Overrides ObjectBase.constructor

Accessors

bitsPerSample

get bitsPerSample(): number
Gets or sets the number of bits per sample value per channel.

Returns number
set bitsPerSample(value: number): void
Gets or sets the number of bits per sample value per channel.
Parameters
- value: number
Returns void

encodingFormat

get encodingFormat(): string
Gets or sets the encoding format for the sample data, one of: "Raw", "Signed", "muLaw" or "ALaw".

Returns string
set encodingFormat(value: string): void
Gets or sets the encoding format for the sample data, one of: "Raw", "Signed", "muLaw" or "ALaw".
Parameters
- value: string
Returns void

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

samplingRate

get samplingRate(): number
Gets or sets the sampling rate, in samples per second.

Returns number
set samplingRate(value: number): void
Gets or sets the sampling rate, in samples per second.
Parameters
- value: number
Returns void

soundChannels

get soundChannels(): number
Gets or sets the number of sound channels.

Returns number
set soundChannels(value: number): void
Gets or sets the number of sound channels.
Parameters
- value: number
Returns void

Methods

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ObjectBase.free

getAudioData

getAudioData(): Uint8Array<ArrayBufferLike> | null
Gets a Uint8Array object containing the audio data.

Returns Uint8Array<ArrayBufferLike> | null

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from ObjectBase.rebind

setAudioData

setAudioData(data: Uint8Array<ArrayBufferLike> | null): void
Sets the audio data.
Parameters
- data: Uint8Array<ArrayBufferLike> | null
Returns void

Class SoundObject

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SoundObject

Returns SoundObject

Parameters

Returns SoundObject

Parameters

Returns SoundObject

Parameters

Returns SoundObject

Parameters

Returns SoundObject

Accessors

bitsPerSample

Returns number

Parameters

Returns void

encodingFormat

Returns string

Parameters

Returns void

id

Returns number

om

Returns ObjectManager

samplingRate

Returns number

Parameters

Returns void

soundChannels

Returns number

Parameters

Returns void

Methods

free

Returns void

getAudioData

Returns Uint8Array<ArrayBufferLike> | null

rebind

Parameters

Returns void

setAudioData

Parameters

Returns void

Settings

On This Page