Edit

IMiniportWaveRTStream::SetState method (portcls.h)

  • Article

The SetState method changes the transport state of the audio stream.

Syntax

NTSTATUS SetState(
  [in] KSSTATE State
);

Parameters

[in] State

Specifies the new state of the stream. This parameter is a KSSTATE enumeration value.

Return value

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

Remarks

For most driver implementations, KSSTATE_ACQUIRE and KSSTATE_PAUSE are indistinguishable.

Transitions always occur in one of the following two sequences:

  • STOP → ACQUIRE → PAUSE → RUN

  • RUN → PAUSE → ACQUIRE → STOP

The IMiniportWaveRT::NewStream method sets the initial state of the stream to KSSTATE_STOP.

Requirements

Requirement Value
Header portcls.h
IRQL PASSIVE_LEVEL

See also

IMiniPortWaveRTStream

IMiniportWaveRT::NewStream

KSSTATE