Edit

Share via

ITStream::StartStream method (tapi3if.h)

  • Article

The StartStream method starts the stream.

Syntax

HRESULT StartStream();

Return value

This method can return one of these values.

Value Meaning
S_OK
 Method succeeded.
E_NOTIMPL
 Method not implemented.
TAPI_E_NOTERMINALSELECTED
 No terminal has been selected on the stream, so it cannot be started.
TAPI_E_NOTSTOPPED
 Stream has already been started.

Remarks

Streams start automatically as soon as a call is connected and ready to stream and a terminal is selected. Therefore, most applications do not need to call this method. Applications have to call this method only to start a stream that the application has previously stopped or paused by calling ITStream::StopStream or ITStream::PauseStream.

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 starts successfully, the MSP fires a CALL_MEDIA_EVENT with a value of CME_STREAM_ACTIVE event and CALL_MEDIA_EVENT_CAUSE equaling CMC_LOCAL_REQUEST.

If the stream fails to pause, the MSP fires a CME_STREAM_FAIL event with cause CMC_LOCAL_REQUEST.

Requirements

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

See also

ITStream

Media Service Provider Interface (MSPI)