Help Center
/
Help Center›AfxNova›CDSAudio Class

CDSAudio.Stopmethod

Stops all the filters in the filter graph.

AudiomethodCDSAudio.incdocumented

Syntax

FUNCTION Stop () AS HRESULT

Return value

Returns S_OK if successful, or an HRESULT value that indicates the cause of the error.

Description

Stops all the filters in the filter graph.

Remarks

If the graph is running, this method pauses the graph before stopping it. While paused, video renderers can copy the current frame to display as a poster frame.

This method does not seek to the beginning of the stream. If you call this method and then call the Run method, playback resumes from the stopped position. To seek, use the GetCurrentPosition and SetPositions methods.

The Filter Graph Manager pauses all the filters in the graph, and then calls the Stop method on all filters, without waiting for the pause operations to complete. Therefore, some filters might have their Stop method called before they complete their pause operation. If you develop a custom rendering filter, you might need to handle this case by pausing the filter if it receives a stop command while in a running state. However, most filters do not need to take any special action in this regard.

Reference

  • Include file CDSAudio.inc
  • Defined in AfxNova/CDSAudio.inc:193
  • Documented in Audio/CDSAudio Class.md
  • Topic: CDSAudio Class