Class AudioClipImportOptions

Contains import options you may use to control how an audio clip is imported.

Hierarchy (View Summary)

ImportOptions
- AudioClipImportOptions

Index

Constructors

Accessors

bitDepth is3D readMode storageFormat

Methods

Constructors

constructor

new AudioClipImportOptions(
isInternalConstructor?: boolean,
): AudioClipImportOptions
Creates a new import options object that allows you to customize how are audio clips imported.
Parameters
- OptionalisInternalConstructor: boolean
Returns AudioClipImportOptions

Overrides ImportOptions.constructor

Accessors

bitDepth

get bitDepth(): number

Size of a single sample in bits. The clip will be converted to this bit depth on import.

Returns number
set bitDepth(value: number): void
Parameters
- value: number
Returns void

is3D

get is3D(): boolean

Determines should the clip be played as spatial (3D) audio or as normal audio. 3D clips will be converted to mono on import.

Returns boolean
set is3D(value: boolean): void
Parameters
- value: boolean
Returns void

readMode

get readMode(): EnumValue<AudioReadMode>

Determines how is audio data loaded into memory.

Returns EnumValue<AudioReadMode>
set readMode(value: EnumValue<AudioReadMode>): void
Parameters
- value: EnumValue<AudioReadMode>
Returns void

storageFormat

get storageFormat(): EnumValue<AudioStorageFormat>

Audio format to store the audio clip as.

Returns EnumValue<AudioStorageFormat>
set storageFormat(value: EnumValue<AudioStorageFormat>): void
Parameters
- value: EnumValue<AudioStorageFormat>
Returns void

Methods

equals

equals(other: ImportOptions): boolean
Virtual
Checks if this object has the same contents as the provided one.
Parameters
- other: ImportOptions
Returns boolean

Inherited from ImportOptions.equals