Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The sidebandaudio.h header describes DDI's for enabling sideband audio for specific bus types (USB Audio 1.0, A2DP, etc.).
sidebandaudio.h contains the following programming interfaces:
IOCTLs
| IOCTL_SBAUD_GET_CONNECTION_STATUS_UPDATE The IOCTL_SBAUD_GET_CONNECTION_STATUS_UPDATE IOCTL control code code gets a connection status update. |
| IOCTL_SBAUD_GET_DEVICE_DESCRIPTOR The audio driver issues the IOCTL_SBAUD_GET_DEVICE_DESCRIPTOR to get information about an enabled sideband audio device interface. |
| IOCTL_SBAUD_GET_ENDPOINT_DESCRIPTOR The audio driver issues the IOCTL_SBAUD_GET_ENDPOINT_DESCRIPTOR control code to get information about an Audio endpoint exposed through sideband audio device interface. |
| IOCTL_SBAUD_GET_ENDPOINT_DESCRIPTOR2 The audio driver issues the IOCTL_SBAUD_GET_ENDPOINT_DESCRIPTOR2 control code to get information about an Audio endpoint exposed through sideband audio device interface. |
| IOCTL_SBAUD_GET_ERROR_STATUS_UPDATE The IOCTL_SBAUD_GET_ERROR_STATUS_UPDATE IOCTL is used for error status updates. |
| IOCTL_SBAUD_GET_MUTE_STATUS_UPDATE The IOCTL_SBAUD_GET_MUTE_STATUS_UPDATE IOCTL gets the mute level setting of the sideband audio endpoint. |
| IOCTL_SBAUD_GET_MUTEPROPERTYVALUES Audio driver can call the IOCTL_SBAUD_GET_MUTEPROPERTYVALUES IOCTL to query the mute stepped data ranges and min/max values for all of the channels. |
| IOCTL_SBAUD_GET_SIDETONE_STATUS_UPDATE The IOCTL_SBAUD_GET_SIDETONE_STATUS_UPDATE IOCTL gets the sidetone setting of the sideband audio endpoint. |
| IOCTL_SBAUD_GET_SIDETONE_VOLUMEPROPERTYVALUES The IOCTL_SBAUD_GET_SIDETONE_VOLUMEPROPERTYVALUES IOCTL gets the sidetone volume property values of the sideband specified audio endpoint |
| IOCTL_SBAUD_GET_SIOP The IOCTL_SBAUD_GET_SIOP IOCTL is used to get the SIOP. |
| IOCTL_SBAUD_GET_SIOP_UPDATE The IOCTL_SBAUD_GET_SIOP_UPDATE is used to get the updatable configured-codec-SIOP. |
| IOCTL_SBAUD_GET_STREAM_STATUS_UPDATE The IOCTL_SBAUD_GET_STREAM_STATUS_UPDATE IOCTL is used for stream status updates. |
| IOCTL_SBAUD_GET_SUPPORTED_FORMATS The audio driver issues the IOCTL_SBAUD_GET_SUPPORTED_FORMATS control code to get information about the stream formats supported by sideband audio endpoint. |
| IOCTL_SBAUD_GET_VOLUME_STATUS_UPDATE The IOCTL_SBAUD_GET_VOLUME_STATUS_UPDATE IOCTL gets the volume level setting of the sideband audio endpoint. |
| IOCTL_SBAUD_GET_VOLUMEPROPERTYVALUES Audio driver can call IOCTL_SBAUD_GET_VOLUMEPROPERTYVALUES to query the volume stepped data ranges and min/max values for all of the channels. |
| IOCTL_SBAUD_SET_DEVICE_CLAIMED The IOCTL_SBAUD_SET_DEVICE_CLAIMED IOCTL claims the device for sideband. |
| IOCTL_SBAUD_SET_MUTE The IOCTL_SBAUD_SET_MUTE IOCTL is used to set the render (speaker) mute. |
| IOCTL_SBAUD_SET_SIDETONE_PROPERTY The IOCTL_SBAUD_SET_SIDETONE_PROPERTY IOCTL is used to set the side tone property. |
| IOCTL_SBAUD_SET_SIOP The IOCTL_SBAUD_SET_SIOP IOCTL is used to set a SIOP command. |
| IOCTL_SBAUD_SET_VOLUME The IOCTL_SBAUD_SET_VOLUME IOCTL is used to set the volume on a specific channel. |
| IOCTL_SBAUD_STREAM_CLOSE On closure of KS pin, send IOCTL_SBAUD_STREAM_CLOSE. |
| IOCTL_SBAUD_STREAM_OPEN On first transition above KSSTATE_STOP (normally to KSSTATE_ACQUIRE), send IOCTL_SBAUD_STREAM_OPEN. |
| IOCTL_SBAUD_STREAM_START On transition up to KSSTATE_RUN, send IOCTL_SBAUD_STREAM_START. |
| IOCTL_SBAUD_STREAM_SUSPEND On transition below KSSTATE_RUN, send IOCTL_SBAUD_STREAM_SUSPEND. |
Functions
| SIDEBANDAUDIO_IOCTL A macro that is used for the SIDEBANDAUDIO_IOCTL. |
Structures
| SIDEBANDAUDIO_CONNECTION_PARAMS The SIDEBANDAUDIO_CONNECTION_PARAMS structure describes the endpoint index and connection value. |
| SIDEBANDAUDIO_DEVICE_DESCRIPTOR The SIDEBANDAUDIO_DEVICE_DESCRIPTOR structure describes the number of endpoints on the device. |
| SIDEBANDAUDIO_DEVICE_ERROR The SIDEBANDAUDIO_DEVICE_ERROR structure describes the error reported on the Device. |
| SIDEBANDAUDIO_ENDPOINT_CAPABILITIES The SIDEBANDAUDIO_ENDPOINT_CAPABILITIES structure describes the capabilities of the sideband audio endpoint driver. |
| SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR The SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR structure describes the characteristics of a Sideband audio Endpoint. |
| SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR2 The second version of the SIDEBANDAUDIO_ENDPOINT_DESCRIPTOR struct. It describes the characteristics of the audio Endpoint driver. |
| SIDEBANDAUDIO_IO_PARAM_HEADER The SIDEBANDAUDIO_IO_PARAM_HEADER structure describes the size and type of the IO parameter. |
| SIDEBANDAUDIO_MUTE_PARAMS The SIDEBANDAUDIO_MUTE_PARAMS structure describes the endpoint index, channel, immediate mode of operation and mute value. |
| SIDEBANDAUDIO_SIDETONE_DESCRIPTOR The SIDEBANDAUDIO_SIDETONE_DESCRIPTOR structure describes mute and volume components of the sidetone topology. |
| SIDEBANDAUDIO_SIDETONE_PARAMS The SIDEBANDAUDIO_SIDETONE_PARAMS structure describes the endpoint index and sidetone value. |
| SIDEBANDAUDIO_SIOP_REQUEST_PARAM The SIDEBANDAUDIO_SIOP_REQUEST_PARAM structure describes the variable SIOP request parameter. |
| SIDEBANDAUDIO_STREAM_OPEN_PARAMS The SIDEBANDAUDIO_STREAM_OPEN_PARAMS structure describes the variable I/O parameters for IOCTLs. |
| SIDEBANDAUDIO_STREAM_STATUS_PARAMS The SIDEBANDAUDIO_STREAM_STATUS_PARAMS structure describes the endpoint index and Device Error NTSTATUS. |
| SIDEBANDAUDIO_SUPPORTED_FORMATS The SIDEBANDAUDIO_SUPPORTED_FORMATS structure describes the formats supported by the Audio Endpoint. |
| SIDEBANDAUDIO_VOLUME_PARAMS The SIDEBANDAUDIO_VOLUME_PARAMS structure describes the endpoint index, channel, immediate mode of operation and volume value. |
Enumerations
| SIDEBANDAUDIO_PARAMS_MSFT_TYPE_ID Parameters defined for SIDEBANDAUDIO_PARAMS_SET_STANDARD - Microsoft Type IDs |