IRTCClient2::CreateSessionWithDescription
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method enables the client application to control the session and specify the body and content type of the session INVITE request. The application is responsible for all of the session's media negotiations.
Syntax
HRESULT CreateSessionWithDescription(
BSTR bstrContentType,
BSTR bstrSessionDescription,
IRTCProfile* pProfile,
long lFlags,
IRTCSession2** ppSession2
);
Parameters
bstrContentType
[in] The content type for the INVITE request.The content type is application-specific.
The application should ensure that this method can decipher the content type of the session description.
- bstrSessionDescription
[in] The session description for the INVITE request.
- pProfile
[in] Pointer to the IRTCProfile interface of the profile to use for the session.
lFlags
[in] RTCCS_ flags specifying the force profile and fail on redirect settings.A value of zero is valid for this parameter and indicates that the default profile is used for this session.
The RTC Client API automatically allows redirections to occur. For more information, see the Remarks section.
- ppSession2
[out] Pointer to the IRTCSession2 interface. This method adds a reference to the interface, which the caller is responsible for releasing.
Return Value
This method can return an RTC_E_ constant.
The following table shows an additional possible return value.
| Value | Meaning |
|---|---|
E_FAIL |
The media could not be disabled for this session, the local session description could not be set, or there is insufficient memory to perform this operation. |
Remarks
This method enables an application to use its own media manager for an RTCST_PC_TO_PC session, and not use the media manager included in the RTC Client API implementation.
Using this method, the application can create a PC-to-PC session and generate its own media description to be sent in the body of the SIP INVITE message.
Any media description received in a response from the called entity is given directly to the application by the RTC Client API.
The application is responsible for negotiating and handling media.
The CreateSessionWithDescription method is required to create a media session when the media has been globally disabled. The media is disabled by initializing the Client object using the IRTCClient2::InitializeEx method with the RTCIF_DISABLE_MEDIA flag set.
The content type is application-specific. Applications should ensure that the called party can decipher the content type of the session description.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |
See Also
Reference
IRTCClient2
IRTCClient::CreateSession
IRTCClient2::InitializeEx
IRTCProfile
IRTCSession2