PlcmConferenceTemplateV5

PlcmConferenceTemplateV5

Conference templates are used to create users' conference rooms, which define a user's conference experience. A conference template specifies a set of conference properties, such as the line (bit) rate and video display mode. Content-Type: application/vnd.plcm.plcm-conference-template-v5+xml. All attributes are used in ETag calculation except for entity-tag and atom-link.


PlcmConferenceTemplateV5 Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
plcmSimulcastStreamList Array of PlcmSimulcastStreamSee Definition of PlcmSimulcastStream
plcmLineRate PlcmLineRateSee Definition of PlcmLineRate
conferenceTemplateIdentifierstring Internal identifier. Provided to protect against a name update.
nameName A meaningful name for the template (up to 50 characters). Mandatory
descriptionDescription A brief description of the conference template (up to 50 characters).
priorityint If a user is associated with multiple conference templates, this priority will take effect. Read-only.
rmxProfilestring Identifies the RMX profile to which this template is linked.
useProfileboolean If true, links this template to the RMX profile identified by the rmx-profile field.
encryptionboolean Specifies that media encryption should be required for conferences using this template.
lostPacketRecoveryboolean Enables Lost Packet Recovery (LPR) for conferences using this template. LPR creates additional packets containing recovery information that can be used to reconstruct packets lost during transmission.
h239SettingsH239Settings The transmission mode for the Content channel: - Graphics: lowest bit rate for basic graphics - High-resolution graphics: higher bit rate for better graphics resolution - Live video: the Content channel is used for live video A higher bit rate for the Content channel reduces the bit rate for the People channel.
h239ProtocolH239Protocol Content channel protocol options: - Use H.264 if available, otherwise use H.263. - Always use H.263.
highDefinitionVideoSwitchingboolean Enables a special conferencing mode that provides HD video while using MCU resources more efficiently. All participants see the current speaker full screen (the current speaker sees the previous speaker). If this mode is enabled: - The minimum line rate available is 768 kbps (except for SD resolution, available only on RMX v7 MCUs with MPM+ or MPMx cards). - All endpoints must connect at the same line rate, and those that don't support the specified line rate are connected in voice-only mode. - The video clarity, layout, and skins settings are not available. - LPR is automatically turned off, but can be turned back on. If this option is off, conferences using this template are in Continuous Presence (CP) mode, in which the MCU selects the best video protocol, resolution, and frame rate for each endpoint according to its capabilities.
highProfileVswboolean Enables a special conferencing mode that provides HD video while using MCU resources more efficiently. All participants see the current speaker full screen (the current speaker sees the previous speaker). If this mode is enabled: - The minimum line rate available is 768 kbps (except for SD resolution, available only on RMX v7 MCUs with MPM+ or MPMx cards). - All endpoints must connect at the same line rate, and those that don't support the specified line rate are connected in voice-only mode. - The video clarity, layout, and skins settings are not available. - LPR is automatically turned off, but can be turned back on. If this option is off, conferences using this template are in Continuous Presence (CP) mode, in which the MCU selects the best video protocol, resolution, and frame rate for each endpoint according to its capabilities.
hdResolutionHdResolution Available only if Video switching is selected.
videoQualityVideoQuality Offers two video optimizations: - Motion: higher frame rate - Sharpness: higher resolution
participantsJoinTypeParticipantsJoinType
telepresenceModeTelepresenceMode Support for telepresence conference rooms joining the conference: - auto (default): A conference is automatically put into telepresence mode when a telepresence endpoint (RPX, TPX, or ATX) joins. - yes: Telepresence mode is on, regardless of whether a telepresence endpoint is present. - no: Telepresence mode is off, regardless of whether a telepresence endpoint is present. Available only on RMX v. 6.0 or later MCUs that are licensed for telepresence mode. We recommend always using Auto. Note: The RMX system flag ITP_CERTIFICATION must be set to YES. See Table 19-3, “Manually Added System Flags: MCMS_PARAMETERS� in the Polycom RMX Administrator's Guide.
telepresenceLayoutModeTelepresenceLayoutMode Layout choices for telepresence conferences: - Manual: Layout is controlled manually by a conference operator using the Multipoint Layout Application (MLA) interface. - Continuous Presence: Tells the MLA to generate a multipoint view (standard or custom). - Room Switch: Tells the MLA to use Voice Activated Room Switching (VARS). The speaker's site is the only one seen by others. Not available if Telepresence mode is No. See the Polycom Multipoint Layout Application User Guide for more information about layouts.
presentationModeboolean Enables a conference to change to lecture mode when the current speaker speaks for 30 seconds. When another participant starts talking, it returns to the previous video layout. Not available if Video switching or Same layout is selected, or if Telepresence mode is Yes.
lecturerViewSwitchingboolean When in lecture mode, enables the lecturer's view to automatically switch among participants (if the number exceeds the number of windows in the layout) while the lecturer is talking. Not available if Same layout is selected, or if Telepresence mode is Yes.
sameLayoutboolean Forces the selected layout on all participants. Personal selection of the video layout is disabled. Not available if Presentation mode or Video switching is selected, or if Telepresence mode is Yes.
autoLayoutboolean Lets the system select the video layout based on the number of participants in conference. Clear the check box to select a specific layout (below). Not available if Video switching is selected, or if Telepresence mode is Yes.
layoutLayout The number and arrangement of video frames. Not available if video-switching is selected.
skinSkin Lets you choose the display appearance (skin) for conferences using this template. Not available if Telepresence mode is Yes. or Video switching is enabled.
conferenceIvrServicestring The list contains the names of all the conference IVR services available on the currently connected MCUs. If an IVR service is only available on some of the connected MCUs, its entry shows how many of the MCUs have that IVR service (for instance, 2 of 3). The system will put conferences using this template on the least used RMX MCU that has the selected conference IVR service. If there are none, it falls back to the default conference IVR service.
conferenceRequiresChairpersonboolean Conferences based on this template don't start until a chairperson joins (callers arriving earlier are placed on hold) and may end when the last chairperson leaves (depending on the MCU configuration). This option is ignored if the user doesn't have a chairperson passcode.
videoClarityboolean Enables a video enhancement process that improves clarity, edge sharpness, and contrast on streams with resolutions up to and including SD. Available only on RMX MCUs with MPM+ or MPMx cards. Not available if Video switching is selected.
audioClarityboolean Improves the voice quality in conference of a PSTN endpoint. Available only on RMX v7 MCUs.
useCascadingboolean Enables conferences using this template to span RMX MCUs in order to conserve bandwidth. Cascading requires site topology information, which the Polycom DMA system can get from a Polycom CMA gatekeeper.
echoSuppressionboolean Enables the MCU to detect and suppress echo. Available only on MCUs with MPM+ or MPMx cards.
keyboardSuppressionboolean Enables the MCU to detect and suppress keyboard noise. Available only on MCUs with MPM+ or MPMx cards.
sendContentToLegacyEndpointsboolean Enables endpoints that don't support H.239 to receive the Content channel over the video (People) channel. Available only on MCUs with MPM+ and MPMx cards. Not available if Video switching or Same layout is selected, or if Telepresence mode is Yes.
recordingTypeRecordingType The conference recording setting for this template: - Disabled: Recording isn't available for conferences using this template. - Immediately: Recording starts automatically when the conference starts. - Upon Request: Recording can be initiated manually by the chairperson or an operator. Conference recording requires a Polycom RSS recording system and an MCU that supports recording.
audioOnlyRecordingboolean Limits recording to the audio channel of the conference.
enableRecordingIndicationboolean Displays a red dot recording indicator in the upper left corner of the video layout. Available only on RMX v7.1 MCUs.
floorAndChairControlFloorAndChairControl Specifies how much control conference participants may have: - Do not allow: Participants have no control. - Floor only: A participant may “take the floor.� Everyone sees that participant's video full-screen. - Floor and chair control: A participant may also “take the chair.� The chair can designate whose video everyone sees full-screen. The chair can also disconnect participants. This setting works only in H.323 conferences and only if H.243 Floor and Chair Control is enabled on the MCU. All endpoints must support H.243 chair control.
layoutControlLayoutControl Enables participants to change their individual layouts using far end camera control, with or without fallback to touchtone commands for endpoints that don't support FECC. FECC without fallback is available only on Codian v4.1 MCUs.
contentChannelVideoContentChannelVideo Enables the conference to support a second video stream for content. This setting works only if Content Status is enabled on the MCU.
codianCustomLayoutAllowedCodianCustomLayoutAllowed
codianLayoutCodianLayout
codianLectureModeCodianLectureMode Enables the MCU to put a conference into lecture mode, either immediately or after the speaker has been talking for the selected interval. In lecture mode, the lecturer (speaker) is displayed full-screen to the other participants. The lecturer sees the normal continuous presence view. Available only on Codian v4.1 MCUs.
codianMuteDtmfCodianMuteDtmf Specifies whether the MCU mutes participants' in-band DTMF (touchtones) so that other participants don't hear them: - When used for MCU control - Always - Never Available only on Codian v4.1 MCUs.
codianTransmittedContentResolutionCodianTransmittedContentResolution Specifies the aspect ratio used for the content channel. If Allow all resolutions is selected, endpoints with a 16:9 aspect ratio receive that, and others receive 4:3. Available only on Codian v4.1 MCUs.
codianAllowMuteAudioCodianAllowMuteAudio Enables conference participants to mute themselves using the *6 touchtone command. Available only on Codian v4.1 MCUs.
recordingLinkstring Select a specific recording link or the MCU's default. The list contains the names of all recording links available on the connected MCUs, with the number of MCUs that have the link shown in parentheses. Available only on RMX v7 MCUs.
resolutionLimitResolutionLimit The four resolution settings limit the conference to no more than that resolution regardless of the line rate and resolution capabilities of the MCU and endpoints. Auto (the default) imposes no limit. Available only on RMX v7 MCUs.
autoBrightnessboolean Enables automatic balancing of brightness levels to compensate for an endpoint sending a dim image. Available only on RMX v7 MCUs.
enableGatheringboolean Enables the gathering phase feature for conferences using this template. Available only on RMX v. 6.0 or later MCUs. The gathering phase is a time period (configurable on the RMX MCU) at the beginning of a conference, when people are connecting. During this time, a slide is displayed that contains conference information, including a list participants and some information you can specify here.
gatheringLanguageGatheringLanguage Language in which the gathering page is displayed.
gatheringAccessNumber1string Optional access numbers to display on the gathering phase slide.
gatheringAccessNumber2string Optional access numbers to display on the gathering phase slide.
gatheringInfo1string Optional free-form text fields to display on the gathering phase slide. Refer to the RMX Administrator's Guide to see an example of the slide and the location and appearance of these fields. On a 16:9 endpoint, a maximum of 96 characters can be displayed for each field, and fewer on a 4:3 endpoint.
gatheringInfo2string Optional free-form text fields to display on the gathering phase slide. Refer to the RMX Administrator's Guide to see an example of the slide and the location and appearance of these fields. On a 16:9 endpoint, a maximum of 96 characters can be displayed for each field, and fewer on a 4:3 endpoint.
gatheringInfo3string Optional free-form text fields to display on the gathering phase slide. Refer to the RMX Administrator's Guide to see an example of the slide and the location and appearance of these fields. On a 16:9 endpoint, a maximum of 96 characters can be displayed for each field, and fewer on a 4:3 endpoint.
tipCompatibilityTipCompatibility
encryptionPolicyEncryptionPolicy
conferenceCodecSupportConferenceCodecSupport Specifies conference mode.
cascadingForSizeboolean Enables cascading of MCUs for large conferences. This attribute is mutually exclusive with use-cascading.
fwNatKeepaliveboolean The RMX can be configured to send a FW NAT keep alive message at specific Intervals for the RTP, UDP and BFCP channels. This is necessary because port mappings in the firewall are kept open only if there is network traffic in both directions. The firewall will only allow UDP packets into the network through ports that have been used to send packets out. By default the RMX sends a FW NAT Keep Alive message every 30 seconds. As there is no traffic on the Content and FECC channels as a call begins, the firewall will not allow any incoming packets from the Content and FECC channels in until the RMX sends out the first of the FW NAT Keep Alive messages 30 seconds after the call starts. If Content or FECC are required within the first 30 seconds of a call the FW NAT Keep Alive Interval should be modified to a lower value.
fwNatKeepaliveIntervalstring Interval at which firewall NAT keepalive messages are sent. Max 86400, min 5, default 30.
audioOnlyConferenceboolean The RMX can be configured to restrict a conference to support only audio media. Video endpoints may join the conference, but they will only send and receive audio.
conferenceModeExperienceConferenceModeExperience Video resolution presets which define the conference experience. Each preset consists of a defined set of operation points for the preferred experience of the conference. The actual set of operation points for each is defined on the bridge, tailored for each experience. This is currently only valid if the conference-codec-support is MIXED.
asSipContentboolean When AS SIP content is selected, the MCU and the endpoint use a different SIP signaling flow to start content transmission. This flow follows standards and is compatible with existing endpoints. The AS SIP content option enables content transcoding using H.264 base profile. Endpoints that do not support H.264 will be connected in legacy content mode. Invoking this option will also consume additional resources on the MCU.
conferenceChairpersonTerminationboolean Conferences based on this template will terminate when the chairperson leaves the conference, if and only if the chairperson is required.
customContentRateRateType For use with H239 settings, custom content line rates can be applied to a conference.
contentResolutionContentResolution For H239 protocols of H264 and H264 SVC/Cascade, H239 content resolution can be configured.
multipleResolutionboolean Select this option to enable transcoding of H.239 content for a conference.
contentTranscodingH263boolean Transcoding of H263 content; this is enabled by selection of multiple-resolution.
contentTranscodingH264boolean Transcoding of H264 content; this is enabled by selection of multiple-resolution.
h264CascadeOptimizedboolean Transcoding of H264 content optimized for cascade scenarios; this is enabled by selection of multiple-resolution.
highProfileContentboolean The selection of base- vs high-profile content.
avMcuCascadeModeAvMcuCascadeMode
speakerUpdateIntervalSpeakerUpdateInterval Specifies the interval between speaker updates within conference subscriptions (available as of RMX v7.8).
chineseFontChineseFont In situations where chinese distributions employ text over video, choose you font (available as of RMX v7.8).
enableFeccboolean Provide the ability to control far-end cameras within the conference (available as of RMX v7.8).
exclusiveContentboolean The ability to share content from one source to a single, specific endpoint within the conference (available as of RMX v7.8).
muteAllButLecturerboolean Mute the audience of the lecturer within the conference (available as of RMX v7.8).
muteNoisyPartiesboolean Auto mute noisy enpdpoints within the conference (available as of RMX v8.1). This mode is not supported in the following scenarios: - MCUs with MPM+ cards. - Conference Codec Support setting of SVC/Media Relay. - HD Video Switching (VSW) set and Conference Codec Support of type MIXED.
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
ChineseFontstring
Value must be one of:
  • DEFAULT
  • HEITI
  • KAITI
  • SONGTI
  • WEIBEI
SpeakerUpdateIntervalstring
Value must be one of:
  • _AUTO
  • _150
  • _300
  • _500
AvMcuCascadeModestring
Value must be one of:
  • RESOURCE_OPTIMIZED
  • VIDEO_OPTIMIZED
  • UNKNOWN
ContentResolutionstring
Value must be one of:
  • H239_720_5FPS
  • H239_720_30FPS
  • H239_1080_15FPS
  • H239_1080_30FPS
  • H239_1080_60FPS
ConferenceModeExperiencestring
Value must be one of:
  • OPTIMIZED_FOR_MOBILE
  • OPTIMIZED_FOR_QVGA
  • OPTIMIZED_FOR_CIF
  • OPTIMIZED_FOR_VGA
  • OPTIMIZED_FOR_SD
  • OPTIMIZED_FOR_HD
  • OPTIMIZED_FOR_LINE_RATE
ConferenceCodecSupportstring
Value must be one of:
  • AVC
  • SVC
  • MIXED
  • POLY_SVC
  • AVC_POLY_SVC
EncryptionPolicystring
Value must be one of:
  • ENCRYPTED_ONLY
  • UNENCRYPTED_ONLY
  • ENCRYPTED_PREFERRED
TipCompatibilitystring
Value must be one of:
  • NONE
  • VIDEO
  • VIDEO_AND_CONTENT
  • PREFER_TIP
