| Platform SDK: TAPI |
Stops the stream.
HRESULT StopStream( );
This interface has no parameters.
| Value | Meaning |
|---|---|
| S_OK | Method succeeded. |
| E_NOTIMPL | Method not implemented. |
| TAPI_E_NOTSUPPORTED | The provider does not support this operation. |
An application can call this method to stop a stream. The difference between pausing a stream and stopping a stream depends on the type of transport used for the call.
This call generates events that the application can retrieve if it has registered. Please see the Events overview for information on receiving events.
If the stream stops successfully, the application receives a CALL_MEDIA_EVENT with a value of CME_STREAM_INACTIVE event and CALL_MEDIA_EVENT_CAUSE equaling CMC_LOCAL_REQUEST.
If the stream fails to pause, the application receives a CME_STREAM_FAIL event with cause CMC_LOCAL_REQUEST.
To subsequently restart the stream, the application must call StartStream.
Windows NT/2000: Requires Windows 2000.
Version: Requires TAPI 3.0 or later.
Header: Declared in Tapi3.h.
Library: Use T3iid.lib.