IRTCSessionDescriptionManager::EvaluateSessionDescription

The EvaluateSessionDescription method allows the RTC Client API to supply the application with the content type and body of the SIP INVITE request. The application then decides to accept or reject the request.

HRESULT EvaluateSessionDescription(BSTRbstrContentType,
BSTRbstrSessionDescription,
VARIANT_BOOL*pfApplicationSession);

Parameters

  • bstrContentType
    [in] BSTR containing the content type for the response to the Reinvite.
  • bstrSessionDescription
    [in] BSTR containing the session description for the response to the Reinvite.
  • pfApplicationSession
    [in, out] Pointer to a VARIANT_BOOL containing the application's decision to accept (TRUE) or reject (FALSE) the INVITE request.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_CLIENT_NOT_INITIALIZED The client object is not initialized.
E_INVALIDARG The pfApplicationSession parameter is not a valid pointer, or the bstrContentType or bstrSessionDescription parameter is not valid.

Remarks

This method is required when the Client object has been initialized using the IRTCClient::Initialize method or if the Client object has been initialized using the IRTCClient2::InitializeEx method without specifying the RTCIF_DISABLE_MEDIA flag.

This method allows applications to handle the session negotiations for a session. The application may choose to handle session negotiations for several reasons; for example, when the application wants to include media stacks that are not supported by the RTC Client API. For more information, see Session Negotiation.

This method may be called on any incoming session including a session re-INVITE request.

The content type is application specific. Applications should ensure that the called party is able to decipher the content type of the session description.

Note  The EvaluateSessionDescription method is a callback. It is strongly recommended that the application return from this function immediately and not run a Windows message pump when the function is called.

Requirements

Redistributable: Requires Rtcdll.dll on Windows 2000, Windows XP, and Windows Server 2003.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCSessionDescriptionManager is defined as BA7F518E-D336-4070-93A6-865395C843F9.

See Also

IRTCReInviteEvent, IRTCSession, Session Negotiation