GatheringLanguagestring
Value must be one of:
  • ENGLISH
  • GERMAN
  • SPANISH_SOUTH_AMERICA
  • FRENCH
  • JAPANESE
  • KOREAN
  • CHINESE_SIMPLIFIED
ResolutionLimitstring
Value must be one of:
  • AUTO
  • CIF
  • SD
  • HD_720
  • HD_1080
CodianAllowMuteAudiostring
Value must be one of:
  • DISABLED
  • ENABLED
CodianTransmittedContentResolutionstring
Value must be one of:
  • STD_SCREEN_ONLY
  • WIDESCREEN_ONLY
  • ALL_RESOLUTIONS
CodianMuteDtmfstring
Value must be one of:
  • WHEN_USED_FOR_MCU_CONTROL
  • ALWAYS
  • NEVER
CodianLectureModestring
Value must be one of:
  • DISABLED
  • IMMEDIATE
  • AFTER_10_SECONDS
  • AFTER_30_SECONDS
  • AFTER_60_SECONDS
CodianLayoutstring
Value must be one of:
  • LAYOUT01
  • LAYOUT02
  • LAYOUT03
  • LAYOUT04
  • LAYOUT05
  • LAYOUT06
  • LAYOUT07
  • LAYOUT08
  • LAYOUT09
  • LAYOUT10
  • LAYOUT11
  • LAYOUT12
  • LAYOUT13
  • LAYOUT14
  • LAYOUT15
  • LAYOUT16
  • LAYOUT17
  • LAYOUT18
  • LAYOUT19
  • LAYOUT20
  • LAYOUT21
  • LAYOUT22
  • LAYOUT23
  • LAYOUT24
  • LAYOUT25
  • LAYOUT26
  • LAYOUT27
  • LAYOUT28
  • LAYOUT29
  • LAYOUT30
  • LAYOUT31
  • LAYOUT32
  • LAYOUT33
  • LAYOUT34
  • LAYOUT35
  • LAYOUT36
  • LAYOUT37
  • LAYOUT38
  • LAYOUT39
  • LAYOUT40
  • LAYOUT41
  • LAYOUT42
  • LAYOUT43
  • LAYOUT44
  • LAYOUT45
  • LAYOUT46
  • LAYOUT47
  • LAYOUT48
  • LAYOUT49
  • LAYOUT50
  • LAYOUT51
  • LAYOUT52
  • LAYOUT53
  • LAYOUT54
  • LAYOUT55
  • LAYOUT56
  • LAYOUT57
  • LAYOUT58
  • LAYOUT59
