Copyright © 2008-2018 MultiMedia Soft

WASAPI.RenderDeviceSharedFormatGet 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 WASAPI see the WASAPIMan class and the How to manage audio playback through WASAPI tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function RenderDeviceSharedFormatGet (

nDeviceIndex as Int32,

ByRef nFrequency as Int32,

ByRef nChannels as Int16,

ByRef nBitDepth as enumWasapiBitDepths

) as enumErrorCodes


 

[C#]

public enumErrorCodes RenderDeviceSharedFormatGet (

Int32 nDeviceIndex,

ref Int32 nFrequency,

ref Int16 nChannels

);


 

[C++]

public: enumErrorCodes RenderDeviceSharedFormatGet (

Int32 nDeviceIndex,

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.RenderDeviceGetCount method.

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.NOERROR (0)

The method call was successful.