UCC_CONFERENCE_ENTITY_STATE_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 describing the state of a conference entity.
Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)
Syntax
'Declaration
Public Enumeration UCC_CONFERENCE_ENTITY_STATE_PROPERTY
public enum UCC_CONFERENCE_ENTITY_STATE_PROPERTY
public enum class UCC_CONFERENCE_ENTITY_STATE_PROPERTY
public enum UCC_CONFERENCE_ENTITY_STATE_PROPERTY
public enum UCC_CONFERENCE_ENTITY_STATE_PROPERTY
Members
| Member name | Description |
|---|---|
| UCCCESTP_ACP_ENTRY_EXIT_ANNOUNCEMENT | The ID of a property of the string (BSTR) value holding the announcement that a user might want to make when entering or exiting a teleconference. |
| UCCCESTP_ACP_PARTICIPANT_PASSCODE | The ID of a property of the integer (LONG) value holding the passcode used by a participant to join the conference. |
| UCCCESTP_ACP_TOLL_FREE_NUMBER | The ID of a property of the string (BSTR) value holding the telephone number (toll free) for dialing in to a teleconference. For example, +18005551111. |
| UCCCESTP_ACP_TOLL_NUMBER | The ID of a property of the string (BSTR) value holding the telephone number (with toll) for dialing in to a teleconference. For example, +14255551111. |
| UCCCESTP_ACTIVE | The ID of a property of the Boolean (BOOL) value indicating whether the conference entity is active (TRUE) or not (FALSE). |
| UCCCESTP_AV_DOMINANT_SPEAKER_SOURCE | This field is obsolete. |
| UCCCESTP_AV_INTENDED_PRIME_PRESENTER_SOURCE | This field is obsolete. |
| UCCCESTP_AV_INTENDED_SECONDARY_PRESENTER_SOURCE | This field is obsolete. |
| UCCCESTP_AV_VIDEO_MODE | This field is obsolete. |
| UCCCESTP_DATA_MCU_GUID | The ID of a property of the string (BSTR) value holding the GUID value of the conference data MCU. |
| UCCCESTP_DISPLAY_TEXT | The ID of a property of the string value holding the display text of the conference entity. |
| UCCCESTP_LOCKED | The ID of a property of the Boolean (BOOL) value indicating whether the conference entity is locked (TRUE) or not (FALSE). |
| UCCCESTP_MEDIA_COLLECTION | The ID of a property of the IUccCollection object containing a collection of IDs of the media properties that are defined in the UCC_CONFERENCE_MEDIUM_PROPERTY enumeration. |
| UCCCESTP_MEDIA_FILTERS_RULE_COLLECTION | The ID of a property of the IUccCollection object containing a collection of IDs of the media filters rule properties that are defined in the UCC_CONFERENCE_MEDIA_FILTERS_RULE_PROPERTY enumeration. |
| UCCCESTP_RECORDED_MEDIA_COLLECTION | The ID of a property of the IUccCollection object containing a collection of IDs of the recorded media properties that are defined in the UCC_CONFERENCE_RECORDED_MEDIA enumeration. |
| UCCCESTP_RECORDING_ACTIVE | The ID of a property of the Boolean (BOOL) value indicating whether Live Meeting recording is active (TRUE) or not (FALSE). |
| UCCCESTP_RECORDING_ERROR_CODE | The ID of a property of the integer (LONG) value holding an error code of an error associated with the MCU. |
| UCCCESTP_RECORDING_ERROR_DESCRIPTION | The ID of a property of the string (BSTR) value holding the description of an error associated with the MCU. |
| UCCCESTP_RECORDING_ID | The ID of a property of the string (BSTR) value holding the ID of the meeting recording for a Live Meeting conference. |
| UCCCESTP_RECORDING_PAUSED | The ID of a property of the Boolean (BOOL) value indicating whether the meeting recording is paused (TRUE) or not (FALSE). |
| UCCCESTP_USER_COUNT | The ID of a property of the integer (LONG) value holding the number of the users connected to the conference entity. |
Remarks
An application can obtain a collection of the state properties of a conference entity by (1) getting the Properties property on a conference entity view (IUccConferenceEntityView) and then (2) extracting the state properties collection by calling Properties.get_Property((int)UCC_CONFERENCE_ENTITY_PROPERTY.UCCCEP_STATE).ObjectValue as IUccReadOnlyPropertyCollection. To read an individual state property, the application can call get_Property on the Properties value returned in Step 2 above, specifying one of the members of this enumeration type. 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_ENTITY_STATE_PROPERTY
{
UCCCESTP_DISPLAY_TEXT = 1 | UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_USER_COUNT = 2 | UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_NUMERIC,
UCCCESTP_ACTIVE = 3 | UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_BOOLEAN,
UCCCESTP_LOCKED = 4 | UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_BOOLEAN,
UCCCESTP_RECORDING_ID = 5 | UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_RECORDING_ACTIVE = 6 | UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_BOOLEAN,
UCCCESTP_RECORDING_ERROR_CODE = 7 | UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_NUMERIC,
UCCCESTP_RECORDING_ERROR_DESCRIPTION = 8 | UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_RECORDING_PAUSED = 9 | UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_BOOLEAN,
UCCCESTP_MEDIA_COLLECTION = 10| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_COLLECTION,
UCCCESTP_MEDIA_FILTERS_RULE_COLLECTION = 11| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_COLLECTION,
UCCCESTP_RECORDED_MEDIA_COLLECTION = 12| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_COLLECTION,
UCCCESTP_ACP_TOLL_NUMBER = 13| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_ACP_TOLL_FREE_NUMBER = 14| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_ACP_PARTICIPANT_PASSCODE = 15| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_ACP_ENTRY_EXIT_ANNOUNCEMENT = 16| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_AV_VIDEO_MODE = 17| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_ENUMERATION,
UCCCESTP_AV_DOMINANT_SPEAKER_SOURCE = 18| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_AV_INTENDED_PRIME_PRESENTER_SOURCE = 19| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_AV_INTENDED_SECONDARY_PRESENTER_SOURCE = 20| UCCPCL_CONFERENCE_ENTITY_STATE | UCCPAC_READ_ONLY | UCCPT_STRING,
UCCCESTP_DATA_MCU_GUID = 21 | UCCPCL_CONFERENCE_ENTITY_STATE | 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