KSPROPERTY_SYSAUDIO_DEVICE_INSTANCE

The KSPROPERTY_SYSAUDIO_DEVICE_INSTANCE property specifies the current instance of a virtual audio device.

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

Yes

Filter

KSPROPERTY

ULONG

 

The property value (operation data) is of type ULONG and specifies the device ID of a virtual audio device. If SysAudio enumerates n virtual audio devices (see KSPROPERTY_SYSAUDIO_DEVICE_COUNT), then valid device IDs range from 0 to n-1.

Return Value

A KSPROPERTY_SYSAUDIO_DEVICE_INSTANCE property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.

Remarks

A KSPROPERTY_SYSAUDIO_DEVICE_INSTANCE set-property request opens the virtual audio device specified by the device ID contained in the property value. The last device to be opened is referred to as the current device.

Some SysAudio properties allow the current device to be identified by a null device ID of -1 rather than by a valid device ID in the range 0 to n-1, where n is the number of available virtual audio devices. These properties include KSPROPERTY_SYSAUDIO_DEVICE_INTERFACE_NAME and KSPROPERTY_SYSAUDIO_DEVICE_FRIENDLY_NAME.

A get-property request retrieves the device ID of the current (last opened) virtual audio device.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSPROPERTY
KSPROPERTY_SYSAUDIO_DEVICE_COUNT
KSPROPERTY_SYSAUDIO_DEVICE_INTERFACE_NAME
KSPROPERTY_SYSAUDIO_DEVICE_FRIENDLY_NAME

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft