IRTCSession::EncryptionKey
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 sets the encryption key to be used for one or more media streams.
Syntax
HRESULT put_EncryptionKey(
long lMediaType,
BSTR EncryptionKey
);
Parameters
- lMediaType
[in] An RTCMT_ constant specifying the media type to which the encryption key applies.
EncryptionKey
[in] A string following the SDP syntax for specifying session keys.If the string is set to NULL, the stream is not encrypted.
Return Value
This method can return an RTC_E_ constant.
The following table shows additional information about a specific return value.
| Value | Description |
|---|---|
RTC_E_INVALID_SESSION_TYPE |
The session must be of type PC-to-PC or PC-to-phone. |
Remarks
The application must call this method before answering incoming sessions, before adding participants to outgoing sessions, or before adding a stream to an existing session.
The application should call this method only to use an encryption key received by an out-of-band mechanism.
The application is responsible for exchanging the key with the remote endpoint.
The IRTCSession2::PreferredSecurityLevel method can be used to encrypt the media content of a PC-to-PC session. This method creates an encryption key internally and exchanges the encryption key with the remote endpoint through the SIP signaling channel.
.gif "Aa926618.security(en-us,MSDN.10).gif") Security Note: |
|---|
| The encryption key is temporarily cached in memory in clear text. |
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |