Grass-valley K2 Edge Protocol Manual v1.0 User Manual

K2 Edge Protocol Manual Document version: 1.0 - 8-3-2012

K2 Edge Protocol Manual – document version 1.0 – Page 10 4. API NRE Command 4.1. Introduction The K2 Edge API NRE command allows remote control ove

K2 Edge Protocol Manual – document version 1.0 – Page 11 4.3. The exid field The exid field in the command string is a mandatory field. This field i

K2 Edge Protocol Manual – document version 1.0 – Page 12 4.5. The role field The NRE command supports the concept of initiator roles, where differen

K2 Edge Protocol Manual – document version 1.0 – Page 13 4.6. Scene parameters Some sub commands accept scene parameters, plug-in values similar to

K2 Edge Protocol Manual – document version 1.0 – Page 14 4.8. Sub command preload-play Function: preloads a template instance and automatically star

K2 Edge Protocol Manual – document version 1.0 – Page 15 4.9. Sub command preload Function: prepares a template for playback. field name field type

K2 Edge Protocol Manual – document version 1.0 – Page 16 4.10. Sub command play Function: starts playback of a template. field name field type valu

K2 Edge Protocol Manual – document version 1.0 – Page 17 4.11. Sub command sg-preload Function: prepares a scene graph for selection by loading it

K2 Edge Protocol Manual – document version 1.0 – Page 18 4.12. Sub command sg-select Function: selects a previously preloaded scene graph waiting in

K2 Edge Protocol Manual – document version 1.0 – Page 19 4.13. Sub command object-info Function: returns information via feedback on an NRE object (

K2 Edge Protocol Manual – document version 1.0 – Page 2 Table of Contents 1. Grass Valley Product Support ...

K2 Edge Protocol Manual – document version 1.0 – Page 20 4.14. Sub command sp-print Function: prints the values of all scene parameters to the stand

K2 Edge Protocol Manual – document version 1.0 – Page 21 5. K2 Edge API NRE Feedback 5.1. Introduction The K2 Edge API NRE commands support a dedic

K2 Edge Protocol Manual – document version 1.0 – Page 22 During this life cycle the template instance passes a number of well-defined points such as

K2 Edge Protocol Manual – document version 1.0 – Page 23 5.6. Feedback levels Three feedback levels can be defined: level description basic The def

K2 Edge Protocol Manual – document version 1.0 – Page 24 5.8. What is returned Feedback messages are a copy of the original NRE command, enriched wi

K2 Edge Protocol Manual – document version 1.0 – Page 25 5.9. Sub command preload-play The preload-play command combines the individual preload and

K2 Edge Protocol Manual – document version 1.0 – Page 26 5.9.2. Feedback level 'basic' Coverage from the reception point up to and includ

K2 Edge Protocol Manual – document version 1.0 – Page 27 Note the presence and value of fb-term-sw in the last message, indicating feedback ends for

K2 Edge Protocol Manual – document version 1.0 – Page 28 Example: This example of a preload-play command sent to nexos uses feedback level 'mos

K2 Edge Protocol Manual – document version 1.0 – Page 29 5.9.4. Feedback level 'full' Coverage from the reception point up to and includi

K2 Edge Protocol Manual – document version 1.0 – Page 3 5.5. Life cycle points and events ...

K2 Edge Protocol Manual – document version 1.0 – Page 30 The feedback messages from nexos are listed. This time we show a failure path, note (8) in t

K2 Edge Protocol Manual – document version 1.0 – Page 31 5.10. Sub command preload Sub command preload prepares a template instance for a later play

K2 Edge Protocol Manual – document version 1.0 – Page 32 5.10.3. Feedback levels 'most' and 'full' Coverage from the reception

K2 Edge Protocol Manual – document version 1.0 – Page 33 5.11. Sub command play Sub command play starts a template instance at the start time, provi

K2 Edge Protocol Manual – document version 1.0 – Page 34 Notes: 1) The command is considered valid at the reception point and the command started s

K2 Edge Protocol Manual – document version 1.0 – Page 35 5.11.4. Feedback level 'full' Coverage is complete from reception point up to a

K2 Edge Protocol Manual – document version 1.0 – Page 36 5.12. Sub command object-info Sub command object-info returns info on a given NRE object vi

K2 Edge Protocol Manual – document version 1.0 – Page 37 Notes: 1) 1) The command is considered valid at the reception point and the command comple

K2 Edge Protocol Manual – document version 1.0 – Page 38 6. K2 Edge API Source String Format 6.1. Introduction The source string format defines an

K2 Edge Protocol Manual – document version 1.0 – Page 39 where the files are scanned in the order specified. Note that non-audio streams are ignored.

K2 Edge Protocol Manual – document version 1.0 – Page 4 7.4.1. Channel Director option ...

K2 Edge Protocol Manual – document version 1.0 – Page 40 6.3. Supported fields A complex source string is limited to a set of well-defined field/val

K2 Edge Protocol Manual – document version 1.0 – Page 41 6.3.2. Routing table fields The following fields set up the routing table, where video- or

K2 Edge Protocol Manual – document version 1.0 – Page 42 6.3.3. Timecode range fields The following timecode range fields allow the initiator to pl

K2 Edge Protocol Manual – document version 1.0 – Page 43 6.3.4. Relative timecode range fields Similar to the timecode range fields above, but this

K2 Edge Protocol Manual – document version 1.0 – Page 44 6.3.5. Absolute timecode range fields for MXF files Similar to the timecode range fields ab

K2 Edge Protocol Manual – document version 1.0 – Page 45 fileN-atc-end optional hh:mm:ss:ff timecode string in timecode format of media file Similar

K2 Edge Protocol Manual – document version 1.0 – Page 46 fileN-lipsync-offset-ms optional [-10000, 10000] Specifies an explicit lipsync offset in mil

K2 Edge Protocol Manual – document version 1.0 – Page 47 7. Channel Pack Management 7.1. Introduction When designing a channel, all elements of the

K2 Edge Protocol Manual – document version 1.0 – Page 48 7.3. Channel pack workflow The workflow to bring a channel pack on-air contains the followi

K2 Edge Protocol Manual – document version 1.0 – Page 49 7.4. How to bring a Channel Pack on-air The previous section generically described the step

K2 Edge Protocol Manual – document version 1.0 – Page 5 1. Grass Valley Product Support Contact information: http://www.grassvalley.com/support/cont

K2 Edge Protocol Manual – document version 1.0 – Page 50 8. Complex String Format 8.1. Introduction A complex string is a text string defining zero

K2 Edge Protocol Manual – document version 1.0 – Page 51 8.3. Field identifier The field identifiers (or field names) consist of lower case letters,

K2 Edge Protocol Manual – document version 1.0 – Page 52 8.6. Data wrappers The complex string format allows for data to be wrapped by a number of w

K2 Edge Protocol Manual – document version 1.0 – Page 6 3. Nexos Socket Server Communication Setup 3.1. Introduction Nexos is the real-time playout

K2 Edge Protocol Manual – document version 1.0 – Page 7 3.3. Code examples This section provides a number of coding examples. Note that the example

K2 Edge Protocol Manual – document version 1.0 – Page 8 3.7. Closing the link when no longer needed Remember to close the link with the socket serve

K2 Edge Protocol Manual – document version 1.0 – Page 9 3.9. The API protocol The nexos socket server supports a number of different services, the m