Copyright © 2006-2018 MultiMedia Soft

CoreAudioDevices.TypeGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the type of a specific audio endpoint device.

 

This method is only intended for usage with Windows Vista and later versions: further information about management of audio devices in Windows Vista and later versions can be found inside the How to access settings of audio devices in Windows Vista and later versions tutorial.

For further details about methods related to the management of core audio devices refer to the CoreAudioDevicesMan class.

 

 

Syntax

 

[Visual Basic]

Public Function TypeGet (

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Int16,

ByRef nDeviceType as enumCoreAudioDeviceTypes

) as enumErrorCodes


 

[C#]

public enumErrorCodes TypeGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

ref enumCoreAudioDeviceTypes nDeviceType

);


 

[C++]

public: enumErrorCodes TypeGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

enumCoreAudioDeviceTypes __gc *nDeviceType

);


 

Parameter

Description

 

 

nDataFlow

Direction in which audio data flows between an audio endpoint device and an application.

Supported values are the following:

Mnemonic Value

Value

Meaning

DEVICE_DATA_FLOW_RENDER

0

Audio rendering stream. Audio data flows from the application to the audio endpoint device, which renders the stream

DEVICE_DATA_FLOW_CAPTURE

1

Audio capture stream. Audio data flows from the audio endpoint device that captures the stream, to the application.

nDeviceIndex

Zero-based index of the audio endpoint device. The total number of audio endpoint devices can be obtained through the CoreAudioDevices.CountGet method.

nDeviceType

Reference that, on return from the method call, will contain the type of the given device.

Supported values are the following:

Mnemonic Value

Value

Meaning

DEVICE_TYPE_NETWORK_DEVICE

0

An audio endpoint device that the user accesses remotely through a network.

DEVICE_TYPE_SPEAKERS

1

A set of speakers.

DEVICE_TYPE_LINE_LEVEL

2

An audio endpoint device that sends a line-level analog signal to a line-input jack on an audio adapter or that receives a line-level analog signal from a line-output jack on the adapter.

DEVICE_TYPE_HEADPHONES

3

A set of headphones.

DEVICE_TYPE_MICROPHONE

4

A microphone.

DEVICE_TYPE_HEADSET

5

An earphone or a pair of earphones with an attached mouthpiece for two-way communication.

DEVICE_TYPE_HANDSET

6

The part of a telephone that is held in the hand and that contains a speaker and a microphone for two-way communication.

DEVICE_TYPE_DIGITAL_PASSTHROUGH

7

An audio endpoint device that connects to an audio adapter through a connector for a digital interface of unknown type that transmits non-PCM data in digital pass-through mode.

DEVICE_TYPE_SPDIF

8

An audio endpoint device that connects to an audio adapter through a Sony/Philips Digital Interface (S/PDIF) connector.

DEVICE_TYPE_HDMI

9

An audio endpoint device that connects to an audio adapter through a High-Definition Multimedia Interface (HDMI) connector or a display port.

DEVICE_TYPE_UNKNOWN

10

An audio endpoint device with unknown physical attributes.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.