Copyright © 2006-2019 MultiMedia Soft

WASAPI.MixerInputDeviceAttach method

Previous pageReturn to chapter overviewNext page

Remarks

 

Attaches a WASAPI input device to the internal WASAPI input mixer before starting a new recording session through the StartFromWasapiMixer method. The call to this method will fail if the recording session is already started.

 

An attached input device can be detached at any time through the WASAPI.MixerInputDeviceDetach method. You can verify if an input device is already attached through the WASAPI.MixerInputDeviceIsAttached method.

 

The device to attach must have been previously started through one between the WASAPI.DeviceStartShared and WASAPI.DeviceStartExcusive methods.

 

This method is only intended for usage with Windows Vista and later versions.

For further details about the use of WASAPI see the WASAPIMan class and the How to manage audio flow through WASAPI tutorial

 

 

Syntax

 

[Visual Basic]

Public Function MixerInputDeviceAttach (

nDeviceIndex as Int32,

nDeviceType as enumWasapiDeviceTypes

) as enumErrorCodes


 

[C#]

public enumErrorCodes MixerInputDeviceAttach (

Int32 nDeviceIndex,

enumWasapiDeviceTypes nDeviceType

);


 

[C++]

public: enumErrorCodes MixerInputDeviceAttach (

Int32 nDeviceIndex,

enumWasapiDeviceTypes nDeviceType

);


 

 

Parameter

Description

 

 

nDeviceIndex

Number representing the zero-based index of the WASAPI input device of interest. The total number of available WASAPI devices can be obtained using the WASAPI.DeviceGetCount method.

nDeviceType

The type of input device.

Supported values are the following:

Mnemonic Value

Value

Meaning

WASAPI_DEVICE_TYPE_CAPTURE

1

Audio capture device.

WASAPI_DEVICE_TYPE_LOOPBACK

2

Audio loopback device.

 

 

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.