CreateMLComponents · IOS API REFERENCE

AudioReader

struct · iOS 16.0+ · SDK 27.1

struct AudioReader

An audio file reader.

Members (7)

init · iOS 16.0+

init

TypeScript

static init(configuration?: AudioReader_Configuration): AudioReader

Swift declaration

init(configuration: AudioReader.Configuration = .init())

Creates an audio reader. - Parameter configuration: The audio reader configuration.

get · iOS 16.0+

configuration

TypeScript

get configuration(): AudioReader_Configuration

Swift declaration

var configuration: AudioReader.Configuration

The audio reader configuration

set · iOS 16.0+

configuration

TypeScript

set configuration(value: AudioReader_Configuration)

Swift declaration

var configuration: AudioReader.Configuration

The audio reader configuration

static · iOS 16.0+

readMicrophone

TypeScript

static readMicrophone(configuration?: AudioReader_Configuration): Promise<AudioReader_MicrophoneAsyncBuffers>

Swift declaration

static func readMicrophone(configuration: AudioReader.Configuration = .init()) async throws -> AudioReader.MicrophoneAsyncBuffers

Reads an async sequence of audio frames captured with a microphone. - Parameter configuration: The configuration for reading buffers. - Returns: An async sequence of `AVAudioPCMBuffer`.

static · iOS 16.0+

read

TypeScript

static readContentsOfConfiguration(url: string, configuration?: AudioReader_Configuration): AudioReader_AsyncBuffers

Swift declaration

static func read(contentsOf url: URL, configuration: AudioReader.Configuration = .init()) throws -> AudioReader.AsyncBuffers

Reads an audio file as an async sequence of audio buffers. - Parameter url: An audio file URL. - Parameter configuration: The configuration for reading buffers. - Returns: An async sequence of `AVAudioPCMBuffer`.

static · iOS 16.0+

read

TypeScript

static readConfiguration(files: Array<string>, configuration?: AudioReader_Configuration): Array<AudioReader_AsyncBuffers>

Swift declaration

static func read<S>(_ files: S, configuration: AudioReader.Configuration = .init()) throws -> [AudioReader.AsyncBuffers] where S : Sequence, S.Element == URL

Reads a sequence of files as an array of async sequences of audio buffers. - Parameter files: A sequence of URLs. - Parameter configuration: The configuration for reading buffers. - Returns: An array of async sequences of audio buffers.

method · iOS 16.0+

applied

TypeScript

applied(url: string, eventHandler?: (((arg0: Event) => void)) | null): AudioReader_AsyncBuffers

Swift declaration

func applied(to url: URL, eventHandler: EventHandler? = nil) throws -> AudioReader.AsyncBuffers

Reads an audio file as an async sequence of audio buffers. - Parameters: - url: An audio file URL. - eventHandler: An event handler. - Returns: An async sequence of `AVAudioPCMBuffer`.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

AudioReader.read(_:configuration:)

This declaration needs Swift generic type arguments. (no canonical witness for Annotation)

All CreateMLComponents types →