IRTCSession::EncryptionKey (Windows Embedded CE 6.0)

1/6/2010

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.

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.

Security Note:
The encryption key is temporarily cached in memory in clear text.

Requirements

See Also

Reference

IRTCSession
IRTCSession2::PreferredSecurityLevel