Copyright © 2001-2018 MultiMedia Soft

ASIO.DeviceGetChannelDesc method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves the friendly description of the requested ASIO channel. This method is useful when you have to fill a combo box with the friendly names of available ASIO channels.

The total number of available ASIO channels can be obtained using the ASIO.DeviceGetChannelsCount method.

 

For further details about the use of ASIO drivers see the ASIO object section and the How to manage ASIO drivers tutorial.

 

 

Syntax

 

[Visual Basic]

control.ASIO.DeviceGetChannelDesc (

nDeviceIndex as Integer,

nChannelIndex as Integer,

bInputChannel as enumBoolean

) as String


 

[C++]

LPCTSTR control.ASIO.DeviceGetChannelDesc (

short nDeviceIndex,

short nChannelIndex,

short bInputChannel

);


 

 

 

Parameter

Description

 

 

nDeviceIndex

Number representing the zero-based index of the ASIO device.

This index is related to available ASIO devices so it must be the related to the enumeration performed through the ASIO.DeviceGetCount and ASIO.DeviceGetDesc methods: it must not be confused with indexes related to generic output devices enumerated through the GetOutputDevicesCount and GetOutputDeviceDesc methods which may contain both DirectSound and ASIO devices.

nChannelIndex

Number representing the zero-based index of the ASIO channel of interest

bInputChannel

Boolean value that specifies if the we want to obtain the friendly description of an input or of an output channel.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Output channel

BOOL_TRUE

1

Input channel

 

 

Return value

 

Value

Meaning

 

 

Empty string

The value of the nDeviceIndex parameter or of the nChannelIndex parameter was out of range. Use the value returned by the ASIO.DeviceGetCount method in order to know how many ASIO devices are currently installed inside the system and the value returned by the ASIO.DeviceGetChannelsCount method in order to know how many ASIO channels are currently available inside the given ASIO device.

Valid string

The string containing the friendly description of the requested output device.