[]
        
(Showing Draft Content)

ActionSound

Class: ActionSound

Represents an action that plays a sound.

Extends

Constructors

Constructor

new ActionSound(om): ActionSound;

Creates a new ActionSound.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the ActionSound.

Returns

ActionSound

Overrides

ActionBase.constructor

Constructor

new ActionSound(): ActionSound;

Creates a new ActionSound.

Returns

ActionSound

Overrides

ActionBase.constructor

Accessors

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ActionBase.id


mix

Get Signature

get mix(): boolean;

Gets or sets a value specifying whether to mix this sound with any other sound already playing. If false, any previously playing sound is stopped before starting this sound. The default is false.

Returns

boolean


om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ActionBase.om


repeat

Get Signature

get repeat(): boolean;

Gets or sets a value specifying whether to repeat the sound indefinitely. If true, the synchronous property is ignored. The default is false.

Returns

boolean


sound

Get Signature

get sound(): SoundObject;

Gets or sets the SoundObject specifying the sound to play.

Returns

SoundObject


synchronous

Get Signature

get synchronous(): boolean;

Gets or sets a value specifying whether to play the sound synchronously or asynchronously. If true, the viewer retains control until the sound has been completely played. The default is false.

Returns

boolean


volume

Get Signature

get volume(): number;

Gets or sets the volume at which to play the sound, in the range from -1.0 to 1.0. The default is 1.0.

Returns

number

Methods

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ActionBase.free


rebind()

rebind(omTo): 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

ActionBase.rebind