SKMicrophoneConfiguration

Objective-C

@interface SKMicrophoneConfiguration : SKConfiguration <NSCopying>

Swift

class SKMicrophoneConfiguration : SKConfiguration, NSCopying

An instance of SKMicrophoneConfiguration can be used to configure the Microphone sensor.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Returns an SKMicrophoneConfiguration object, initialized with the path of the directory, as well as the filename that the recording will be stored.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOutputDirectory:(nonnull NSURL *)outputDirectory
                                   withFilename:(nonnull NSString *)filename;

    Swift

    init(outputDirectory: URL, withFilename filename: String)

    Parameters

    outputDirectory

    Path of the directory that the recording will be stored.
    filename

    A string with the desired filename of the recording, without the extension. Extension will be provided automatically based on the recordingFormat.

    Return Value

    A new SKMicrophoneConfiguration object.

  • Path of the directory that the recording will be stored.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSURL *_Nonnull outputDirectory;

    Swift

    var outputDirectory: URL { get set }

  • A string with the desired filename of the recording, without the extension. Extension will be provided automatically based on the recordingFormat.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull filename;

    Swift

    var filename: String { get set }

  • A read-only property that returns the full path of the recording filename.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSURL *_Nonnull recordingPath;

    Swift

    var recordingPath: URL { get }

  • Recording format of the Microphone sensor.

    Declaration

    Objective-C

    @property (nonatomic) SKMicrophoneRecordingFormat recordingFormat;

    Swift

    var recordingFormat: SKMicrophoneRecordingFormat { get set }

  • Recording quality of the Microphone sensor.

    Declaration

    Objective-C

    @property (nonatomic) SKMicrophoneRecordingQuality recordingQuality;

    Swift

    var recordingQuality: SKMicrophoneRecordingQuality { get set }

  • The audio format sampling rate in hertz.

    Declaration

    Objective-C

    @property (nonatomic) float sampleRate;

    Swift

    var sampleRate: Float { get set }