LogoLogo
RealityHub 1.3
RealityHub 1.3
  • RealityHub 1.3
    • What's New
      • Hotfix Version 1.3.1
      • Hotfix Version 1.3.2
      • Hotfix Version 1.3.3
      • Hotfix Version 1.3.4
    • What is RealityHub?
      • System Overview
    • Launcher
      • Launcher Interface
      • Engine Status Colors
      • Engine Display Window
      • New Launch Configuration
    • Nodegraph/Actions
      • Nodegraph
        • Node Structure
        • RGraph
        • Operating Nodegraph
        • Advanced Preview Monitor
          • Operating Advanced Preview Monitor
        • RGraph Templates
          • Tutorial RGraphs
        • Asset Browser
      • Properties and Functions
      • Actions
        • Action Timeline Interface
        • Keyframe Types
        • Interpolations
        • Operating Actions
        • Animation Workflow Tips
        • Utilizing Initial Keyframe
        • Triggering Multiple Actions via Single Button
      • Form Builder
        • Form Builder Interface
        • Form Builder Components
        • Customizing Component Appearance
        • Operating Form Builder
        • Data Integration
      • Gang Mode
        • Activating Gang Mode
        • Operating Gang Mode
    • Playout
      • Operating Playout
    • Newsroom
    • Cook Manager
    • Controlling Unreal Engine
      • Unreal Engine 5.0
        • Available Features
        • UState
          • UState User Interface
          • Advanced Preview Monitor for Unreal Engine
          • Operating UState
        • Configuration
          • Unreal Engine Configuration
          • RealityHub Configuration for Unreal Engine
      • Unreal Engine 5.1
        • Controlling Unreal Engine 5.1
        • Supported Versions
        • Available Features
        • UState
          • UState User Interface
          • APM for Unreal Engine 5.1
        • Configuration
          • Unreal Engine 5.1 Configuration
          • RealityHub Configuration for Unreal Engine 5.1
        • Example Pipeline
          • Preparation
          • Exposing Actor Functions
          • Exposing Actor Parameters
          • Grouping Exposed Items
          • Creating Logic
          • Viewport Navigation
          • Unreal Project inside RealityHub
          • Utilizing Media Framework Tools
          • Operating
    • User Management
      • Advanced User Management
        • User Management UI
        • Role of the Admin and Administrators
        • Example Configuration
        • License Reservation
      • Basic User Management
    • Installation and Configuration
      • System Requirements
      • Downloading Distributions
      • Installation
      • Upgrading and Downgrading
      • Database Backup and Restore
      • Page
      • Licensing
      • Configuration Steps
        • General Configuration
        • Reality Loader
          • RealityEngine AMPERE Led Display
        • Engine Module Configuration
          • Adding Host
          • Adding Groups
          • Channel Assignments
          • General Engine Configuration
        • Project Configuration
        • Project Scanning
        • Cache Management
        • CII Module Configuration
        • SSL Configuration
      • Recap
    • Integrations
      • Octopus Integration
        • RealityHub MOS Configuration for Octopus
        • Octopus Configuration
        • Utilizing ZD MOS Plugin
      • iNEWS Integration
        • RealityHub MOS Configuration for iNEWS
        • iNEWS Configuration
    • Developers Guide
      • RealityHub Open-Source SDK
      • REST API
    • Frequently Asked Questions
    • Glossary
    • How to Read this Documentation
Powered by GitBook
LogoLogo

© 2023 Zero Density. All rights reserved.

On this page
  • Configuration Details
  • Calling Rundown Items
  • Assigning Conditions
  1. RealityHub 1.3
  2. Installation and Configuration
  3. Configuration Steps

CII Module Configuration

PreviousCache ManagementNextSSL Configuration

Last updated 2 years ago

RealityHub seamlessly integrates to your broadcast automation devices through the CII, and this integration allows you to conduct Playout triggering/updating operations.

The main idea is to get Playout Rundown items through the REST API and assign them to the broadcast automation devices via the CII.

Please remember that; you can only use RealityHub CII Module for Playout operations along with the REST API.

To reach CII Configuration:

  • Click on the Main Menu

  • Select the Configuration

  • Go to the Configuration sidebar

  • Select the CII Server under the Integration

Configuration Details

  • The default port for CII on the RealityHub is 1235.

  • To establish communication, you must provide the same port for CII and RealityHub.

Calling Rundown Items

The example in the image above shows that we have one Form Template, three Buttons, and the following variables: Reality String, Reality Boolean, and Reality Integer in the Playout module. This setup is created via the Form Builder module.

{
  "$jxdVersion": "1.0.0",
  "button_0": "",
  "button_1": "",
  "button_2": "",
  "realitystring_0": "400",
  "realityboolean_0": true,
  "realitynumber_0": 230.4,
  "$uiSchema": [
    [
      {
        "$$dataType": "button",
        "$$key": "button_2",
        "$$value": "",
        "$$formCell": {},
        "$$actionId": "6658fbbb-3dae-4bc3-8a1e-14c0746e7ac7",
        "$$propertyType": "Function",
        "align": "Center",
        "showBindingInfo": true,
        "label": "Cam 1",
        "showInRundown": false,
        "sendJXD": false,
        "fontSize": 14,
        "size": {
          "X": 130,
          "Y": 40
        },
        "cornerRoundness": 2,
        "textColor": {
          "X": 1,
          "Y": 1,
          "Z": 1
        },
        "backgroundColor": {
          "X": 0.23137254901960785,
          "Y": 0.7098039215686275,
          "Z": 0.40784313725490196
        }
      },
      {
        "$$dataType": "button",
        "$$key": "button_1",
        "$$value": "",
        "$$formCell": {},
        "$$actionId": "23eb2600-8e30-4034-8c97-c2a34a588ecd",
        "$$propertyType": "Function",
        "align": "Center",
        "showBindingInfo": true,
        "label": "Cam 2",
        "showInRundown": false,
        "sendJXD": false,
        "fontSize": 14,
        "size": {
          "X": 130,
          "Y": 40
        },
        "cornerRoundness": 2,
        "textColor": {
          "X": 1,
          "Y": 1,
          "Z": 1
        },
        "backgroundColor": {
          "X": 0.41568627450980394,
          "Y": 0.29411764705882354,
          "Z": 0.47843137254901963
        }
      },
      {
        "$$dataType": "button",
        "$$key": "button_0",
        "$$value": "",
        "$$formCell": {},
        "$$actionId": "045fd2f3-c88c-4440-a107-577d2d0866cf",
        "$$propertyType": "Function",
        "align": "Center",
        "showBindingInfo": true,
        "label": "Cam 3",
        "showInRundown": false,
        "sendJXD": false,
        "fontSize": 14,
        "size": {
          "X": 130,
          "Y": 40
        },
        "cornerRoundness": 2,
        "textColor": {
          "X": 1,
          "Y": 1,
          "Z": 1
        },
        "backgroundColor": {
          "X": 0.6,
          "Y": 0.06666666666666667,
          "Z": 0
        }
      }
    ],
    [
      {
        "$$dataType": "realitynumber",
        "$$key": "realitynumber_0",
        "$$value": 230.4,
        "$$formCell": {},
        "title": "",
        "$$propertyType": "Float",
        "align": "Center",
        "realtimeUpdate": false,
        "showBindingInfo": true
      },
      {
        "$$dataType": "realityboolean",
        "$$key": "realityboolean_0",
        "$$value": true,
        "$$formCell": {},
        "$$propertyType": "Boolean",
        "align": "Center",
        "realtimeUpdate": false,
        "showBindingInfo": true,
        "showLabel": true,
        "label": "Checkbox"
      },
      {
        "$$dataType": "realitystring",
        "$$key": "realitystring_0",
        "$$value": "400",
        "$$formCell": {},
        "title": "",
        "$$propertyType": "String",
        "align": "Center",
        "realtimeUpdate": false,
        "showBindingInfo": true
      }
    ]
  ],
  "$$channels": [
    "(all)"
  ]
}

We utilize the GET method to list Rundown Items via the following link: http://localhost/api/rest/v1/playout/rundowns/1/items. The code snippet above shows that every defined Rundown Items are now ready to assign to your broadcast automation device through the CII.

Assigning Conditions

  • A Button must be assigned with its ID Number. In our case, if you want to assign the Cam Center button, you must use “b166ab50-9bc1-4eea-9a16-473425d8124a“ as shown inside the code snippet above.

  • A Boolean & Text/String must be assigned with its Key Name. In our case, key names must be the following:

    • Reality String is equal to “realitystring1”

    • Reality Boolean is equal to “realityboolean1“

    • Reality Integer is equal to “realityinteger1“

Key Name can be found in the Field Settings of the Component, as shown in the images above.

CII Server in Configuration Module
Playout Form Template