Dos And Don'ts - Cisco TelePresence SX10 Reference Manual

Cisco TelePresence SX10

Introduction

Dos and don'ts

Here are some best practices when programming the Cisco
SX series API.
AVOID remote control emulation
The use of xCommand UserInterface OSD Key Click and
xCommand UserInterface OSD Key Press commands is highly
discouraged. The commands are still available 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.
Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016.
D15333.07
About the API About the API xConfiguration xCommand
42
API Reference Guide
xStatus Appendices
Copyright © 2016 Cisco Systems, Inc. All rights reserved.