IMiniportWaveRTStream::GetPosition method

The GetPosition method retrieves the current play or record position as a byte offset from the beginning of the buffer.

Syntax


NTSTATUS GetPosition(
  [out]  PKSAUDIO_POSITION AudioPosition
);

Parameters

AudioPosition [out]

Pointer to a KSAUDIO_POSITION structure. For a wave rendering stream, the method writes the write position and the play position into this structure. For a wave-capture stream, the method writes the read position and the record position into the structure. Positions are specified as byte offsets from the beginning of the cyclic buffer.

Return value

GetPosition returns STATUS_SUCCESS if the call was successful. Otherwise, the function returns an appropriate error status code.

Remarks

The WaveRT port driver calls this method in response to a KSPROPERTY_AUDIO_POSITION property request from a client.

Requirements

Version

Available in Windows Vista and later Windows operating systems.

Header

Portcls.h

IRQL

Passive or Dispatch level.

See also

KSAUDIO_POSITION
KSPROPERTY_AUDIO_POSITION

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft