ORKAudioRecorderConfiguration Class Reference

Inherits from ORKRecorderConfiguration : NSObject
Declared in ORKAudioRecorder.m
ORKRecorder.h

Overview

The ORKAudioRecorderConfiguration class represents a configuration that records audio data during an active step.

An ORKAudioRecorderConfiguration generates an ORKAudioRecorder object.

To use a recorder, include its configuration in the recorderConfigurations property of an ORKActiveStep object, include that step in a task, and present it with a task view controller.

Other Methods

– initWithIdentifier:

Returns an initialized recorder configuration.

- (instancetype)initWithIdentifier:(NSString *)identifier

Parameters

identifier

The unique identifier of the recorder configuration.

Return Value

An initialized recorder configuration.

Discussion

This method is the designated initializer.

Declared In

ORKRecorder_Private.h

– initWithIdentifier:recorderSettings:

Returns an initialized audio recorder configuration using the specified settings.

- (instancetype)initWithIdentifier:(NSString *)identifier recorderSettings:(NSDictionary *)recorderSettings

Parameters

identifier

The unique identifier of the recorder configuration.

recorderSettings

The settings for the recording session.

Return Value

An initialized audio recorder configuration.

Discussion

This method is the designated initializer.

For information on the settings available for an audio recorder, see “AV Foundation Audio Settings Constants”.

Declared In

ORKRecorder.h

– recorderForStep:outputDirectory:

Returns a recorder instance using this configuration.

- (ORKRecorder *)recorderForStep:(ORKStep *)step outputDirectory:(NSURL *)outputDirectory

Parameters

step

The step for which this recorder is being created.

outputDirectory

The directory in which all output file data should be written (if producing ORKFileResult instances).

Return Value

A configured recorder instance.

Declared In

ORKRecorder.h

– initWithCoder:

Returns a new audio recorder configuration initialized from data in the given unarchiver.

- (instancetype)initWithCoder:(NSCoder *)aDecoder

Parameters

aDecoder

Coder from which to initialize the audio recorder configuration.

Return Value

A new audio recorder configuration.

Declared In

ORKRecorder.h

– requestedPermissionMask

Returns the permission mask indicating the permissions required for this configuration.

- (ORKPermissionMask)requestedPermissionMask

Discussion

This method is typically overridden in new recorder configuration subclasses.

Declared In

ORKRecorder_Private.h

Other Methods

  recorderSettings

The audio format settings for the recorder.

@property (nonatomic, readonly, nullable) NSDictionary *recorderSettings

Discussion

Pass the settings for the recording session to the AVAudioRecorder method initWithURL:settings:error:. For information on the settings available for an audio recorder, see “AV Foundation Audio Settings Constants” in the AVFoundation documentation.

The results are returned as an ORKFileResult object, which points to an audio file.

Declared In

ORKRecorder.h