audiorecorder

Object for recording audio

Description

Use an audiorecorder object to record audio data from an input device such as a microphone for processing in MATLAB^®. The audiorecorder object contains properties that enable additional flexibility during recording. For example, you can pause, resume, or define callbacks using the audiorecorder object functions.

Creation

Syntax

recorder = audiorecorder

recorder = audiorecorder(Fs,nBits,NumChannels)

recorder = audiorecorder(Fs,nBits,NumChannels,ID)

Description

recorder = audiorecorder creates and returns an audiorecorder object with these properties:

• Sampling frequency Fs = 8000 hertz

• Bits per sample nBits = 8

• Number of channels nChannels = 1

recorder = audiorecorder(Fs,nBits,NumChannels) sets the sample rate Fs (in hertz), the bits per sample nBits, and the number of channels nChannels.

recorder = audiorecorder(Fs,nBits,NumChannels,ID) sets the audio input device to the device specified by ID.

Input Arguments

Fs — Sampling frequency

numeric scalar

Sampling frequency in hertz (Hz), specified as a numeric scalar.

Valid values of the sampling rate depend on both the sample rates permitted by MATLAB and the specific audio hardware on your system. MATLAB has a hard restriction of 1000 Hz <= Fs <= 384000 Hz, although further hardware-dependent restrictions apply. Typical values supported by most sound cards are 8000, 11025, 22050, 44100, 48000, and 96000 hertz.

Data Types: single | double

nBits — Bits per sample

8 (default) | 16 | 24

Bits per sample, specified as 8, 16, or 24.

Specify nBits only when the signal Y contains floating-point values. Valid values of nBits depend on the audio hardware. For example, depending on your audio hardware, nBits can be one of these values: 8, 16, or 24.

NumChannels — Number of channels

1(mono) (default) | 2 (stereo)

Number of channels, specified as 1 (mono) or 2 (stereo).

ID — Device identifier

-1 (default) | integer

Device identifier, specified as an integer.

To obtain the ID of a device, use the audiodevinfo function.

Properties

BitsPerSample — Bits per sample

positive integer

This property is read-only.

Bits per sample, returned as a positive integer.

CurrentSample — Sample currently recording

positive integer

This property is read-only.

Sample currently recording on the audio input device, returned as a positive integer.

If the device is not recording, CurrentSample is the next sample to record using the record or resume methods.

DeviceID — Audio device identifier

integer

This property is read-only.

Audio device identifier, returned as an integer.

Running — Audio recorder status

off (default) | on

This property is read-only.

Audio recorder status, returned as on or off.

SampleRate — Sampling frequency

8000 (default) | numeric scalar

Sampling frequency in hertz (Hz), returned as a numeric scalar.

To set the SampleRate, use the Fs input argument when constructing the audiorecorder object.

TotalSamples — Total length of audio data

integer

This property is read-only.

Total length of the audio data in samples, returned as an integer.

Tag — Label

character vector

Label, specified as a character vector.

Type — Object class name

'audiorecorder'

This property is read-only.

Object class name, returned as 'audiorecorder'.

UserData — User-defined data

[] (default) | any data type

User-defined data, specified as a value of any data type. Use this property to store any additional data with the object.

StartFcn — Function to execute at start

character vector | string scalar | function handle

Function to execute at start of recording, specified as a character vector or string scalar containing the name of the function, or a function handle.

The first two inputs to your callback function must be the audiorecorder object and an event structure. For more information, see callback functions.

StopFcn — Function to execute at end

character vector | string scalar | function handle

Function to execute at end of recording, specified as a character vector or string scalar containing the name of the function, or a function handle.

The first two inputs to your callback function must be the audiorecorder object and an event structure. For more information, see callback functions.

TimerFcn — Function to execute repeatedly

character vector | string scalar | function handle

Function to execute repeatedly during recording, specified as a character vector or string scalar containing the name of the function, or a function handle. To specify time intervals for the repetitions, use the TimerPeriod property.

The first two inputs to your callback function must be the audiorecorder object and an event structure. For more information, see callback functions.

TimerPeriod — Timer period

0.05 (default) | numeric scalar

Timer period, specified as numeric scalar.

Timer period is the time in seconds between TimerFcn callbacks.

Object Functions

get	Query property values for audiorecorder object
getaudiodata	Store recorded audio signal in numeric array
getplayer	Creates associated audioplayer object
isrecording	Determine if recording is in progress
pause	Pause playback or recording
play	Play audio from audiorecorder object
record	Record audio to audiorecorder object
recordblocking	Record audio to audiorecorder object, hold control until recording completes
resume	Resume playback or recording from paused state
set	Set property values for audiorecorder object
stop	Stop playback or recording

Examples

Record Audio from Input Device

Record audio data from a microphone and then play the recorded audio.

Create an audiorecorder object with default property values.

recObj = audiorecorder;

Alternatively, create an audiorecorder object with the desired properties. For a CD-quality audio in stereo, define these properties: sampling frequency (Fs), number of bits per sample (nBits), the number of channels (nChannels), and input device identifier (ID).

Fs = 44100 ; 
nBits = 16 ; 
nChannels = 2 ; 
ID = -1; % default audio input device 
recObj = audiorecorder(Fs,nBits,nChannels,ID);

Collect a five second sample of your speech with your microphone.

disp('Start speaking.')

Start speaking.

recordblocking(recObj,5);
disp('End of Recording.');

End of Recording.

Play back the recording.

play(recObj);