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.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | Array of Link | See Definition of Link | |
| plcmSimulcastStreamList | Array of PlcmSimulcastStream | See Definition of PlcmSimulcastStream | |
| plcmLineRate | PlcmLineRate | See Definition of PlcmLineRate | |
| conferenceTemplateIdentifier | string | Internal identifier. Provided to protect against a name update. | |
| name | Name | A meaningful name for the template (up to 50 characters). | Mandatory |
| description | Description | A brief description of the conference template (up to 50 characters). | |
| priority | int | If a user is associated with multiple conference templates, this priority will take effect. Read-only. | |
| rmxProfile | string | Identifies the RMX profile to which this template is linked. | |
| useProfile | boolean | If true, links this template to the RMX profile identified by the rmx-profile field. | |
| encryption | boolean | Specifies that media encryption should be required for conferences using this template. | |
| lostPacketRecovery | boolean | 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. | |
| h239Settings | H239Settings | 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. | |
| h239Protocol | H239Protocol | Content channel protocol options: - Use H.264 if available, otherwise use H.263. - Always use H.263. | |
| highDefinitionVideoSwitching | boolean | 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. | |
| highProfileVsw | boolean | 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. | |
| hdResolution | HdResolution | Available only if Video switching is selected. | |
| videoQuality | VideoQuality | Offers two video optimizations: - Motion: higher frame rate - Sharpness: higher resolution | |
| participantsJoinType | ParticipantsJoinType | ||
| telepresenceMode | TelepresenceMode | 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. | |
| telepresenceLayoutMode | TelepresenceLayoutMode | 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. | |
| presentationMode | boolean | 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. | |
| lecturerViewSwitching | boolean | 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. | |
| sameLayout | boolean | 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. | |
| autoLayout | boolean | 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. | |
| layout | Layout | The number and arrangement of video frames. Not available if video-switching is selected. | |
| skin | Skin | Lets you choose the display appearance (skin) for conferences using this template. Not available if Telepresence mode is Yes. or Video switching is enabled. | |
| conferenceIvrService | string | 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. | |
| conferenceRequiresChairperson | boolean | 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. | |
| videoClarity | boolean | 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. | |
| audioClarity | boolean | Improves the voice quality in conference of a PSTN endpoint. Available only on RMX v7 MCUs. | |
| useCascading | boolean | 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. | |
| echoSuppression | boolean | Enables the MCU to detect and suppress echo. Available only on MCUs with MPM+ or MPMx cards. | |
| keyboardSuppression | boolean | Enables the MCU to detect and suppress keyboard noise. Available only on MCUs with MPM+ or MPMx cards. | |
| sendContentToLegacyEndpoints | boolean | 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. | |
| recordingType | RecordingType | 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. | |
| audioOnlyRecording | boolean | Limits recording to the audio channel of the conference. | |
| enableRecordingIndication | boolean | Displays a red dot recording indicator in the upper left corner of the video layout. Available only on RMX v7.1 MCUs. | |
| floorAndChairControl | FloorAndChairControl | 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. | |
| layoutControl | LayoutControl | 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. | |
| contentChannelVideo | ContentChannelVideo | Enables the conference to support a second video stream for content. This setting works only if Content Status is enabled on the MCU. | |
| codianCustomLayoutAllowed | CodianCustomLayoutAllowed | ||
| codianLayout | CodianLayout | ||
| codianLectureMode | CodianLectureMode | 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. | |
| codianMuteDtmf | CodianMuteDtmf | 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. | |
| codianTransmittedContentResolution | CodianTransmittedContentResolution | 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. | |
| codianAllowMuteAudio | CodianAllowMuteAudio | Enables conference participants to mute themselves using the *6 touchtone command. Available only on Codian v4.1 MCUs. | |
| recordingLink | string | 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. | |
| resolutionLimit | ResolutionLimit | 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. | |
| autoBrightness | boolean | Enables automatic balancing of brightness levels to compensate for an endpoint sending a dim image. Available only on RMX v7 MCUs. | |
| enableGathering | boolean | 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. | |
| gatheringLanguage | GatheringLanguage | Language in which the gathering page is displayed. | |
| gatheringAccessNumber1 | string | Optional access numbers to display on the gathering phase slide. | |
| gatheringAccessNumber2 | string | Optional access numbers to display on the gathering phase slide. | |
| gatheringInfo1 | string | 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. | |
| gatheringInfo2 | string | 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. | |
| gatheringInfo3 | string | 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. | |
| tipCompatibility | TipCompatibility | ||
| encryptionPolicy | EncryptionPolicy | ||
| conferenceCodecSupport | ConferenceCodecSupport | Specifies conference mode. | |
| cascadingForSize | boolean | Enables cascading of MCUs for large conferences. This attribute is mutually exclusive with use-cascading. | |
| fwNatKeepalive | boolean | 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. | |
| fwNatKeepaliveInterval | string | Interval at which firewall NAT keepalive messages are sent. Max 86400, min 5, default 30. | |
| audioOnlyConference | boolean | 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. | |
| conferenceModeExperience | ConferenceModeExperience | 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. | |
| asSipContent | boolean | 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. | |
| conferenceChairpersonTermination | boolean | Conferences based on this template will terminate when the chairperson leaves the conference, if and only if the chairperson is required. | |
| customContentRate | RateType | For use with H239 settings, custom content line rates can be applied to a conference. | |
| contentResolution | ContentResolution | For H239 protocols of H264 and H264 SVC/Cascade, H239 content resolution can be configured. | |
| multipleResolution | boolean | Select this option to enable transcoding of H.239 content for a conference. | |
| contentTranscodingH263 | boolean | Transcoding of H263 content; this is enabled by selection of multiple-resolution. | |
| contentTranscodingH264 | boolean | Transcoding of H264 content; this is enabled by selection of multiple-resolution. | |
| h264CascadeOptimized | boolean | Transcoding of H264 content optimized for cascade scenarios; this is enabled by selection of multiple-resolution. | |
| highProfileContent | boolean | The selection of base- vs high-profile content. | |
| avMcuCascadeMode | AvMcuCascadeMode | ||
| speakerUpdateInterval | SpeakerUpdateInterval | Specifies the interval between speaker updates within conference subscriptions (available as of RMX v7.8). | |
| chineseFont | ChineseFont | In situations where chinese distributions employ text over video, choose you font (available as of RMX v7.8). | |
| enableFecc | boolean | Provide the ability to control far-end cameras within the conference (available as of RMX v7.8). | |
| exclusiveContent | boolean | The ability to share content from one source to a single, specific endpoint within the conference (available as of RMX v7.8). | |
| muteAllButLecturer | boolean | Mute the audience of the lecturer within the conference (available as of RMX v7.8). | |
| muteNoisyParties | boolean | 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. | |
| entityTag | EntityTag | 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. |
| Name | Type | Restrictions |
|---|---|---|
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| ChineseFont | string | Value must be one of:
|
| SpeakerUpdateInterval | string | Value must be one of:
|
| AvMcuCascadeMode | string | Value must be one of:
|
| ContentResolution | string | Value must be one of:
|
| ConferenceModeExperience | string | Value must be one of:
|
| ConferenceCodecSupport | string | Value must be one of:
|
| EncryptionPolicy | string | Value must be one of:
|
| TipCompatibility | string | Value must be one of:
|
| GatheringLanguage | string | Value must be one of:
|
| ResolutionLimit | string | Value must be one of:
|
| CodianAllowMuteAudio | string | Value must be one of:
|
| CodianTransmittedContentResolution | string | Value must be one of:
|
| CodianMuteDtmf | string | Value must be one of:
|
| CodianLectureMode | string | Value must be one of:
|
| CodianLayout | string | Value must be one of:
|
| CodianCustomLayoutAllowed | string | Value must be one of:
|
| ContentChannelVideo | string | Value must be one of:
|
| LayoutControl | string | Value must be one of:
|
| FloorAndChairControl | string | Value must be one of:
|
| RecordingType | string | Value must be one of:
|
| Skin | string | Value must be one of:
|
| Layout | string | Value must be one of:
|
| TelepresenceLayoutMode | string | Value must be one of:
|
| TelepresenceMode | string | Value must be one of:
|
| ParticipantsJoinType | string | Value must be one of:
|
| VideoQuality | string | Value must be one of:
|
| HdResolution | string | Value must be one of:
|
| H239Protocol | string | Value must be one of:
|
| H239Settings | string | Value must be one of:
|
| Description | string | Length of value must be >=0 Length of value must be <=50 |
| Name | string | Length of value must be >=1 Length of value must be <=50 |