Edit

Share via

ITSubStream::PauseSubStream method (tapi3if.h)

  • Article

The PauseSubStream method pauses the substream.

Syntax

HRESULT PauseSubStream();

Return value

This method can return one of these 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

Requirement Value
Target Platform Windows
Header tapi3if.h (include Tapi3.h)

See also

ITSubStream

Media Service Provider Interface (MSPI)