Copyright © 2008-2018 MultiMedia Soft

WASAPI.RenderDeviceStartShared method

Previous pageReturn to chapter overviewNext page

Remarks

 

Starts a WASAPI device in shared mode. In order to start the device in exclusive mode you can use the WASAPI.RenderDeviceStartExcusive method. You can know if a WASAPI device is already started through the WASAPI .DeviceIsStarted method.

 

This method is only effective if the InitDriversType method has been invoked with the nDriverType parameter set to DRIVER_TYPE_WASAPI and must be always called at a later stage respect to the call to the InitEditor method.

 

This method will affect any other instance of the control inside the application. If the control should be used in conjunction with the Active DJ Studio and/or Active Sound Recorder controls, these ones would be affected too. If you should be using Active DJ Studio in conjunction with this control, you should prefer calling this method from Active DJ Studio so you would have a better control over the channel mode used for playback.

 

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

For further details about the use of WASAPI see the WASAPI object and the How to manage audio playback through WASAPI tutorial.

 

 

Syntax

 

[Visual Basic]

control.WASAPI.RenderDeviceStartShared (

nDeviceIndex as Integer,

nReserved as Long,

nBufferLengthMs as Long,

nBufferUpdateTimeMs as Long

) as enumErrorCodes


 

[C++]

short control.WASAPI.RenderDeviceStartShared (

short nDeviceIndex,

long nReserved,

long nBufferLengthMs,

long nBufferUpdateTimeMs

);


 

Parameter

Description

 

 

nDeviceIndex

Number representing the zero-based index of the WASAPI device whose friendly name must be retrieved. The total number of available WASAPI devices can be obtained using the WASAPI.RenderDeviceGetCount method.

nReserved

Reserved for future uses, is ignored by the control.

nBufferLengthMs

Length of the buffer expressed in milliseconds.

This value determines the latency and if it should be too small the sound card driver may eventually adjust it to its minimum supported value. You can know if the given length has been accepted by verifying the value of the nLatencyMs parameter after calling the WASAPI.RenderDeviceLatencyGet method.

nBufferUpdateTimeMs

Update time, expressed in milliseconds, for filling the buffer.

You can set this value to 0 in order to let the sound card driver use its default.

 

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred, check the LastError property value in order to get the error code

enumErrorCodes.ERR_NOERROR (0)

The method call was successful