Edit

Share via

ITStream::PauseStream method (tapi3if.h)

  • Article

The PauseStream method pauses the stream.

Syntax

HRESULT PauseStream();

Return value

This method can return one of these values.

Value Meaning
S_OK
 Method succeeded.
E_NOTIMPL
 Method not implemented.

Remarks

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

If the stream pauses successfully, the MSP should fire CALL_MEDIA_EVENT with a value of CME_STREAM_INACTIVE and CALL_MEDIA_EVENT_CAUSE equaling CMC_LOCAL_REQUEST.

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

A call to StartStream restarts the stream.

Requirements

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

See also

ITStream

Media Service Provider Interface (MSPI)