Sound.AudioSettings

Description: Defines a set of settings that are used to play AudioClip's a custom way.

Implements: EndGate.ICloneable

Constructors

AudioSettings ()
Creates a new instance of the AudioSettings object with default values.

AudioSettings (repeat)
Creates a new instance of the AudioSettings object.

repeat: boolean
Initial value of the repeat component.

AudioSettings (repeat, volume)
Creates a new instance of the AudioSettings object.

repeat: boolean
Initial value of the repeat component.

volume: number
Initial value of the volume component. Value between 0-100.

AudioSettings (repeat, volume, autoplay)
Creates a new instance of the AudioSettings object.

repeat: boolean
Initial value of the repeat component.

volume: number
Initial value of the volume component. Value between 0-100.

autoplay: boolean
Initial value of the auto play component.

AudioSettings (repeat, volume, autoplay, preload)
Creates a new instance of the AudioSettings object.

repeat: boolean
Initial value of the repeat component.

volume: number
Initial value of the volume component. Value between 0-100.

autoplay: boolean
Initial value of the auto play component.

preload: string
Initial value of the preload component. Values can be "auto", "metadata", or "none".

Fields

(Static) Default: AudioSettings
The default audio settings.

Repeat: boolean
Gets or sets the repeat function of the AudioClip.

Volume: number
Gets or sets the volume level of the AudioClip. Value between 0-100.

AutoPlay: boolean
Gets or sets the auto play functionality of the AudioClip.

Preload: string
Gets or sets the preload functionality of the AudioClip. Values can be "auto", "metadata", or "none".

Methods

Clone()
Returns a new AudioSettings object that is identical to the current AudioSettings object.

Examples

There's currently no example available for this page. If you'd like to suggest one send me an containing a description, code, and link to the page for the suggested example. As a thanks I'll associate the code snippet with your name directly below the example if approved.