CodianCustomLayoutAllowedstring
Value must be one of:
  • DISABLED
  • ENABLED
ContentChannelVideostring
Value must be one of:
  • DISABLED
  • ENABLED
LayoutControlstring
Value must be one of:
  • DISABLED
  • FECC_ONLY
  • ENABLED
FloorAndChairControlstring
Value must be one of:
  • DO_NOT_ALLOW
  • FLOOR_ONLY
  • FLOOR_AND_CHAIR
RecordingTypestring
Value must be one of:
  • DISABLED
  • IMMEDIATELY
  • UPON_REQUEST
Skinstring
Value must be one of:
  • CLEAN_SLATE
  • SIMPLY_BLUE
  • SAPPHIRE_JEWEL
  • LOOPY
Layoutstring
Value must be one of:
  • L1x1
  • L1x2
  • L2x1
  • L2x2
  • L1and5
  • L3x3
  • L1x2Ver
  • L1x2Hor
  • L1and2Hor
  • L1and2Ver
  • L1and3Hor
  • L1and3Ver
  • L1and4Ver
  • L1and4Hor
  • L1and8Central
  • L1and8Upper
  • L1and2HorUpper
  • L1and3HorUpper
  • L1and4HorUpper
  • L1and8Lower
  • L1and7
  • L4x4
  • L2and8
  • L1and12
  • L1x1Qcif
  • L1x2Flex
  • L1and2HorRFlex
  • L1and2HorLFlex
  • L1and2HorUpperRFlex
  • L1and2HorUpperLFlex
  • L2x2UpperRFlex
  • L2x2UpperLFlex
  • L2x2DownRFlex
  • L2x2DownLFlex
  • L2x2RFlex
  • L2x2LFlex
  • L1and1Overlay
  • L1and2Overlay
  • L1and3Overlay
  • L1and2OverlayITP
  • L1and3OverlayITP
  • L1and4OverlayITP
  • L4x5
  • L5x5
  • Unknown
TelepresenceLayoutModestring
Value must be one of:
  • MANUAL
  • CP
  • ROOM_SWITCH
  • SPEAKER_PRIORITY
  • PARTICIPANTS_PRIORITY
  • CP_AUTO
TelepresenceModestring
Value must be one of:
  • AUTO
  • YES
  • NO
ParticipantsJoinTypestring
Value must be one of:
  • MUTE
  • UNMUTE
VideoQualitystring
Value must be one of:
  • MOTION
  • SHARPNESS
HdResolutionstring
Value must be one of:
  • HD_720
  • HD_1080
  • HD_1080P60
  • SD
  • H261CIF
  • H263CIF
  • H264CIF
  • HD_720P60
  • HD_720_P_30
H239Protocolstring
Value must be one of:
  • H263
  • UP_TO_H264
  • H_264_FIX
  • H_264_DYNAMIC
H239Settingsstring
Value must be one of:
  • GRAPHICS
  • HIRESGRAPHICS
  • LIVEVIDEO
  • CUSTOMIZEDCONTENTRATE
Descriptionstring
Length of value must be >=0
Length of value must be <=50
Namestring
Length of value must be >=1
Length of value must be <=50