addAudioInputChannel

(Not recommended) Add audio input channel to session

This session object function is not recommended. Use DataAcquisition object functions instead. See Version History.

Syntax

ch = addAudioInputChannel(s,deviceName,channelID)

[ch,idx] = addAudioInputChannel(s,deviceName,channelID)

Description

ch = addAudioInputChannel(s,deviceName,channelID) creates and displays the object ch representing a channel added to the session s using the device represented by deviceName, with the specified channelID. The channel object is stored in the variable ch.

Tips

• Use daq.createSession to create a session object before you use this method.

• To use analog channels, see addAnalogInputChannel.

[ch,idx] = addAudioInputChannel(s,deviceName,channelID) additionally assigns to idx the index into the array of the session object's Channels property.

Examples

Add an Audio Input Channel

s = daq.createSession('directsound');
addAudioInputChannel(s,'Audio1',1);

Add Multiple Audio Input Channels

Add two audio input channels and specify output arguments to represent the channel object and the index.

s = daq.createSession('directsound');
[ch,idx] = addAudioInputChannel(s,'Audio1',1:2);

Input Arguments

s — Data acquisition session

session object

Data acquisition session specified as a session object created using daq.createSession. Use the data acquisition session for acquisition and generation operations. Create one session per vendor and use that vendor session to perform all data acquisition operations.

deviceName — Device ID

character vector or string

Device ID specified as a character vector or string, as defined by the device vendor. Obtain the device ID by calling daq.getDevices. The channel specified for this device is created for the session object.

Data Types: char | string

channelID — Channel ID

numeric value

Channel ID, or the physical location of the channel on the device, added to the session, specified as numeric value. Supported values are specific to the vendor and device. You can also add a range of channels. The index for this channel displayed in the session indicates this channels position in the session. If you add a channel with channel ID 1 as the first channel in a session, the session index is 1.

Output Arguments

ch — Audio input channel

channel object

Audio input channel that you add, returned as a channel object containing vendor specific channel information. Use this channel object to access device and channel properties.

idx — Channel index

numeric

Channel index returned as a numeric value. Through the index you can access the array of the session object Channels property.

Version History

Introduced in R2014a

R2020a: session object interface is not recommended

Use of this function with a session object is not recommended. To access a data acquisition device, use a DataAcquisition object with its functions and properties instead.

For more information about using the recommended functionality, see Transition Your Code from Session to DataAcquisition Interface.