KSPROPERTY_AUDIO_POSITION

The KSPROPERTY_AUDIO_POSITION property specifies the current positions of the play and write cursors in the sound buffer for the pin's audio stream.

Usage Summary Table

Get Set Target Property descriptor type Property value type

Yes

Yes

Pin

KSPROPERTY

KSAUDIO_POSITION

The property value (operation data) is a structure of type KSAUDIO_POSITION that specifies a render stream's play and write positions or a capture stream's record and read positions.

Return Value

A KSPROPERTY_AUDIO_POSITION property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.

Remarks

DirectSound uses the KSPROPERTY_AUDIO_POSITION property to implement the IDirectSoundBuffer::GetCurrentPosition and IDirectSoundBuffer::SetCurrentPosition methods. The Windows multimedia functions waveInGetPosition and waveOutGetPosition also use this property. For more information about DirectSound and the Windows multimedia functions, see the Microsoft Windows SDK documentation.

WaveCyclic and WavePci miniport drivers do not need to implement property handlers for KSPROPERTY_AUDIO_POSITION because the WaveCyclic and WavePci port drivers handle this property on behalf of miniport drivers. To obtain the play position in a render stream or record position in a capture stream, the property handler in the port driver calls the miniport driver's IMiniportWaveCyclicStream::GetPosition or IMiniportWavePciStream::GetPosition method.

For more information, see Audio Position Property.

Requirements

Header

Ksmedia.h (include Ksmedia.h)

See also

KSPROPERTY

KSAUDIO_POSITION

IMiniportWaveCyclicStream::GetPosition

IMiniportWavePciStream::GetPosition