Dos And Don'ts - Cisco Codec C20 Reference Manual

Cisco TelePresence System Codec C20
Contents Introduction

Dos and don'ts

Here are some issues you should consider when programming
the Cisco C- and SX-series API.
AVOID remote control emulation
The use of xCommand Key Press and xCommand Key Click
commands is highly discouraged. The commands are still avail-
able in the API, but we recommend the use of direct commands,
as this ensures backwards compatibility in your integrations.
Program against the codec, not the on-screen-display.
DO use complete commands
You should always use complete commands when program-
ming, i.e. always use xConfiguration Video instead of xconf
vid. The shortcuts can be used for searches in the API on the
command line, but not for programming. The reason for this is
that you might end up with ambiguous code when additional
commands are added to the API.
DO NOT subscribe to unnecessary feedback
Subscribing to too much feedback may congest the control
application. Although the amount of feedback may seem fine
in the current version, the amount of feedback may grow in
future releases.
DO present one screen to the end user
Avoid making the user look at two menus, one on the control
panel and one on the video screen. Do not make the control
panel a substitute for the remote control. The on-screen-display
in is using the exact same API as you have access to through
the command interface.
Codec C20 API Reference Guide TC6.0 February 2013.
D14869.05
About the API About the API xConfiguration
DO NOT use the experimental section in production
Under the listing of commands, status and configurations, you
can find subsections that start with Experimental.
• xCommand Experimental
• xStatus Experimental
• xConfiguration Experimental
These sections give access to features that we are still work-
ing on and have yet to release for official use. This part of the
API will NOT stay backwards compatible and the structure
WILL CHANGE.
Do not use the experimental section in production - in future
versions of the firmware these sections may be hidden or removed.
24
xCommand xStatus
Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices