Files
2025-02-18 18:05:13 -05:00

77 lines
3.0 KiB
Objective-C

/*
Copyright (c) 2015, Apple Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
3. Neither the name of the copyright holder(s) nor the names of any contributors
may be used to endorse or promote products derived from this software without
specific prior written permission. No license is granted to the trademarks of
the copyright holders even if such marks are included in this software.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#import <UIKit/UIKit.h>
#import <AVFoundation/AVFoundation.h>
#import <ResearchKit/ORKRecorder.h>
NS_ASSUME_NONNULL_BEGIN
@protocol ORKStreamingAudioResultDelegate <ORKRecorderDelegate>
@optional
- (void)audioAvailable:(AVAudioPCMBuffer *)buffer;
@end
/**
The ORKStreamingAudioRecorder class represents a recorder that uses the app's
`AVAudioSession` object to record audio.
To audio recording will be discontinued if task enters the background.
*/
ORK_CLASS_AVAILABLE
@interface ORKStreamingAudioRecorder : ORKRecorder
/**
Returns an initialized audio recorder using the specified step, and output directory.
@param identifier The unique identifier of the recorder (assigned by the recorder configuration).
@param step The step that requested this recorder.
@param outputDirectory The directory in which the audio output should be stored.
@return An initialized audio recorder.
*/
- (instancetype)initWithIdentifier:(NSString *)identifier
step:(nullable ORKStep *)step
outputDirectory:(nullable NSURL *)outputDirectory NS_DESIGNATED_INITIALIZER;
/**
Reference to the audio recorder being used.
The value of this property is used in the audio task in order to display recorded volume and metering in real time during the task.
*/
@property (nonatomic, strong, readonly, nullable) AVAudioEngine *audioEngine;
@end
NS_ASSUME_NONNULL_END