API Documentation for: 2.1.0
Show:

AudioInst Class

Defined in: AudioInst:790
Namespace: cloudkid

A playing instance of a sound. This class is primarily for compatability/standardization with CloudKidSound, and to make syncing animation with audio easier. These can only be created through cloudkid.Audio.instance.play().

Item Index

Methods

Methods

pause

() public

Defined in pause:848

Pauses Audio, if this AudioInst is still valid.

stop

() public

Defined in stop:835

Stops Audio, if this AudioInst is still valid.

unpause

() public

Defined in unpause:861

Resumes playing Audio, if this AudioInst is still valid.

Properties

_end

Number private

Defined in _end:810

The end time of the sound in milliseconds.

_start

Number private

Defined in _start:804

The start time of the sound in milliseconds.

isValid

Bool public

Defined in isValid:797

If this AudioInst is still valid (still the actively playing audio bit). If this is false, then Audio is no longer playing this sound and this object should be discarded.

length

Number public

Defined in length:816

The length of the sound in milliseconds.

position

Number public

Defined in position:824

The position of the sound playhead in milliseconds, or 0 if the AudioInst is no longer valid.