EVT_AUDIO_SENSORS_BUFFER - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// audiosensors.h

EVT_AUDIO_SENSORS_BUFFER EvtAudioSensorsBuffer;

NTSTATUS EvtAudioSensorsBuffer(
  PVOID Context,
  AUDIO_MODULE_ID ModuleId,
  ULONG SensorsSessionId,
  PULONG BufferSize,
  PVOID Buffer
)
{...}
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (nc-audiosensors-evt_audio_sensors_buffer)

Description

The EVT_AUDIO_SENSORS_BUFFER callback function is used for buffer operations between audio drivers and audio sensors drivers. This callback has multiple uses including getting buffers, setting buffers, and submitting read reports.

Parameters

Context

A pointer to the audio sensors driver-supplied context.

ModuleId

An AUDIO_MODULE_ID structure that identifies the target audio module.

SensorsSessionId

The session identifier returned by the EVT_AUDIO_SENSORS_START_SESSION callback. A value of 0 indicates a request that is not associated with any specific audio sensors session.

BufferSize

A pointer to a ULONG that contains the size of the buffer in bytes. On input, this specifies the size of the buffer provided. On output, this may be updated to indicate the actual buffer size used or required.

Buffer

An optional pointer to a proprietary buffer used for data exchange. The buffer size is specified by the BufferSize parameter.

Return value

Returns an NTSTATUS value. Return STATUS_SUCCESS if the operation succeeds. Otherwise, return an appropriate NTSTATUS error code.

Remarks

The EVT_AUDIO_SENSORS_BUFFER callback function type is used for three different buffer operations in the audio sensors interface:

The specific operation depends on which function pointer in the AUDIO_SENSORS_INTERFACE_V0100 structure is being used.

The SensorsSessionId parameter links operations to a specific sensor session created by EVT_AUDIO_SENSORS_START_SESSION. When the value is 0, the operation is not associated with any specific session.

See also