Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 296
conference.metadata.modify
Conferences may hold up to 4095 characters of unicode metadata, which are set or cleared with this call.
There is a limit to the number of conferences which can hold metadata. This limit is defined by half the
maximum port capacity of the MCU, which varies by media port mode.
The call will return an error if this limit is reached.
For example, an MCU MSE 8510 in SD mode has a maximum port capacity of 80, irrespective of the number
of licenses. In this case, up to 40 conferences may hold metadata.
If the call is successful, the device overwrites existing metadata (if any) with the value of metadata. Send
an empty string to clear the metadata. If you omit the metadata parameter, the device does not modify the
existing metadata, but still returns a success message.
Note: The metadata stored against a conference may have been set by an integrated system such as the
Cisco TelePresence Conductor. Do not modify metadata that is required by other parts of your wider
solution.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
Optional or conditional inputs
Parameter name
Type
Short description
metadata
string
(4095)
A string of up to 4095 unicode characters stored on the
device and associated with the named conference.
Returned data
Parameter name
Type
Short description
status (success)
string
Operation successful
Cisco TelePresence MCU API 2.10
Page 55 of 296
API commands
conference.metadata.modify