Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 118 of 223
template.delete
Deletes a template with the provided
templateName or templateNumber parameter. You may only pass one
reference.
You can't delete the top level or ad hoc templates. The call will return an error if it can't find the template or if
you pass an invalid reference (see
).
Input parameters
Required inputs
The call requires one of the following template identifier parameters.
Parameter name
Type
Short description
templateName
string
The name of the template. When passed in a call, this
parameter identifies the template that is used for the
purpose of the call.
templateNumber
integer
An index that uniquely identifies the template. Template
numbers are not preserved when the MCU reboots.
template.enumerate
The template.enumerate function returns an array of template structures, each of which contains the settings
of the template (see
). The call does not take any parameters.
template.modify
This call modifies the settings for conference templates. The settings you modify will be applied to any
conferences based on the modified template. If you pass the
default value for a parameter, the template will
inherit its parent template’s setting for that parameter.
This call returns an error if both
maximumVideoPorts and maximumAudioPorts are set to or if the total
number of ports exceeds the maximum conference size (currently 80).
Input parameters
Optional or conditional inputs
Parameter name
Type
Short description
templateNumber
integer
An index that uniquely identifies the template. Template
numbers are not preserved when the MCU reboots.
newTemplateName
string
Use this parameter to change the name of the template.
The call will return an error if another template exists that
has this name.
parent
string
The name of the parent template. Defaults to Top Level
template if omitted.