Edit

Share via

SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 structure (sidebandaudio.h)

  • Article

The second version of the SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR struct. This version allows the controller driver to provide custom device properties to add to the audio device's interface.

It describes the characteristics of a Sideband audio Endpoint. Audio driver should query this information to build the KS filter representing this endpoint.

Syntax

typedef struct _SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 {
  ULONG                               CbSize;
  GUID                                ContainerId;
  GUID                                Category;
  KSPIN_DATAFLOW                      Direction;
  SIDEBANDAUDIO_ENDPOINT_CAPABILITIES Capabilities;
  UNICODE_STRING                      FriendlyName;
  ULONG                               VolumePropertyValuesSize;
  ULONG                               SidetoneVolumePropertyValueSize;
  ULONG                               MutePropertyValuesSize;
  ULONG                               FilterInterfacePropertyCount;
  DEVPROPERTY                         *FilterInterfaceProperties;
} SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2, *PSIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2;

Members

CbSize

Size of Descriptor including storage for UNICODE_STRING and any additional data.

ContainerId

Pnp Container ID for connected device. See Audio Endpoint Container ID.

Category

KSPIN_DESCRIPTOR.Category to indicate form factor. Specifies a pointer to a KS pin category GUID. The KS pin category GUID identifies the general category of functionality that the pin provides. Examples of KS pin category GUIDs are KSNODETYPE_SPEAKER, KSNODETYPE_HEADPHONES, and KSNODETYPE_MICROPHONE, which are all defined in Ksmedia.h. See Pin Category Property.

Direction

Specifies either KSPIN_DATAFLOW_IN or KSPIN_DATAFLOW_OUT. See KSPIN_DATAFLOW.

Capabilities

Capabilities of the endpoint like (mute, volume, sidetone, etc.). See SIDEBANDAUDIO_ENDPOINT_CAPABILITIES.

FriendlyName

Storage for friendly name is attached after descriptor and is included in cbSize. See Friendly Names for Audio Endpoint Devices.

VolumePropertyValuesSize

If remote volume control is supported, this member contains the size of the data returned by the IOCTL_SBAUD_GET_VOLUMEPROPERTYVALUES request.

SidetoneVolumePropertyValueSize

If remote volume control is supported, this member contains the size of the data returned by the IOCTL_SBAUD_GET_SIDETONE_VOLUMEPROPERTYVALUES request.

MutePropertyValuesSize

If remote mute is supported, the member contains the size of data returned by IOCTL_SBAUD_GET_MUTEPROPERTYVALUES.

FilterInterfacePropertyCount

The number of device properties that shall be added to the audio filter factory interface.

FilterInterfaceProperties

A DEVPROPERTY structure that defines custom device properties that are added to the audio device's interface.

Requirements

Requirement Value
Header sidebandaudio.h

See also

sidebandaudio.h

SIDEBANDAUDIO_ENDPOINT_CAPABILITIES

IOCTL_SBAUD_GET_VOLUMEPROPERTYVALUES

IOCTL_SBAUD_GET_SIDETONE_VOLUMEPROPERTYVALUES