ORKSpeechInNoiseStep Class Reference

Inherits from ORKActiveStep : ORKStep : NSObject
Declared in ORKSpeechInNoiseStep.h
ORKSpeechInNoiseStep.m

Overview

This active step programatically mixes the speech file with noise file and applies the filter.

Other Methods

+ stepViewControllerClass

+ (Class)stepViewControllerClass

Declared In

ORKStep.h

– initWithIdentifier:

- (instancetype)initWithIdentifier:(NSString *)identifier

Declared In

ORKStep.h

– validateParameters

Checks the parameters of the step and throws exceptions on invalid parameters.

- (void)validateParameters

Discussion

This method is called when there is a need to validate the step’s parameters, which is typically the case when adding a step to an ORKStepViewController object, and when presenting the step view controller.

Subclasses should override this method to provide validation of their additional properties, and must call super.

Declared In

ORKStep.h

– shouldContinueOnFinish

A Boolean value indicating whether to transition automatically when the step finishes.

- (BOOL)shouldContinueOnFinish

Discussion

When the value of this property is YES, the active step view controller automatically performs the continue action when the [ORKActiveStepViewController finish] method is called.

The default value of this property is NO.

Declared In

ORKActiveStep.h

– initWithCoder:

- (instancetype)initWithCoder:(NSCoder *)aDecoder

Declared In

ORKStep.h

Other Methods

  speechFileNameWithExtension

This property accepts the speech file.

@property (nonatomic, copy, nullable) NSString *speechFileNameWithExtension

Declared In

ORKSpeechInNoiseStep.h

  noiseFileNameWithExtension

This property accepts the noise file.

@property (nonatomic, copy, nullable) NSString *noiseFileNameWithExtension

Declared In

ORKSpeechInNoiseStep.h

  filterFileNameWithExtension

This property accepts the filter file.

@property (nonatomic, copy, nullable) NSString *filterFileNameWithExtension

Declared In

ORKSpeechInNoiseStep.h

  gainAppliedToNoise

The linear gain applied to the noise file before mixing it with the speech file.

@property (nonatomic, assign) double gainAppliedToNoise

Declared In

ORKSpeechInNoiseStep.h

  willAudioLoop

This boolean determines the repetitions of the file.

@property (nonatomic, assign) BOOL willAudioLoop

Declared In

ORKSpeechInNoiseStep.h