IMiniportWavePciStream::GetAllocatorFraming method (portcls.h)

The GetAllocatorFraming method gets the preferred allocator-framing parameters for the stream.

Syntax

NTSTATUS GetAllocatorFraming(
  [out] PKSALLOCATOR_FRAMING AllocatorFraming
);

Parameters

[out] AllocatorFraming

Pointer to a KSALLOCATOR_FRAMING structure into which the method writes the miniport driver's allocator-framing preferences for this stream.

Return value

GetAllocatorFraming returns STATUS_SUCCESS if the call was successful. Otherwise, the method returns an appropriate error code.

Remarks

The miniport driver should not assume that the actual allocator-framing parameters for the stream match those specified in the GetAllocatorFraming call. The port driver interprets the allocation-framing parameters from the GetAllocatorFraming as the miniport driver's preferences. Other factors might outweigh these preferences, however, when the SysAudio system driver builds the audio filter graph.

See the discussion of allocator framing in WavePci Latency.

Requirements

Requirement Value
Target Platform Universal
Header portcls.h (include Portcls.h)
IRQL PASSIVE_LEVEL

See also

IMiniportWavePciStream

KSALLOCATOR_FRAMING