Class AudioClipAbstract

Audio clip stores audio data in a compressed or uncompressed format. Clips can be provided to audio sources or other audio methods to be played.

Hierarchy (view full)

Constructors

constructor

Accessors

bitDepth duration format handle is3D isDestroyed metaData name numChannels numSamples readMode sampleRate uuid

Methods

duplicate onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart revert unload

Constructors

Protectedconstructor

Accessors

bitDepth

  • get bitDepth(): number

  • Returns the size of a single sample, in bits.

    Returns number

duration

  • get duration(): number

  • Returns the length of the audio clip, in seconds.

    Returns number

format

handle

is3D

  • get is3D(): boolean

  • Determines will the clip be played a spatial 3D sound, or as a normal sound (for example music).

    Returns boolean

isDestroyed

  • get isDestroyed(): boolean

  • Determines if the resource is destroyed.

    Returns boolean

    Note

    This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

metaData

name

  • get name(): string

  • Name of the resource. Use primarily for easier identification and not important to the engine itself.

    Returns string

numChannels

  • get numChannels(): number

  • Returns the number of channels provided by the clip.

    Returns number

numSamples

  • get numSamples(): number

  • Returns the total number of samples in the clip (includes all channels).

    Returns number

readMode

sampleRate

  • get sampleRate(): number

  • Returns how many samples per second is the audio encoded in.

    Returns number

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

Methods

duplicate

  • duplicate(): Resource

  • Duplicates the resource and creates a unique UUID for the duplicated resource.

    Returns Resource

    The duplicated resource or null, if the duplication failed.

onCreate

  • onCreate(): void
  • Virtual

    Method called by RSX to perform actions required after the creation of the resource.

    Returns void

onDeserializationEnded

  • onDeserializationEnded(): void
  • Virtual

    Method called by RSX to perform any operations needed after deserialization.

    Returns void

    Note

    Use this API to restore your serializable data into live objects.

onDisable

  • onDisable(): void
  • Virtual

    Method called by RSX to disable the resource.

    Returns void

    Note

    Use this API to deactivate the resource before it is serialized.

onEnable

  • onEnable(): void
  • Virtual

    Method called by RSX to enable the resource.

    Returns void

    Note

    Use this API to activate the resource after it has been disabled by serialization.

onInitialize

  • onInitialize(): void
  • Virtual

    Method called by RSX to perform initialization of the resource.

    Returns void

    Note

    Use this API to initialize data and default construct all fields.

onSerializationStart

  • onSerializationStart(): void
  • Virtual

    Method called by RSX to perform any operations before serialization.

    Returns void

    Note

    Use this API to bake your live data into serializable data.

revert

  • revert(): boolean

  • Reverts the resource to the on-disk representation.

    Returns boolean

    Note

    This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

unload

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods