Grass Valley K2 Edge Protocol Manual v1.0 - Manual (Page 5)

K2 Edge Protocol Manual – document version 1.0 – Page 5
1. Grass Valley Product Support
Contact information: http://www.grassvalley.com/support/contact
U.S Technical Support: +1 800-547-4989 or +1 530 478 4148 or E-mail: Please use our online form
All other countries Technical Support: +800 80 80 20 20 or +33 1 48 25 20 20 or E-mail:
[email protected]
FAQ: http://grassvalley.novosolutions.net/
Training: https://grassvalley.csod.com/LMS/catalog/Main.aspx?tab_page_id=-67&tab_id=6
2. Introduction
This document describes third party remote control over nexos, the integrated playout 'firmware' running
on the K2 Edge hardware frames. This document focuses on launching templates that were created with
the Channel Composer design application. The intended reader is a programmer familiar with the C
programming language and with some knowledge of networking.
Following topics are included:
• Nexos Socket Server Communication Setup
o How to create a socket link with the nexos socket server.
o How to send messages to the socket server.
o Socket server command layout.
o Short introduction to K2 Edge API commands.
• K2 Edge API NRE Command
o The NRE command is one of the K2 Edge API commands supported by nexos, and this
particular one is entirely focused on the Nexos Render Engine (NRE), the render unit
built into nexos responsible for producing the graphics created in the Channel Composer
application.
o Describes the Nexos Render Engine commands, including commands for preload and
play of templates, and preload and selection of scene graphs.
• K2 Edge API NRE Feedback
o Feedback messages are messages generated by nexos (and in this case by the NRE
unit in nexos) to deliver status reports to the initiator (you). Feedback is optional, and
must be explicitly enabled.
o Describes options for feedback generated by K2 Edge API NRE command.
• K2 Edge API Source String Format
o Describes the vstream and astream fields.
• Channel Pack Management
o Introduction to Channel Packs, a zipped folder structure containing the scene graph and
templates created in Channel Composer.
o A description of the Channel Pack workflow; how to bring a Channel Pack on-air.
• Complex String Format
o For reference only, describes the complex string format used by the K2 Edge API
commands.