KSPROPERTY_SYSAUDIO_DEVICE_FRIENDLY_NAME
The KSPROPERTY_SYSAUDIO_DEVICE_FRIENDLY_NAME property retrieves a Unicode string containing the friendly name of the virtual audio device.
Usage Summary Table
| Get | Set | Target | Property descriptor type | Property value type |
|---|---|---|---|---|
Yes |
No |
Filter |
KSPROPERTY+ULONG |
LPWSTR |
The property descriptor (instance data) consists of a KSPROPERTY structure followed by a ULONG variable containing a device ID that identifies 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. Also, a device ID value of -1 can be used to indicate the current device, which is the last virtual audio device opened by a KSPROPERTY_SYSAUDIO_DEVICE_INSTANCE or KSPROPERTY_SYSAUDIO_INSTANCE_INFOset-property request.
The property value (operation data) is a pointer to a null-terminated string of Unicode characters that contains the device's friendly name.
Return Value
A KSPROPERTY_SYSAUDIO_DEVICE_FRIENDLY_NAME property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.
Requirements
Header |
Ksmedia.h (include Ksmedia.h) |
See also
KSPROPERTY_SYSAUDIO_DEVICE_COUNT
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for