Yamaha CS-700 Integrators Reference Guide
20
The table below describes the command syntax.
<parameter>
Items in angle brackets are parameters
<"call-status">
A quoted item represents the name of a parameter further described
in the Parameters section.
<0|1|2>
A list of possible values are separated by vertical bars.
<connected|disconnected>
An unquoted parameter is a literal value.
<0..10>
A range of values is separated by an ellipsis.
<"paired"> [<"mac"> <"name">]
Square brackets designate optional parameters.
[<"mac"> <"name">]+
A list of repeating values is designated by a plus sign.
For properties, the description lists the actions that can be performed on the property, including:
get – property can be read; this is true of all properties
set – property can be set
notify – when the property changes, a notification is sent to registered clients
The Command Definition and Parameters tables describe each supported action and associated parameters and
values.
5.2
Categories
The API is organized by these Categories:
•
System (sys)
•
Audio
•
Camera
•
Bluetooth (bt)
•
Bluetooth Low Energy (ble)
•
Call
•
Network (net)
•
VoIP
The sections below describe the interfaces supported in each category.
Changes to properties in the Network group must be applied by the net-commit command. See Appendix B –
Crestron Integration TCP/IP for re-registration sequence with the SIP server.
Changes to properties in the VoIP group must be applied by the voip-commit command. See Appendix B –
Crestron Integration TCP/IP for re-registration sequence with the SIP server.
5.2.1
System
5.2.1.1
System Properties
product
Description:
Product name. Read-only set at manufacturing.
Property Actions:
get