Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The method retrieves the session description from the remote client.
HRESULT GetRemoteSessionDescription(BSTR*pbstrContentType,
BSTR*pbstrDescription);
Parameters
- pbstrContentType
[out] BSTR containing the content type for the session description. The caller is responsible for freeing this memory with SysFreeString. - pbstrDescription
[out] BSTR containing the session description. The caller is responsible for freeing this memory with SysFreeString.
Return Values
RTC methods may return an RTC_E_ constant.
Value | Meaning |
---|---|
E_INVALIDARG | The pbstrContentType or pbstrDescription parameter is NULL. |
RTC_E_MEDIA_ENABLED | The media is enabled. |
RTC_E_INVALID_SESSION_STATE | The session is not in the connected or incoming state. |
Remarks
This method is used for sessions of type RTCST_APPLICATION only. A call to this method for any other type of session will fail. This method is called for sessions in the RTCSS_CONNECTED or RTCSS_INCOMING states only. The application calls this method on sessions in the RTCSS_INCOMING state to get the remote session description before it answers the session with the IRTCSession2::AnswerWithSessionDescription method. The session description retrieved from this method may have been set by the remote client with the IRTCClient2::CreateSessionWithDescription method. If this method is called on a session in the IRTCSS_CONNECTED state, the application retrieves the session description that was set by the remote client by calling the IRTCSession2::AnswerWithSessionDescription method.
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_IRTCSessionStateChangeEvent2 is defined as 4F933171-6F95-4880-80D9-2EC8D495D261.