ORKAudioGenerator Class Reference

Inherits from NSObject
Declared in ORKAudioGenerator.h
ORKAudioGenerator.m

Overview

The ORKAudioGenerator class represents an audio tone generator.

– volumeInDecibels

Returns the peak audio volume being currently played, in decibels (dB).

- (double)volumeInDecibels

Return Value

The current audio volume in decibels.

Declared In

ORKAudioGenerator.h

– volumeAmplitude

Returns the peak audio volume amplitude being currently played (from 0 to 1).

- (double)volumeAmplitude

Return Value

The current audio volume amplitude.

Declared In

ORKAudioGenerator.h

– playSoundAtFrequency:

Plays a tone at a specific frequency in stereo.

- (void)playSoundAtFrequency:(double)frequency

Parameters

frequency

The audio frequency in hertz.

Discussion

The sound is a “pure” sinusoid tone.

Declared In

ORKAudioGenerator.h

– playSoundAtFrequency:onChannel:fadeInDuration:

Plays a tone at a specific frequency on a specific channel, with a fade-in effect.

- (void)playSoundAtFrequency:(double)frequency onChannel:(ORKAudioChannel)channel fadeInDuration:(NSTimeInterval)duration

Parameters

frequency

The audio frequency in hertz.

channel

The audio channel (left or right).

duration

The fade-in duration.

Discussion

The sound is a “pure” sinusoid tone. The fade-in effect is applied linearly for the peak amplitude, from a 0 to 1 factor.

Declared In

ORKAudioGenerator.h

– stop

Stops the audio being played.

- (void)stop

Declared In

ORKAudioGenerator.h