class · iOS 13.0+ · SDK 27.1
@MainActor @preconcurrency class AudioFileResourceAn audio resource that you load from a file or from a URL. Load an audio file resource, like an audio file stored in .aiff or other format, by calling one of the load functions. Use the resource to create an ``AudioPlaybackController`` instance by calling an entity’s ``Entity/prepareAudio(_:)`` or ``Entity/playAudio(_:)`` function. The controller plays the audio from the location in space of the entity that created the controller.
static initContentsOfWithNameConfiguration(url: string, resourceName?: (string) | null, configuration?: AudioFileResource_Configuration): Promise<AudioFileResource>@MainActor @preconcurrency convenience init(contentsOf url: URL, withName resourceName: String? = nil, configuration: AudioFileResource.Configuration = .init()) async throwsInitializes an AudioFileResource asynchronously. - Important: The name provided **must** be unique.
get shouldLoop(): Promise<boolean>@MainActor @preconcurrency var shouldLoop: Bool { get set }Whether or not this file loops during playback. This should be set for assets that are prepared as seamless loops. A looping resource will play forever until it is explicitly told to stop.
setShouldLoop(value: boolean): Promise<void>@MainActor @preconcurrency var shouldLoop: Bool { get set }Whether or not this file loops during playback. This should be set for assets that are prepared as seamless loops. A looping resource will play forever until it is explicitly told to stop.
get configuration(): Promise<AudioFileResource_Configuration>@MainActor @preconcurrency final let configuration: AudioFileResource.ConfigurationThe configuration of this `AudioFileResource`.
get loadingStrategy(): Promise<AudioFileResource_LoadingStrategy>@MainActor @preconcurrency var loadingStrategy: AudioFileResource.LoadingStrategy { get set }The resource's memory model.
setLoadingStrategy(value: AudioFileResource_LoadingStrategy): Promise<void>@MainActor @preconcurrency var loadingStrategy: AudioFileResource.LoadingStrategy { get set }The resource's memory model.
static initFromConfiguration(data: ArrayBuffer, configuration?: AudioFileResource_Configuration): Promise<AudioFileResource>@MainActor @preconcurrency convenience init(from data: Data, configuration: AudioFileResource.Configuration = .init()) async throwsInitializes an AudioFileResource from in-memory data asynchronously. This API creates a memory-resident audio resource that never writes to disk. The data must contain a valid audio file format (WAV, M4A, etc.). - Parameters: - data: The audio file data in memory - configuration: Configuration settings for the audio resource - Throws: `AudioFileResource.Error` if the data is invalid or cannot be processed
static loadContentsOfWithNameConfiguration(url: string, name?: (string) | null, configuration?: AudioFileResource_Configuration): Promise<AudioFileResource>@MainActor @preconcurrency static func load(contentsOf url: URL, withName name: String? = nil, configuration: AudioFileResource.Configuration = .init()) throws -> AudioFileResourceLoads an AudioFileResource synchronously. - Important: The name provided **must** be unique.
static loadContentsOfWithNameInputModeLoadingStrategyShouldLoop(url: string, resourceName?: (string) | null, inputMode?: AudioResource_InputMode, loadingStrategy?: AudioFileResource_LoadingStrategy, shouldLoop?: boolean): Promise<AudioFileResource>@MainActor @preconcurrency static func load(contentsOf url: URL, withName resourceName: String? = nil, inputMode: AudioResource.InputMode = .spatial, loadingStrategy: AudioFileResource.LoadingStrategy = .preload, shouldLoop: Bool = false) throws -> AudioFileResourceSynchronously loads an audio resource.
static loadNamedInConfiguration(name: string, bundle?: (_Foundation_Bundle) | null, configuration?: AudioFileResource_Configuration): Promise<AudioFileResource>@MainActor @preconcurrency static func load(named name: String, in bundle: Bundle? = nil, configuration: AudioFileResource.Configuration = .init()) throws -> AudioFileResourceLoads an AudioFileResource synchronously. - Important: The name provided **must** be unique.
static loadNamedInInputModeLoadingStrategyShouldLoop(name: string, bundle?: (_Foundation_Bundle) | null, inputMode?: AudioResource_InputMode, loadingStrategy?: AudioFileResource_LoadingStrategy, shouldLoop?: boolean): Promise<AudioFileResource>@MainActor @preconcurrency static func load(named name: String, in bundle: Bundle? = nil, inputMode: AudioResource.InputMode = .spatial, loadingStrategy: AudioFileResource.LoadingStrategy = .preload, shouldLoop: Bool = false) throws -> AudioFileResourceSynchronously loads an audio resource.
static loadNamedFromIn(name: string, scene: string, bundle?: (_Foundation_Bundle) | null): Promise<AudioFileResource>@MainActor @preconcurrency static func load(named name: String, from scene: String, in bundle: Bundle? = nil) throws -> AudioFileResourceLoads a preconfigured AudioFileResource from a Reality Composer Pro project with the given `name` as the the prim-path of the AudioFile, and the `scene` as the name of the USD file name. - Important: The name provided **must** be unique.
get name(): Promise<string>@MainActor @preconcurrency final let name: StringThe name of this `AudioFileResource`.
static initNamedInConfiguration(name: string, bundle?: (_Foundation_Bundle) | null, configuration?: AudioFileResource_Configuration): Promise<AudioFileResource>@MainActor @preconcurrency convenience init(named name: String, in bundle: Bundle? = nil, configuration: AudioFileResource.Configuration = .init()) async throwsInitializes an AudioFileResource asynchronously. - Important: The name provided **must** be unique.
static initNamedFromIn(name: string, scene: string, bundle?: (_Foundation_Bundle) | null): Promise<AudioFileResource>@MainActor @preconcurrency convenience init(named name: String, from scene: String, in bundle: Bundle? = nil) async throwsInitializes a preconfigured AudioFileResource asynchronously from a Reality Composer Pro project with the given `name` as the the prim-path of the AudioFile, and the `scene` as the name of the USD file name. - Important: The name provided **must** be unique.
get duration(): Promise<SDKHandle>@MainActor @preconcurrency var duration: Duration { get }The duration of this `AudioFileResource`.
static loadAsyncContentsOfWithNameInputModeLoadingStrategyShouldLoop(url: string, resourceName?: (string) | null, inputMode?: AudioResource_InputMode, loadingStrategy?: AudioFileResource_LoadingStrategy, shouldLoop?: boolean): Promise<LoadRequest<AudioFileResource>>@MainActor @preconcurrency static func loadAsync(contentsOf url: URL, withName resourceName: String? = nil, inputMode: AudioResource.InputMode = .spatial, loadingStrategy: AudioFileResource.LoadingStrategy = .preload, shouldLoop: Bool = false) -> LoadRequest<AudioFileResource>static loadAsyncNamedInInputModeLoadingStrategyShouldLoop(name: string, bundle?: (_Foundation_Bundle) | null, inputMode?: AudioResource_InputMode, loadingStrategy?: AudioFileResource_LoadingStrategy, shouldLoop?: boolean): Promise<LoadRequest<AudioFileResource>>@MainActor @preconcurrency static func loadAsync(named name: String, in bundle: Bundle? = nil, inputMode: AudioResource.InputMode = .spatial, loadingStrategy: AudioFileResource.LoadingStrategy = .preload, shouldLoop: Bool = false) -> LoadRequest<AudioFileResource>No declarations were skipped in this snapshot.