Platform SDK: TAPI

ITStream::StartStream

Starts the stream.

HRESULT StartStream( );

Parameters

This method has no parameters.

Return 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 with 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

  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), ITStream