Copyright © 2006-2018 MultiMedia Soft

WASAPI.DeviceSharedFormatGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the audio format for shared mode currently selected inside the Windows control panel for the given WASAPI device.

 

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 DeviceSharedFormatGet (

nDeviceIndex as Int32,

nDeviceType as enumWasapiDeviceTypes,

ByRef nFrequency as Int32,

ByRef nChannels as Int16,

ByRef nBitDepth as enumWasapiBitDepths

) as enumErrorCodes


 

[C#]

public enumErrorCodes DeviceSharedFormatGet (

Int32 nDeviceIndex,

enumWasapiDeviceTypes DeviceMuteSet,

ref Int32 nFrequency,

ref Int16 nChannels

);


 

[C++]

public: enumErrorCodes DeviceSharedFormatGet (

Int32 nDeviceIndex,

enumWasapiDeviceTypes nDeviceType,

Int32 __gc *nFrequency,

Int16 __gc *nChannels

);


 

 

Parameter

Description

 

 

nDeviceIndex

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

nDeviceType

The type of device.

Supported values are the following:

Mnemonic Value

Value

Meaning

WASAPI_DEVICE_TYPE_RENDER

0

Audio rendering device.

WASAPI_DEVICE_TYPE_CAPTURE

1

Audio capture device.

WASAPI_DEVICE_TYPE_LOOPBACK

2

Audio loopback device.

nFrequency

Reference that, on return from the method call, will contain the sample rate

nChannels

Reference that, on return from the method call, will contain the number of channels

 

 

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.