Notifications About The Changes Of The Properties; Formal Definitions - Lightware HDMI20-OPTC-TX220-Pro User Manual


  
6. LW3 Programmers' Reference
Get the active subscriptions for the current connection
Command format: OPEN
Response format: o-●[nodePath]
Example:
˃ OPEN
˂ o- /MEDIA/VIDEO/XP
˂ os /MEDIA/VIDEO/I1
˂ os /MEDIA/VIDEO/I2
˂ o- /MEDIA/VIDEO
˂ os /REMOTE/D1
˂ o- /MANAGEMENT/UID
˂ o- /
Unsubscribe from a node
Command format: CLOSE●[nodePath]
Response format: c-●[nodePath]
Example:
˃ CLOSE /MEDIA/VIDEO
˂ c- /MEDIA/VIDEO
Unsubscribe from multiple nodes
Command format: CLOSE●[nodePath]/*
Response format: c-●[nodePath]/*
Example:
˃ CLOSE /MEDIA/VIDEO/*
˂ c- /MEDIA/VIDEO/*
6.3.7. Notifications about the Changes of the Properties
When the value of a property is changed and the user is subscribed to the node, which the property belongs
to, an asynchronous notification is generated. This is notification is called as the 'change message'. The
format of such a message is very similar to the response for the 'GET' command.
Format: CHG●[nodePath].[propertyName]=[newPropertyValue]
Example:
˂ CHG /MEDIA/VIDEO/O1.ForcedSignalType=HDMI
HDMI20-OPTC series – User's Manual
A short example of how to use the subscription
In the following, an example is presented, how the subscriptions are working and how to use them. In the
example, there are two independent users controlling the device through two independent connections
('Connection #1' and 'Connection #2'). The events in the rows occur after each other.
˃ OPEN /MEDIA/VIDEO/XP
˂ o- /MEDIA/VIDEO/XP
Conn. #1
˃ GET /MEDIA/VIDEO/XP.DestinationConnectionList
˂ pr /MEDIA/VIDEO/XP.DestinationConnectionList=I1;I1
˃ GET /MEDIA/VIDEO/XP.DestinationConnectionList
˂ pr /MEDIA/VIDEO/XP.DestinationConnectionList=I1;I1
Conn. #2
˃ CALL /MEDIA/VIDEO/XP:switch(I2:O1)
˂ mO /MEDIA/VIDEO/XP:switch
Conn. #1 ˂ CHG /MEDIA/VIDEO/XP.DestinationConnectionList=I2;I2
Explanation: The first user (Connection #1) set a subscription to a node. Later the other user (Connection
#2) made a change, and thanks for the subscription, the first user got a notification about the change.
6.4. Formal Definitions
Method parameters and property values are specified in a modified version of Backus-Naur Form (BNF). The
syntax is the following:
"literal"
<expression1>|<expression2>
[<expression>]
<number>*[<expression>]
*[<expression>]
<number>*{<expression>}
literals are quoted
vertical bars denote alternatives
expressions in square brackets are optional
expression is repeated at least <number> times
<number> may be omitted, in this case number defaults to 0
expressions in curly brackets are repeated exactly <number>
times
In
Input port number
Om
Output port number
43