Main Content

audiodevinfo

Information about audio device

collapse all in page

Syntax

info = audiodevinfo
nDevices = audiodevinfo(IO)
name = audiodevinfo(IO,ID)
DriverVersion = audiodevinfo(IO,ID,'DriverVersion')
support = audiodevinfo(IO,ID,Fs,nBits,nChannels)
ID = audiodevinfo(IO,name)
ID = audiodevinfo(IO,Fs,nBits,nChannels)

Description

example

info = audiodevinfo returns information about the input and output audio devices on the system.

example

nDevices = audiodevinfo(IO) returns the number of input devices on the system if IO is 1, and returns the number of output devices on the system if IO is 0.

name = audiodevinfo(IO,ID) returns the name of the audio device specified by the device identifier, ID.

DriverVersion = audiodevinfo(IO,ID,'DriverVersion') returns the name of the driver for the audio device specified by ID.

example

support = audiodevinfo(IO,ID,Fs,nBits,nChannels) returns 1 if the input or output audio device specified by ID supports the sample rate, number of bits, and number of channels specified by the values of Fs, nBits, and nChannels, respectively. Otherwise, support is 0.

ID = audiodevinfo(IO,name) returns the device identifier of the input or output audio device identified by the device name, name. If no device is found with the specified name, then audiodevinfo returns an error.

ID = audiodevinfo(IO,Fs,nBits,nChannels) returns the device identifier of the first input or output device that supports the sample rate, number of bits, and the number of channels specified by the values of Fs, nBits, and nChannels, respectively. If no supporting device is found, then ID is -1.

Examples

collapse all

Open Script

Call audiodevinfo with no inputs to view information about the input and output audio devices on a system. audiodevinfo returns a structure containing two fields, input and output.

info = audiodevinfo

info = 

  struct with fields:

     input: [1×2 struct]
    output: [1×4 struct]

The input field contains audio device names, driver used, and device identifiers.

info.input

ans = 

  1×2 struct array with fields:

    Name
    DriverVersion
    ID

Display the information on the first input device.

info.input(1)

ans = 

  struct with fields:

             Name: 'Primary Sound Capture Driver  Windows DirectSound '
    DriverVersion: 'Windows DirectSound'
               ID: 0

Display the information on the second input device.

info.input(2)

ans = 

  struct with fields:

             Name: 'HP 4120 Microphone  HP 4120   Windows DirectSound '
    DriverVersion: 'Windows DirectSound'
               ID: 1

The values on your system might differ from this example.

Open Script

View the number of output audio devices on the system, using an IO value of 0 to indicate output.

nDevices = audiodevinfo(0)

nDevices =

     4

This example shows three output devices, but your system might vary.

Open Script

Check if the input audio device identified by the ID value, 0, supports a sample rate of 44100 hertz, with 16 bits per sample, and two channels.

support = audiodevinfo(1,0,44100,16,2)

support =

  logical

   1

The input device supports the specified sample rate, number of bits and number of channels. Note that results on your system might vary.

Input Arguments

collapse all

Input or output device, specified as 1 to indicate input, or 0 to indicate output.

Audio device identifier, specified as an integer. The device can be an input or output audio device.

Sample rate, in hertz, specified as a positive scalar.

Example: 44100

Data Types: single | double

Number of bits per sample, specified as a scalar.

Example: 16

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

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

Name of the input or output audio device, specified as a character vector.

Data Types: char

Output Arguments

collapse all

Information about audio devices, returned as a structure array containing two fields, input and output. Each field is an array of structures, with each structure containing information about one of the audio input or output devices on the system. The individual device structure fields are:

  • Name — Name of the device, returned as a character vector.

  • DriverVersion — Name of the driver used to communicate with the device, returned as a character vector.

  • ID — Device identifier, returned as a scalar.

Limitations

  • These limitations apply when using audiodevinfo in MATLAB® Online™ or MATLAB Web App Server™:

    • audiodevinfo only returns information about output audio devices.

    • The value of nBits is ignored. For instance, when you call support = audiodevinfo(IO,ID,Fs,nBits,nChannels), audiodevinfo returns a logical 1 if the values of Fs and nChannels that you specified match the default sample rate and number of channels of the output audio device. It does not match nBits against the default number of bits per sample of the output device.

      Similarly, when you call ID = audiodevinfo(IO,Fs,nBits,nChannels), audiodevinfo returns information about an output audio device if the default sample rate and number of channels of the output device match the values of Fs and nChannels that you specified. It does not match nBits against the number of bits per sample that you specified.

    • 'DriverVersion' is not supported.

More About

collapse all

Security Considerations When Using MATLAB Online or MATLAB Web App Server

When using audiodevinfo in MATLAB Online or MATLAB Web App Server, certain features and settings help you keep control of your privacy.

To reduce the likelihood of unwanted applications using your microphone, turn off automatic access to your audio device. You can change these settings at any time. After granting permission to a website once, your browser may be able to access your microphone automatically for that site on future visits. Use the browser settings for Google Chrome to revoke access for specific sites after you have initially allowed access.

You can also access the MATLAB Online website or MATLAB Web App Server using the private browsing mode in Google Chrome. When you do this, Chrome™ automatically asks you for permission to access your microphone every time you open the MATLAB Online site or the MATLAB Web App Server and run audiodevinfo, regardless of your browser settings.

Tips

  • Audio playback in MATLAB Online and MATLAB Web App Server are supported in Google Chrome™.

Version History

Introduced before R2006a

See Also

|