ORKStreamingAudioRecorderConfiguration Class Reference
Inherits from | ORKRecorderConfiguration : NSObject |
---|---|
Declared in | ORKRecorder.h ORKStreamingAudioRecorder.m |
Overview
The ORKStreamingAudioRecorderConfiguration
class represents a configuration that records streaming
audio data during an active step.
An ORKStreamingAudioRecorderConfiguration
generates an ORKStreamingAudioRecorder
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.
– initWithIdentifier:
Returns an initialized audio recorder configuration.
- (instancetype)initWithIdentifier:(NSString *)identifier
Parameters
identifier |
The unique identifier of the recorder configuration. |
---|
Return Value
An initialized audio recorder configuration.
Discussion
This method is the designated initializer.
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 |
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