ORKToneAudiometrySample Class Reference

Inherits from NSObject
Conforms to NSCopying
NSSecureCoding
Declared in ORKResult.h

The ORKToneAudiometrySample class represents an audio amplitude associated with a frequency and a channel.

The sample object records the amplitude, the frequency, and the channel for the audio tone being played. A tone audiometry sample is included in an ORKToneAudiometryResult object, and is recorded by the step view controller for the corresponding task when a tap is recognized for a given tone.

A tone audiometry sample is typically generated by the framework as the task proceeds. When the task completes, it may be appropriate to serialize the sample for transmission to a server or to immediately perform analysis on it.

  frequency

The frequency value in hertz for the tone associated with the sample.

@property (nonatomic, assign) double frequency

Declared In

ORKResult.h

  channel

The channel, either left or right, for the tone associated with the sample.

@property (nonatomic, assign) ORKAudioChannel channel

Declared In

ORKResult.h

  amplitude

The audio signal amplitude.

@property (nonatomic, assign) double amplitude

Discussion

The minimum audio sample amplitude needed for the participant to recognize the sound (a double value between 0 and 1).

Declared In

ORKResult.h