IRTCSession::RemoveStream

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/28/2008

This method removes one media stream from this session. The session must be in the RTCSS_CONNECTED or RTCSS_INPROGRESS state. The call starts a renegotiation with the other end of the call, and an RTCE_SESSION_STATE_CHANGE event is triggered.

Syntax

HRESULT RemoveStream(
  long lMediaType,
  LONG_PTR lCookie
);

Parameters

• lMediaType
  [in] RTCMT_ constant specifying the media type for which to remove the stream. Only one stream can be removed by this call.

  Windows Embedded CE does not support RTCMT_VIDEO_SEND, RTCMT_VIDEO_RECEIVE and RTCMT_T120_SENDRECV media types.

• lCookie
  [in] Pointer to an application-provided cookie used in the completion notification.

Return Value

This method can return an RTC_E_ constant.

The following table shows additional information about specific return values.

Value	Description
RTC_E_INVALID_SESSION_STATE	Session must be connected or in progress.
RTC_E_INVALID_SESSION_TYPE	Session must be of type PC-to-PC or PC-to-phone.

Remarks

For RTC Client API version 1.2, this method can be called multiple times to remove all media streams from the session.

For the RTC version 1.0 API, this method can be used to remove all but one media stream.

This method will remove the media type specified in the IRTCClient::SetPreferredMediaTypes method.

Security Note:
This method can send data over the network in unencrypted form. Therefore, someone eavesdropping on the network might be able to read the data. Before using this method in an unencrypted session, consider the security risk of sending the data in clear text. The application can encrypt an RTC session by specifying TLS in the profile used for the session.

Requirements

Header	rtccore.h, rtccore.idl
Library	uuid.lib
Windows Embedded CE	Windows CE .NET 4.0 and later

See Also

Reference

IRTCSession
IRTCClient::SetPreferredMediaTypes
IRTCSession::AddStream