UCC_CONFERENCE_MEDIUM_PROPERTY Enumeration
This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
Enumerates the IDs of the properties of a conference medium.
Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)
Syntax
'Declaration
Public Enumeration UCC_CONFERENCE_MEDIUM_PROPERTY
public enum UCC_CONFERENCE_MEDIUM_PROPERTY
public enum class UCC_CONFERENCE_MEDIUM_PROPERTY
public enum UCC_CONFERENCE_MEDIUM_PROPERTY
public enum UCC_CONFERENCE_MEDIUM_PROPERTY
Members
| Member name | Description |
|---|---|
| UCCCMP_DISPLAY_TEXT | The ID of a property of the string (BSTR) value holding the display text of the media. |
| UCCCMP_LABEL | The ID of a property of the string (BSTR) value holding the media label. |
| UCCCMP_PRIMARY_VIDEO_SOURCE | The ID of a property of the string (BSTR) value holding the endpoint URI of the primary video stream. For more information, see the discussion about UCCCMP_VIDEO_MODE above. |
| UCCCMP_STATUS | The ID of a property of the string (BSTR) value describing the status of the media. |
| UCCCMP_TYPE | The ID of a property of the UCC_MEDIA_TYPES value indicating the type of the media. |
| UCCCMP_VIDEO_MODE | The ID of a property of the UCC_VIDEO_SWITCHING_MODE value describing how the primary video stream is switched among conference participants. A conference presenter sets this or UCCCMP_VIDEO_MODE property to determine which participant (including the presenter) has his or her video stream broadcast to all the conference participants. There are three ways to do that. For automatic switching, an application sets this property to the UCC_VIDEO_SWITCHING_MODE.CCVSM_DOMINANT_SPEAKER_SWITCHED value. In this case, the corresponding UCCCMP_PRIMARY_VIEDO_SOURCE value is ignored. There are two cases for manual switching depending on whether the primary video stream is broadcast to the conference participants (normal case) or not (no-video case). The no-video case applies only to a Live Meeting conference session. For the normal case of manual switching, the application sets the UCCMP_PRIMARY_VIDEO_SOURCE property to the endpoint URI of a designated user (either a participant or a presenter) and ignore this (UCCCMP_VIDEO_MODE) property. For the no-video case of manual switching, the application must set this (UCCCMP_VIDEO_MODE) property to UCC_VIDEO_SWITCHING_MODE.MANUAL_SELECTION and set the next (UCCCMP_PRIMARY_VIDEO_SOURCE) property to sip:null@invalid. An application can determine the video switching mode and/or primary video source of a media channel by catching the OnSourceChanged event raised by an IUccAudioVideoMediaChannel object. |
Remarks
To examine a conference media property (such as the media label), (1) obtain the state properties collections from a conference entity by calling IUccReadOnlyPropertyCollection stateProps = IUccConferenceEntityView.Properties.get_Property((int)UCC_CONFERENCE_ENTITY_PROPERTY.UCCCEP_STATE) as IUccReadOnlyPropertyCollection , (2) obtain the media properties collection from the state property bag by calling IUccCollection mediaProps = stateProps.Properties.get_Property((int)UCC_CONFERENCE_ENTITY_STATE_PROPERTY.UCCCESTP_MEDIA_COLLECTION).ObjectValue as IUccCollection, and then (3) obtain the media property by calling string mediaLabel = mediaProps.Properties.get_Item((int)UCC_CONFERENCE_MEDIA_PROPERTY.UCCCMP_LABEL) as string. The application can determine the data type and accessibility as well as the applicable class of the properties defined by this enumeration using the UCC_PROPERTY_TYPE and UCC_PROPERTY_ACCESSIBILITY as well UCC_PROPERTY_CLASS enumerations.
Win32 COM/C++ Syntax
typedef enum UCC_CONFERENCE_MEDIUM_PROPERTY
{
UCCCMP_LABEL = 1 | UCCPCL_CONFERENCE_MEDIUM | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCMP_DISPLAY_TEXT = 2 | UCCPCL_CONFERENCE_MEDIUM | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCMP_TYPE = 3 | UCCPCL_CONFERENCE_MEDIUM | UCCPAC_READ_ONLY | UCCPT_ENUMERATION,
UCCCMP_STATUS = 4 | UCCPCL_CONFERENCE_MEDIUM | UCCPAC_READ_ONLY | UCCPT_NUMERIC,
UCCCMP_VIDEO_MODE = 5 | UCCPCL_CONFERENCE_MEDIUM | UCCPAC_READ_ONLY | UCCPT_ENUMERATION,
UCCCMP_PRIMARY_VIDEO_SOURCE = 6 | UCCPCL_CONFERENCE_MEDIUM | UCCPAC_READ_ONLY | UCCPT_STRING
};
Platforms
Development Platforms
Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition