strmini.h header
This header is used by stream. For more information, see:
strmini.h contains the following programming interfaces:
Functions
| StreamClassAbortOutstandingRequests The StreamClassAbortOutstandingRequests routine aborts all outstanding requests, either to a particular stream, or to the entire driver. |
| StreamClassCallAtNewPriority The StreamClassCallAtNewPriority routine schedules a routine to be called at a different priority. |
| StreamClassCompleteRequestAndMarkQueueReady The StreamClassCompleteRequestAndMarkQueueReady routine completes a request, and signals the class driver that the minidriver is ready to receive a new request of the same type. |
| StreamClassDebugAssert This function (StreamClassDebugAssert) is obsolete. |
| StreamClassDebugPrint This function (StreamClassDebugPrint) is obsolete. |
| StreamClassDeviceNotification Minidrivers use the StreamClassDeviceNotification routine to notify the class driver that it has completed a stream request, or that an event has occurred. |
| StreamClassFilterReenumerateStreams Obsolete. Do not use. |
| StreamClassGetDmaBuffer The StreamClassGetDmaBuffer routine returns a pointer to the DMA buffer that the class driver allocates for the minidriver. |
| StreamClassGetNextEvent Minidrivers can use the StreamClassGetNextEvent routine to search the event queue of a device or of a particular stream. |
| StreamClassGetPhysicalAddress The StreamClassGetPhysicalAddress routine translates a virtual memory address to a physical memory address and locks the corresponding physical memory for a DMA operation. |
| StreamClassQueryMasterClock When the minidriver calls the StreamClassQueryMasterClock routine, the class driver queries the appropriate time value of the master clock asynchronously, and passes the result to the routine passed in the ClockCallbackRoutine parameter. |
| StreamClassQueryMasterClockSync The minidriver may call the StreamClassQueryMasterClockSync routine to synchronously query a stream's master clock. |
| StreamClassReadWriteConfig The StreamClassReadWriteConfig routine reads or writes configuration data for the minidriver's parent bus driver. |
| StreamClassReenumerateStreams The StreamClassReenumerateStreams function is obsolete. Do not use. |
| StreamClassRegisterAdapter The StreamClassRegisterAdapter routine registers a stream class minidriver.The name StreamClassRegisterAdapter is supported for backward compatibility only.Instead, Microsoft recommends the use of StreamClassRegisterMinidriver, an alias of StreamClassRegisterAdapter. The name StreamClassRegisterMinidriver more accurately indicates that the routine registers a stream class minidriver. Once registered, a minidriver can drive any number of adapter instances in a system.The StreamClassRegisterMinidriver routine registers a stream minidriver with the stream class driver. |
| StreamClassRegisterFilterWithNoKSPins The StreamClassRegisterFilterWithNoKSPins routine is used to register filter drivers with Microsoft DirectShow that have no kernel streaming pins and, therefore, do not stream in kernel mode. |
| StreamClassScheduleTimer The minidriver calls the StreamClassScheduleTimer routine to schedule a timer, and to specify a routine that is called when the timer expires. |
| StreamClassStreamNotification Streams use the StreamClassStreamNotification routine to notify the class driver that it has completed a stream request, or that an event has occurred. |
Callback functions
| PHW_CANCEL_SRB The class driver calls the minidriver's StrMiniCancelPacket routine to signal that a stream request has been canceled. |
| PHW_EVENT_ROUTINE The class driver calls the stream minidriver's StrMiniEvent routine to signal to a minidriver an event should be enabled or disabled. |
| PHW_INTERRUPT StrMiniInterrupt is the minidriver's interrupt service routine. |
| PHW_PRIORITY_ROUTINE StrMiniPriorityRoutine is a minidriver-supplied callback routine to be executed at a specified priority level. |
| PHW_QUERY_CLOCK_ROUTINE Each stream may have a clock associated to it. The class driver queries the clock by calling the stream minidriver-supplied StrMiniClock function, provided in each stream's HW_STREAM_OBJECT. |
| PHW_RECEIVE_DEVICE_SRB The minidriver-supplied routine handles class driver requests that apply to the driver as a whole, such as initializing the device, or opening a stream within the device. |
| PHW_REQUEST_TIMEOUT_HANDLER The stream class driver calls the minidriver's StrMiniRequestTimeout routine to signal to the minidriver that a request has timed out. |
Structures
| ACCESS_RANGE Learn how an ACCESS_RANGE structure (strmini.h) describes a memory or I/O port range used by an HBA.Note The SCSI port driver and SCSI miniport driver models may be altered or unavailable in the future. |
| HW_CLOCK_OBJECT The HW_CLOCK_OBJECT structure describes the clock associated with a stream. |
| HW_EVENT_DESCRIPTOR When the class driver calls one of the minidriver's StrMiniEvent routines, it passes a pointer to an HW_EVENT_DESCRIPTOR structure to describe the event as enabled or disabled. |
| HW_INITIALIZATION_DATA The HW_INITIALIZATION_DATA structure specifies the basic information the class driver needs to begin initializing the minidriver. |
| HW_STREAM_DESCRIPTOR The minidriver uses the HW_STREAM_DESCRIPTOR structure to return stream information to the stream class driver. |
| HW_STREAM_HEADER The HW_STREAM_HEADER structure describes the kernel streaming semantics supported by the minidriver as a whole, as part of a HW_STREAM_DESCRIPTOR structure. |
| HW_STREAM_INFORMATION The HW_STREAM_INFORMATION structure describes the kernel streaming semantics supported by individual streams, as part of an HW_STREAM_DESCRIPTOR structure. |
| HW_STREAM_OBJECT HW_STREAM_OBJECT describes an instance of a minidriver stream. |
| HW_STREAM_REQUEST_BLOCK The stream class driver uses the HW_STREAM_REQUEST_BLOCK structure to pass information to and from the minidriver, using minidriver provided callbacks. |
| HW_TIME_CONTEXT The class driver passes an HW_TIME_CONTEXT structure as a parameter to be filled in by a stream's StrMiniClock routine, or returns a completed HW_TIME_CONTEXT structure when it responds to a StreamClassQueryMasterClock or StreamClassQueryMasterClockSync request. |
| KSSCATTER_GATHER Learn more about: KSSCATTER_GATHER structure |
| PORT_CONFIGURATION_INFORMATION PORT_CONFIGURATION_INFORMATION describes the hardware settings of a streaming minidriver's device. The class driver fills in most members with information provided by the operating system. |
| STREAM_DATA_INTERSECT_INFO STREAM_DATA_INTERSECT_INFO describes the parameters of a data intersection operation. |
| STREAM_METHOD_DESCRIPTOR Learn more about: _STREAM_METHOD_DESCRIPTOR structure |
| STREAM_PROPERTY_DESCRIPTOR STREAM_PROPERTY_DESCRIPTOR specifies the parameters of property get/set requests that the class driver passes to the minidriver. |
| STREAM_TIME_REFERENCE Learn more about: _STREAM_TIME_REFERENCE structure |
Enumerations
| SRB_COMMAND Learn more about: _SRB_COMMAND enumeration |
| STREAM_BUFFER_TYPE This enumeration defines the buffer types for StreamClassGetPhysicalAddress. |
| STREAM_DEBUG_LEVEL The STREAM_DEBUG_LEVEL enumeration lists incrementally increasing levels of debugger output. |
| STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE Learn more about: _STREAM_MINIDRIVER_DEVICE_NOTIFICATION_TYPE enumeration |
| STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE Learn more about: _STREAM_MINIDRIVER_STREAM_NOTIFICATION_TYPE enumeration |
| STREAM_PRIORITY _STREAM_PRIORITY enumerates available priority levels for the stream. |
| TIME_FUNCTION Learn more about: TIME_FUNCTION enumeration |