Platform SDK: TAPI

ITSubStream::PauseSubStream

Pauses the substream.

HRESULT PauseSubStream( );

Parameters

This interface has no parameters.

Return Values

Value Meaning
S_OK Method succeeded.
TAPI_E_NOTSUPPORTED This operation is not supported.

Remarks

The difference between pausing and stopping a stream depends on the type of transport.

If the substream pauses successfully, the application receives a CALL_MEDIA_EVENT with a value of CME_STREAM_INACTIVE and CALL_MEDIA_EVENT_CAUSE equaling CMC_LOCAL_REQUEST.

If the substream fails to pause, the event will be CME_STREAM_FAIL with cause CMC_LOCAL_REQUEST.

A call to StartSubStream restarts the substream.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Version: Requires TAPI 3.0 or later.
  Header: Declared in Tapi3.h.
  Library: Use T3iid.lib.

See Also

Media Service Provider Interface (MSPI), ITSubStream