IOCTL_SBAUD_STREAM_OPEN IOCTL (sidebandaudio.h)

Article
02/22/2024

On first transition above KSSTATE_STOP (normally to KSSTATE_ACQUIRE), send IOCTL_SBAUD_STREAM_OPEN. This control code is used by an audio driver when cooperating with the audio class drivers to operate a sideband connection.

Major code

IRP_MJ_DEVICE_CONTROL

Input buffer

A SIDEBANDAUDIO_STREAM_OPEN_PARAMS structure. It contains a 0 based index value based on the number of Audio endpoints as reported by the IOCTL_SBAUD_GET_DEVICE_DESCRIPTOR. This is a ULONG value from 0 to (N-1) where N is the number of Endpoints for the device.

Input buffer length

Size of ULONG. This is the size of the SIDEBANDAUDIO_STREAM_OPEN_PARAMS

Status block

Irp->IoStatus.Status is set to STATUS_SUCCESS if the request is successful. Otherwise, Status to the appropriate error condition as a NTSTATUS code. For more information, see NTSTATUS Values.

Remarks

This IOCTL can only be called from kernel mode.

This is one of the IOCTLs used for KS pin state transitions. The audio driver sends these requests on certain KS pin state transitions.

On first transition above KSSTATE_STOP (normally to KSSTATE_ACQUIRE), send IOCTL_SBAUD_STREAM_OPEN.
On transition up to KSSTATE_RUN, send IOCTL_SBAUD_STREAM_START.
On transition below KSSTATE_RUN, send IOCTL_SBAUD_STREAM_SUSPEND.
On closure of KS pin, send IOCTL_SBAUD_STREAM_CLOSE.

Requirements

Requirement	Value
Header	sidebandaudio.h