AudioRecorder


super: Object

A class that provides audio recording capability in your application.

Events

  • Load() This event is called when the object becames available in the current runtime system.

  • DidFinishRecording(succesfully: Bool) This event is called when a recording is stopped or has finished due to reaching its time limit.

  • OnError(error: String) This event is called when an audio recorder encounters an error during recording.

  • DeniedAuthorization() This event is called when user denied your app permission to record.

  • Unload() This event is called when the object has been removed from the current runtime system (but not yet deallocated).

Properties

  • var isRecording: Bool A Boolean value that indicates whether the audio recorder is recording. (read-only)

  • var deviceCurrentTime: Float The time, in seconds, of the host device where the audio recorder is located. (read-only)

  • var currentTime: Float The time, in seconds, since the beginning of the recording. (read-only)

  • var seconds: Float Total duration, in seconds, of the recorded audio file. (read-only)

  • var data: Data A Data value serialization representing the file recorder (recording must be stopped). (read-only)

  • var filePath: String Full path to the recorded file (if any). (read-only)

  • var inputChannels: Int The number of audio input channels for the current route. (read-only)

  • var maximumInputChannels: Int The maximum number of input channels available for the current audio route. (read-only)

  • var preferredInputChannels: Int The preferred number of input channels for the current route. (read-only)

  • var outputChannels: Int The number of audio output channels. (read-only)

  • var maximumOutputChannels: Int The maximum number of output channels available for the current audio route. (read-only)

  • var preferredOutputChannels: Int The preferred number of output channels for the current route. (read-only)

  • var inputGain: Float The gain applied to inputs associated with the session. (read-only)

  • var outputVolume: Float The system wide output volume set by the user. (read-only)

  • var inputLatency: Float The latency for audio input, measured in seconds. (read-only)

  • var outputLatency: Float The latency for audio output, measured in seconds. (read-only)

  • var currentSampleRate: Float The current audio sample rate, in hertz. (read-only)

  • var preferredSampleRate: Float The preferred sample rate, in hertz. (read-only)

Methods

  • func start(time: Float = 0, duration: Float = 0) Starts or resumes recording.

  • func stop() Stops recording and closes the audio file.

  • func pause() Pauses a recording.

  • func reset() Reset recording and cleanup temp files.

  • func copyToFile(filePath: String) Copy temporary audio file used during recording to a specified location.

  • func updateMeters() Refreshes the average and peak power values for all channels of an audio recorder.

  • func peakPower(channel: Int): Float Returns the peak power for a given channel, in decibels, for the sound being recorded. The current peak power, in decibels, for the sound being recorded. A return value of 0 dB indicates full scale, or maximum power; a return value of -160 dB indicates minimum power (that is, near silence). If the signal provided to the audio recorder exceeds ┬▒full scale, then the return value may exceed 0 (that is, it may enter the positive range).

  • func averagePower(channel: Int): Float Returns the average power for a given channel, in decibels, for the sound being recorded. The current average power, in decibels, for the sound being recorded. A return value of 0 dB indicates full scale, or maximum power; a return value of -160 dB indicates minimum power (that is, near silence). If the signal provided to the audio recorder exceeds ┬▒full scale, then the return value may exceed 0 (that is, it may enter the positive range).