Share via

CBaseRenderer::GetState

  • Article
 
Microsoft DirectShow 9.0

CBaseRenderer::GetState

The GetState method retrieves the filters's state (running, stopped, or paused).

Syntax

  HRESULT GetState(
    DWORD dwMilliSecsTimeout,
    FILTER_STATE *State
);

Parameters

dwMilliSecsTimeout

Time-out interval, in milliseconds.

State

Pointer to a variable that receives a member of the FILTER_STATE enumerated type, indicating the filter's state.

Return Value

Returns one of the HRESULT values shown in the following table.

Value Description
S_OK Success.
VFW_S_STATE_INTERMEDIATE The filter is transitioning to the indicated state.
E_POINTER NULL pointer argument.

Remarks

This method overrides the CBaseFilter::GetState method. When the renderer is paused, it does not complete the state transition until it receives a sample to render. If the time-out expires before the state transition is complete, the method returns VFW_S_STATE_INTERMEDIATE.

Requirements

**  Header:** Declared in Renbase.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also