Platform SDK: TAPI

ITStream::UnselectTerminal

Unselects the terminal from the stream and stops streaming for this stream.

HRESULT UnselectTerminal(
  ITTerminal *pTerminal
);

Parameters

pTerminal
[in] Pointer to ITTerminal interface terminal to remove from stream.

Return Values

Value Meaning
S_OK Method succeeded.
E_POINTER The pTerminal parameter is not a valid pointer.
E_OUTOFMEMORY Insufficient memory exists to perform the operation.
TAPI_E_INVALIDTERMINAL The pTerminal parameter does not point to a valid terminal.
TAPI_E_NOTSUPPORTED The provider does not support this operation.

Remarks

Some stream events may be received after streaming has been stopped due to delayed transmission.

Successfully unselecting the last terminal from a stream effectively ceases any existing streaming for this particular stream. Subsequently selecting the same terminal or another terminal restarts such interrupted streaming.

Reselection onto a stream with a different terminal, or a newly created one, can have unexpected effects. The filter graph may retain information from the previous terminal that fails to match the new one.

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