RealityFoundation · IOS API REFERENCE

AudioFileResource.Configuration

struct · iOS 18.0+ · SDK 27.1

struct Configuration

A container for various settings for loading an audio file resource.

Members (13)

get · iOS 18.0+

shouldLoop

TypeScript

get shouldLoop(): Promise<boolean>

Swift declaration

var shouldLoop: Bool

Stores a Boolean indicating whether the playback loops infinitely, until manually stopped or paused.

set · iOS 18.0+

shouldLoop

TypeScript

setShouldLoop(value: boolean): Promise<void>

Swift declaration

var shouldLoop: Bool

Stores a Boolean indicating whether the playback loops infinitely, until manually stopped or paused.

get · iOS 18.0+

calibration

TypeScript

get calibration(): Promise<(AudioResource_Calibration) | null>

Swift declaration

var calibration: AudioResource.Calibration?

Stores the calibration setting that the system applies to the audio resource, ensuring optimal playback quality.

set · iOS 18.0+

calibration

TypeScript

setCalibration(value?: (AudioResource_Calibration) | null): Promise<void>

Swift declaration

var calibration: AudioResource.Calibration?

Stores the calibration setting that the system applies to the audio resource, ensuring optimal playback quality.

get · iOS 18.0+

mixGroupName

TypeScript

get mixGroupName(): Promise<(string) | null>

Swift declaration

var mixGroupName: String?

An arbitrary name that can assigns an audio resource to an audio mix group. See ``AudioMixGroup`` and ``AudioMixGroupsComponent`` for more information.

set · iOS 18.0+

mixGroupName

TypeScript

setMixGroupName(value?: (string) | null): Promise<void>

Swift declaration

var mixGroupName: String?

An arbitrary name that can assigns an audio resource to an audio mix group. See ``AudioMixGroup`` and ``AudioMixGroupsComponent`` for more information.

get · iOS 18.0+

normalization

TypeScript

get normalization(): Promise<(AudioResource_Normalization) | null>

Swift declaration

var normalization: AudioResource.Normalization?

Stores the normalization portion of the configuration.

set · iOS 18.0+

normalization

TypeScript

setNormalization(value?: (AudioResource_Normalization) | null): Promise<void>

Swift declaration

var normalization: AudioResource.Normalization?

Stores the normalization portion of the configuration.

init · iOS 18.0+

init

TypeScript

static init(loadingStrategy?: AudioFileResource_LoadingStrategy, shouldLoop?: boolean, shouldRandomizeStartTime?: boolean, normalization?: (AudioResource_Normalization) | null, calibration?: (AudioResource_Calibration) | null, mixGroupName?: (string) | null): Promise<AudioFileResource_Configuration>

Swift declaration

init(loadingStrategy: AudioFileResource.LoadingStrategy = .preload, shouldLoop: Bool = false, shouldRandomizeStartTime: Bool = false, normalization: AudioResource.Normalization? = nil, calibration: AudioResource.Calibration? = nil, mixGroupName: String? = nil)

Initializes a new audio file resource configuration.

get · iOS 18.0+

loadingStrategy

TypeScript

get loadingStrategy(): Promise<AudioFileResource_LoadingStrategy>

Swift declaration

var loadingStrategy: AudioFileResource.LoadingStrategy

Stores the strategy the system uses for handling an audio resource's data before and during playback.

set · iOS 18.0+

loadingStrategy

TypeScript

setLoadingStrategy(value: AudioFileResource_LoadingStrategy): Promise<void>

Swift declaration

var loadingStrategy: AudioFileResource.LoadingStrategy

Stores the strategy the system uses for handling an audio resource's data before and during playback.

get · iOS 18.0+

shouldRandomizeStartTime

TypeScript

get shouldRandomizeStartTime(): Promise<boolean>

Swift declaration

var shouldRandomizeStartTime: Bool

Stores a Boolean indicating whether the playback begins from the start of the file, or from a random position. When this property and ``shouldLoop`` are both true, only the first playback iteration begins from a random position.

set · iOS 18.0+

shouldRandomizeStartTime

TypeScript

setShouldRandomizeStartTime(value: boolean): Promise<void>

Swift declaration

var shouldRandomizeStartTime: Bool

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →